com.neeve.ods
Class StoreReplicatorDescriptor

java.lang.Object
  com.neeve.root.RootObject
      com.neeve.ods.OdsObject
          com.neeve.ods.StoreReplicatorDescriptor

public final class StoreReplicatorDescriptor
extends OdsObject

Describes a store replicator.

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

Threading:

This class is not thread safe.

Method Summary

static StoreReplicatorDescriptor	create(String name) Create a default replicator descriptor.
void	delete() Delete a replicator descriptor from the default configuration repository.
void	delete(IConfigRepository repo) Delete a replicator descriptor from the configuration repository.
static boolean	exists(IConfigRepository repo, String name) Checks if a replicator is configured in a configuration repository
static boolean	exists(String name) Checks if a replicator is configured in the default configuration repository
String	getName() Get the name of the replicator that this descriptor describes.
Properties	getProperties() Get the app properties
String	getProperty(String name) Get a replicator property.
String	getProperty(String name, String defVal) Get a replicator property supplying a default value if not present.
static StoreReplicatorDescriptor	load(IConfigRepository repo, String name) Create a replicator descriptor from a configuration respository.
static StoreReplicatorDescriptor	load(String name) Create a replicator descriptor from the default configuration respository.
static Set<StoreReplicatorDescriptor>	loadAll() Create replicator descriptors for all replicators configured in the default configuration repository.
static Set<StoreReplicatorDescriptor>	loadAll(IConfigRepository repo) Create replicator descriptors for all replicators in a configuration repository.
void	save() Save a replicator descriptor to the default configuration repository.
void	save(IConfigRepository repo) Save a replicator descriptor to a configuration repository.
Properties	save(Properties props) Save a replicator descriptor to a property table.
StoreReplicatorDescriptor	setProperties(Properties props) Set a set of replicator properties.
StoreReplicatorDescriptor	setProperty(String name, String val) Set a replicator property.
String	toString() Returns a string representation of this object

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer, setChecked, setTracer

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Get the name of the replicator that this descriptor describes.

setProperty

public final StoreReplicatorDescriptor setProperty(String name,
                                                   String val)

Set a replicator 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 replicator property.

Threading:

This method is safe for concurrent access by multiple threads.

getProperty

public final String getProperty(String name,
                                String defVal)

Get a replicator property supplying a default value if not present.

Threading:

This method is safe for concurrent access by multiple threads.

setProperties

public final StoreReplicatorDescriptor setProperties(Properties props)

Set a set of replicator 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 replicator 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 replicator 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 replicator 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 replicator descriptor to the default configuration repository.

Throws:

OdsException

Threading:

This method is notsafe for concurrent access by multiple threads.

This method saves a replicator 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 replicator 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 replicator descriptor from a configuration repository.

delete

public final void delete()
                  throws OdsException

Delete a replicator 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 replicator descriptor from the default configuration repository.

create

public static StoreReplicatorDescriptor create(String name)

Create a default replicator descriptor.

Parameters:

name - The name of the replicator 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 replicator is configured in a configuration repository

Parameters:

repo - The configuration respository to check in.

name - The name of the replicator to check for.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if a replicator is configured in the default configuration repository

Parameters:

name - The name of the replicator to check for.

Threading:

This method is safe for concurrent access by multiple threads.

load

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

Create a replicator descriptor from a configuration respository.

Parameters:

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

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

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

load

public static StoreReplicatorDescriptor load(String name)
                                      throws OdsException

Create a replicator descriptor from the default configuration respository.

Parameters:

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

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

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

Create replicator descriptors for all replicators in a configuration repository.

Parameters:

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

Returns:

Returns the set of replicator descriptors.

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

Throws:

OdsException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<StoreReplicatorDescriptor> loadAll()
                                              throws OdsException

Create replicator descriptors for all replicators configured in the default configuration repository.

Returns:

Returns the set of replicator descriptors.

This method creates and initializes replicators descriptors for all the replicators 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