io.warp10.warp.sdk

Class DirectoryPlugin

java.lang.Object

io.warp10.warp.sdk.DirectoryPlugin

Direct Known Subclasses:

TrustedDirectoryPlugin

public abstract class DirectoryPlugin
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectoryPlugin.GTS
static class	DirectoryPlugin.GTSIterator

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

Constructor Summary

Constructors

Constructor and Description
DirectoryPlugin()

Method Summary

Modifier and Type	Method and Description
abstract boolean	delete(DirectoryPlugin.GTS gts) Deletes a GTS from storage.
abstract DirectoryPlugin.GTSIterator	find(int shard, java.lang.String classSelector, java.util.Map<java.lang.String,java.lang.String> labelsSelectors) Identify matching GTS.
abstract void	init(java.util.Properties properties) Initialize the plugin.
boolean	known(DirectoryPlugin.GTS gts) Check if a given GTS is known.
abstract boolean	store(java.lang.String source, DirectoryPlugin.GTS gts) Stores a GTS.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

DirectoryPlugin

public DirectoryPlugin()

Method Detail

init

public abstract void init(java.util.Properties properties)

Initialize the plugin. This method is called immediately after a plugin has been instantiated.

Parameters:

properties - Properties from the Warp configuration file

store

public abstract boolean store(java.lang.String source,
                              DirectoryPlugin.GTS gts)

Stores a GTS. GTS to store might already exist in the storage layer. It may be pushed because the attributes have changed.

Parameters:

source - Indicates the source of the data to be stored. Will be null when initializing Directory.

gts - The GTS to store.

Returns:

true if the storing succeeded, false otherwise

delete

public abstract boolean delete(DirectoryPlugin.GTS gts)

Deletes a GTS from storage. Note that the key for the GTS is the combination name + labels, the attributes are not part of the key.

Parameters:

gts - GTS to delete

find

public abstract DirectoryPlugin.GTSIterator find(int shard,
                                                 java.lang.String classSelector,
                                                 java.util.Map<java.lang.String,java.lang.String> labelsSelectors)

Identify matching GTS.

Parameters:

shard - Shard ID for which the request is done

classSelector - Regular expression for selecting the class name.

labelsSelectors - Regular expressions for selecting the labels names.

Returns:

An iterator on the matching GTS.

known

public boolean known(DirectoryPlugin.GTS gts)

Check if a given GTS is known. This is used to avoid storing unknown GTS simply because they were part of a /meta request. Note that the default implementation returns false, this means that attribute updates will NOT be persisted. This is annoying but trust us, it's less annoying than having a simple /meta request create millions of useless entries...

Parameters:

gts - The GTS to check.

Returns:

true if the GTS is known.