com.neeve.config

Class ConfigProviderDescriptor

java.lang.Object

com.neeve.config.ConfigObject

com.neeve.config.ConfigProviderDescriptor

public final class ConfigProviderDescriptor
extends ConfigObject

A configuration provider descriptor.

This class contains information to describe a configuration provider and contains methods to persist and load provider descriptors to/from X Platform configuration respositories.

Threading:

This class is safe for concurrent access by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
static ConfigProviderDescriptor	create(String name, String className) Create an empty provider descriptor.
void	delete(IConfigRepository repo) Delete a provider descriptor from a configuration repository.
static boolean	exists(IConfigRepository repo, String name) Checks if a provider descriptor is present in a configuration repository
static boolean	exists(String name) Checks if a provider descriptor is present in the local configuration repository
String	getClassName() Get the java class implementing providers of the type of this class.
String	getName() Get the name of the provider that this descriptor describes.
Properties	getProperties() Get the provider properties
static ConfigProviderDescriptor	load(IConfigRepository repo, String name) Create a provider descriptor from a configuration repository.
static ConfigProviderDescriptor	load(String name) Create a provider descriptor from the local configuration repository.
static Set<ConfigProviderDescriptor>	loadAll() Create provider descriptors for all providers in the local configuration repository.
static Set<ConfigProviderDescriptor>	loadAll(IConfigRepository repo) Create provider descriptors for all providers in a configuration repository.
void	save(IConfigRepository repo) Save a provider descriptor to a configuration repository.
void	setProperties(Properties props) Set a set of provider properties.
void	setProperty(String name, String val) Set a provider property.
String	toString() Returns a string representation of this object

Methods inherited from class com.neeve.config.ConfigObject

getTracer

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 provider that this descriptor describes.

getClassName

public final String getClassName()

Get the java class implementing providers of the type of this class.

setProperty

public final void setProperty(String name,
               String val)

Set a provider property.

setProperties

public final void setProperties(Properties props)

Set a set of provider properties.

getProperties

public final Properties getProperties()

Get the provider properties

save

public final void save(IConfigRepository repo)
                throws EConfigException

Save a provider descriptor to a configuration repository.

Parameters:

repo - The configuration repository to save the descriptor to.

Throws:

EConfigException - Thrown in case an error in encountered during the saving of the object.

Threading:

This method is notsafe for concurrent access by multiple threads.

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

delete

public final void delete(IConfigRepository repo)
                  throws EConfigException

Delete a provider descriptor from a configuration repository.

Parameters:

repo - The configuration repository to delete the descriptor from.

Throws:

EConfigException - 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 deletes a provider descriptor from a configuration repository.

toString

public final String toString()

Returns a string representation of this object

Overrides:

toString in class Object

exists

public static boolean exists(IConfigRepository repo,
             String name)

Checks if a provider descriptor is present in a configuration repository

Parameters:

repo - The configuration repository to check in.

name - The name of the provider to check for.

Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if a provider descriptor is present in the local configuration repository

Parameters:

name - The name of the provider to check for.

Threading:

This method is safe for concurrent access by multiple threads.

create

public static ConfigProviderDescriptor create(String name,
                              String className)

Create an empty provider descriptor.

Parameters:

name - The name of the provider.

className - The name of the provider's main class.

Threading:

This method is safe for concurrent access by multiple threads.

load

public static ConfigProviderDescriptor load(IConfigRepository repo,
                            String name)
                                     throws EConfigException

Create a provider descriptor from a configuration repository.

Parameters:

repo - The configuration respository to create it from.

name - The name of the provider.

Throws:

EConfigException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and initializes a provider descriptor from a configuration repository.

load

public static ConfigProviderDescriptor load(String name)
                                     throws EConfigException

Create a provider descriptor from the local configuration repository.

Parameters:

name - The name of the provider.

Throws:

EConfigException

Threading:

This method is safe for concurrent access by multiple threads.

This method creates and initializes a provider descriptor from the local configuration repository.

loadAll

public static Set<ConfigProviderDescriptor> loadAll(IConfigRepository repo)
                                             throws EConfigException

Create provider descriptors for all providers in a configuration repository.

Parameters:

repo - The configuration respository from which to load all provider descriptors.

Returns:

Returns the set of server descriptors.

This method creates and initializes provider descriptors for each of the providers present in the configuration repository identified by the specified configuration root.

Throws:

EConfigException

Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<ConfigProviderDescriptor> loadAll()
                                             throws EConfigException

Create provider descriptors for all providers in the local configuration repository.

Returns:

Returns the set of server descriptors.

This method creates and initializes provider descriptors for each of the providers present in the local configuration repository.

Throws:

EConfigException

Threading:

This method is safe for concurrent access by multiple threads.