com.neeve.ods

Class StorePersisterDescriptor

java.lang.Object

com.neeve.root.RootObject

com.neeve.ods.OdsObject

com.neeve.ods.StorePersisterDescriptor

public final class StorePersisterDescriptor
extends OdsObject

Describes a store persister.

This class contains information used to describe a store persister. It is intended for use by a user when creating store persisters.

Threading:

This class is not thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_DETACHED Property used to indicate whether to persist in 'detached' mode This property is used to indicate whether the persister should operate in "detached" mode.
static String	PROP_DETACHED_QUEUE_DEPTH Property used to specify the depth of the detached thread feeder queue This property is only applicable if the persister is configured for detached mode of operation.
static String	PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK Property used to specify the affinity mask of the detached thread.
static String	PROP_DETACHED_QUEUE_OFFER_STRATEGY Property used to specify the offer strategy of the detached thread feeder queue This property is only applicable if the persister is configured for detached mode of operation.
static String	PROP_DETACHED_QUEUE_WAIT_STRATEGY Property used to specify the wait strategy of the detached thread feeder queue This property is only applicable if the persister is configured for detached mode of operation.
static String	PROP_FLUSH_ON_COMMIT Property used to indicate whether a flush should be performed on commit.
static String	PROP_RECORD_LEG_LATENCIES Property used to indicate whether to record leg latencies
static String	PROP_SHARED Property used to indicate whether this a shared persister or not.

Method Summary

Modifier and Type	Method and Description
static StorePersisterDescriptor	create(String name) Create a default persister descriptor.
static StorePersisterDescriptor	create(String name, String className) Create a persister descriptor.
void	delete() Delete a persister descriptor from the default configuration repository.
void	delete(IConfigRepository repo) Delete a persister descriptor from the configuration repository.
static boolean	exists(IConfigRepository repo, String name) Checks if a persister is configured in a configuration repository
static boolean	exists(String name) Checks if a persister is configured in the default configuration repository
String	getClassName() Get the name of the main class of the persister that this descriptor describes.
String	getName() Get the name of the persister that this descriptor describes.
Properties	getProperties() Get the app properties
String	getProperty(String name) Get a persister property.
static StorePersisterDescriptor	load(IConfigRepository repo, String name) Create a persister descriptor from a configuration respository.
static StorePersisterDescriptor	load(String name) Create a persister descriptor from the default configuration respository.
static Set<StorePersisterDescriptor>	loadAll() Create persister descriptors for all persisters configured in the default configuration repository.
static Set<StorePersisterDescriptor>	loadAll(IConfigRepository repo) Create persister descriptors for all persisters in a configuration repository.
void	save() Save a persister descriptor to the default configuration repository.
void	save(IConfigRepository repo) Save a persister descriptor to a configuration repository.
Properties	save(Properties props) Save a persister descriptor to a property table.
StorePersisterDescriptor	setProperties(Properties props) Set a set of persister properties.
StorePersisterDescriptor	setProperty(String name, String value) Set a persister property.
String	toString() Returns a string representation of this object

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_DETACHED

public static final String PROP_DETACHED

Property used to indicate whether to persist in 'detached' mode

This property is used to indicate whether the persister should operate in "detached" mode. In detached mode of operation, a separate thread is spun up that does the actual write.

See Also:

Constant Field Values

PROP_DETACHED_QUEUE_DEPTH

public static final String PROP_DETACHED_QUEUE_DEPTH

Property used to specify the depth of the detached thread feeder queue

This property is only applicable if the persister is configured for detached mode of operation. In such a case, this property configures the size of the queue that feeds the detached thread.

Default value of this parameter is 1024

See Also:

Constant Field Values

PROP_DETACHED_QUEUE_OFFER_STRATEGY

public static final String PROP_DETACHED_QUEUE_OFFER_STRATEGY

Property used to specify the offer strategy of the detached thread feeder queue

This property is only applicable if the persister is configured for detached mode of operation. In such a case, this property configures the strategy for offering messages/objects for persistence to the queue that feeds the detached thread

See Also:

Constant Field Values

PROP_DETACHED_QUEUE_WAIT_STRATEGY

public static final String PROP_DETACHED_QUEUE_WAIT_STRATEGY

Property used to specify the wait strategy of the detached thread feeder queue

This property is only applicable if the persister is configured for detached mode of operation. In such a case, this property configures the strategy for waiting for messages/objects to arrive in the queue that feeds the detached thread

See Also:

Constant Field Values

PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK

public static final String PROP_DETACHED_QUEUE_DRAINER_CPU_AFFINITIZATION_MASK

Property used to specify the affinity mask of the detached thread.

This property is only applicable if the persister is configured for detached mode of operation. In such a case, this property configures the CPU affinitization mask for the detached thread.

See Also:

Constant Field Values

PROP_SHARED

public static final String PROP_SHARED

Property used to indicate whether this a shared persister or not.

A shared persister is one that shares the underlying storage resource between the primary and backup members of a cluster

See Also:

Constant Field Values

PROP_FLUSH_ON_COMMIT

public static final String PROP_FLUSH_ON_COMMIT

Property used to indicate whether a flush should be performed on commit.

See Also:

Constant Field Values

PROP_RECORD_LEG_LATENCIES

public static final String PROP_RECORD_LEG_LATENCIES

Property used to indicate whether to record leg latencies

See Also:

Constant Field Values

Method Detail

getName

public final String getName()

Get the name of the persister that this descriptor describes.

getClassName

public final String getClassName()

Get the name of the main class of the persister that this descriptor describes.

setProperty

public final StorePersisterDescriptor setProperty(String name,
                                                  String value)

Set a persister property.

Parameters:

name - The property name

value - The property value. A vaue of null clears the property.

Returns:

Returns this object for invocation chaining.

Threading:

This method is safe for concurrent access by multiple threads.

getProperty

public final String getProperty(String name)

Get a persister property.

Threading:

This method is safe for concurrent access by multiple threads.

setProperties

public final StorePersisterDescriptor setProperties(Properties props)

Set a set of persister properties.

Returns:

Returns this object for invocation chaining.

Threading:

This method is safe for concurrent access by multiple threads.

getProperties

public final Properties getProperties()

Get the app properties

Threading:

This method is safe for concurrent access by multiple threads.

save

public final Properties save(Properties props)

Save a persister descriptor to a property table.

Parameters:

props - The property table.

Throws:

IllegalArgumentException - If the properties are null

Threading:

This method is notsafe for concurrent access by multiple threads.

save

public final void save(IConfigRepository repo)
                throws OdsException

Save a persister descriptor to a configuration repository.

Parameters:

repo - The root directory of the configuration respository.

Throws:

OdsException - Thrown in case an error in encountered during the saving of the descriptor.

Threading:

This method is notsafe for concurrent access by multiple threads.

This method saves a persister descriptor to a configuration repository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered by this class.

save

public final void save()
                throws OdsException

Save a persister descriptor to the default configuration repository.

Throws:

OdsException

Threading:

This method is notsafe for concurrent access by multiple threads.

This method saves a persister descriptor to the default confiiguration respository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered in this class.

delete

public final void delete(IConfigRepository repo)
                  throws OdsException

Delete a persister descriptor from the configuration repository.

Parameters:

repo - The configuration respository to delete the descriptor from.

Throws:

OdsException - Thrown in case an error in encountered during the deletion of the descriptor.

Threading:

This method is notsafe for concurrent access by multiple threads.

This method deletes a persister descriptor from a configuration repository.

delete

public final void delete()
                  throws OdsException

Delete a persister descriptor from the default configuration repository.

Throws:

OdsException - Thrown in case an error in encountered during the deletion of the descriptor.

Threading:

This method is notsafe for concurrent access by multiple threads.

This method permanently deletes a persister descriptor from the default configuration repository.

create

public static StorePersisterDescriptor create(String name,
                                              String className)

Create a persister descriptor.

Parameters:

name - The name of the persister whose descriptor is to be prepared.

className - The name of the persister's main class

Threading:

This method is safe for concurrent access by multiple threads.

create

public static StorePersisterDescriptor create(String name)

Create a default persister descriptor.

Parameters:

name - The name of the persister whose descriptor is to be prepared.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(IConfigRepository repo,
                             String name)

Checks if a persister is configured in a configuration repository

Parameters:

repo - The configuration respository to check in.

name - The name of the persister to check for.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if a persister is configured in the default configuration repository

Parameters:

name - The name of the persister to check for.

Threading:

This method is safe for concurrent access by multiple threads.

load

public static StorePersisterDescriptor load(IConfigRepository repo,
                                            String name)
                                     throws OdsException

Create a persister descriptor from a configuration respository.

Parameters:

repo - The configuration repository from where to load the descriptor.

name - The name of the persister whose descriptor is to be prepared.

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

load

public static StorePersisterDescriptor load(String name)
                                     throws OdsException

Create a persister descriptor from the default configuration respository.

Parameters:

name - The name of the persister whose descriptor is to be prepared.

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<StorePersisterDescriptor> loadAll(IConfigRepository repo)
                                             throws OdsException

Create persister descriptors for all persisters in a configuration repository.

Parameters:

repo - The configuration respository from where to create the persisters.

Returns:

Returns the set of persister descriptors.

This method creates and initializes persister descriptors for each of the persisters configured in a configuration repository.

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<StorePersisterDescriptor> loadAll()
                                             throws OdsException

Create persister descriptors for all persisters configured in the default configuration repository.

Returns:

Returns the set of persister descriptors.

This method creates and initializes persisters descriptors for all the persisters configured in the default configuration repository.

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

toString

public final String toString()

Returns a string representation of this object

Overrides:

toString in class Object