org.rvpf.config

Class Config

Object

Config

Direct Known Subclasses:

Metadata

@NotThreadSafe
public class Config
extends Object

Config.

Keeps configuration informations for a service (MBean). Also supplies convenience methods to handle service context informations.

Although instances are not thread safe, the service class loader methods are.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_DIR_PROPERTY Contains the path to the cache directory.
static String	CONFIG_DIR_PROPERTY This property is automagically created when the configuration file loading is initiated.
static URI	CWD_URI Current working directory URI.
static String	DEFAULT_CACHE_DIR Default cache directory.
static String	DEFAULT_SERVICE_DATA_DIR Default service data directory path.
static String	RVPF_PROPERTIES Holds the path to the initial properties text.
static String	SERVICE_DATA_DIR_PROPERTY Specifies the service data directory path.
static String	SERVICE_FILENAME Service file name.
static String	SUBSTITUTION_DEFERRED_PROPERTY Asks to defer substitution when a marker is of the form '$${x}'.
static String	SUBSTITUTION_ENABLED_PROPERTY Enables or disables the marker substitution mode where a marker is of the form '${x}'.
static String	SYSTEM_PROPERTY_PREFIX The system property prefix for RVPF specific properties.
static String	UUID_FILENAME UUID file name.

Constructor Summary

Constructors

Constructor and Description
Config(String serviceName) Constructs an instance.
Config(String serviceName, ConfigProperties properties) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	addClassDefEntity(ClassDefEntity classDef) Adds a class definition entity.
void	addClassLibEntity(ClassLibEntity classLib) Adds a class library entity.
void	addServiceContext(ServiceContext serviceContext) Adds properties for a Service.
boolean	containsProperties(String key) Asks if this contains a properties group.
boolean	containsProperty(String key) Asks if this contains a property.
URL	createURL(String from, Optional<URL> context) Creates a URL.
static File	dataDir(Optional<File> parentDir, KeyedGroups serviceProperties, String dataDirProperty, String defaultDirName) Returns a data directory.
void	fetchSystemProperties() Fetches system properties.
boolean	getBooleanValue(String key) Gets a boolean value for a key, defaulting to false.
boolean	getBooleanValue(String key, boolean defaultValue) Gets a boolean value, providing a default.
File	getCacheDir(String section, Optional<UUID> uuid, Optional<String> ident) Gets the cache directory.
Optional<? extends ClassDef>	getClassDef(String key, Optional<ClassDef> defaultClassDef) Gets a ClassDef for a key, providing a default.
Optional<ClassDefEntity>	getClassDefEntity(String name) Gets a class definition entity.
ClassDef[]	getClassDefs(String key) Gets the ClassDef array for the specified key.
Optional<ClassLibEntity>	getClassLibEntity(String name) Gets a class library entity.
ServiceClassLoader	getClassLoader() Gets the service class loader.
Optional<String>	getConfigDir() Gets the 'config.dir' property.
File	getDataDir() Gets the data directory.
double	getDoubleValue(String key, double defaultValue) Gets a double value, providing a default.
Optional<ElapsedTime>	getElapsedValue(String key, Optional<ElapsedTime> defaultValue, Optional<ElapsedTime> emptyValue) Gets an elapsed time value, providing a default.
Optional<HashMap<String,Entity>>	getEntities() Gets the entities.
File	getFile(String path) Gets a File instance for a path.
int	getIntValue(String key, int defaultValue) Gets an int value, providing a default.
Optional<char[]>	getPasswordValue(String key) Gets a password value.
ConfigProperties	getProperties() Gets the values.
KeyedGroups	getPropertiesGroup(String key) Gets a group of properties.
KeyedGroups[]	getPropertiesGroups(String key) Gets the groups of configuration properties for a specified key.
String	getRootName() Gets the root element name of the document used to load this config.
Service	getService() Gets the service owning this config.
Optional<ServiceContext>	getServiceContext(String key) Gets a service context.
Collection<ServiceContext>	getServiceContexts() Gets the service contexts.
String	getServiceName() Gets the service name.
Optional<String>	getServiceName(String key) Gets a service name.
ConfigProperties	getServiceProperties() Gets the service properties.
Optional<UUID>	getServiceUUID() Gets the service UUID.
Optional<DateTime>	getStamp() Gets the last modified stamp.
Optional<String>	getStringValue(String key) Gets a string value.
Optional<String>	getStringValue(String key, Optional<String> defaultValue) Gets a string value, providing a default.
String[]	getStringValues(String key) Gets the string values for the specified key.
protected Logger	getThisLogger() Gets the logger.
URL	getURL() Gets the URL from which this Config was loaded.
boolean	hasService() Asks if this configuration is linked to a service.
boolean	isIncluded(URL url) Asks if the supplied URL is already included.
void	keepEntities(Optional<HashMap<String,Entity>> entities) Keeps the entities.
boolean	registerClassLib(String classLibName) Registers a ClassLib.
void	registerClassLoader() Registers the class loader.
void	restoreState(Object state) Restores the state.
Optional<HashMap<String,Entity>>	returnEntities() Returns the entities that were kept.
Object	saveState() Saves the state.
void	setClassLoader(Optional<ServiceClassLoader> classLoader) Sets the service class loader.
void	setConfigDir(String dir) Sets the 'config.dir' property.
void	setRootName(String rootName) Sets the root element name of the document used to load this Config.
void	setService(Service service) Sets the service owning this Config.
void	setServiceProperties(ConfigProperties properties) Sets the service properties.
void	setUpService() Sets up the service.
void	setURL(URL url) Sets the URL from which this Config was loaded.
Params	substitute(Params params) Substitutes markers in parameter string values.
String	substitute(String text, boolean deferred) Substitutes markers in a given text.
void	tearDown() Tears down what has been set up.
String	toString()
void	updateStamp(Optional<DateTime> stamp) Updates the last modified stamp.

Methods inherited from class Object

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

Field Detail

CACHE_DIR_PROPERTY

public static final String CACHE_DIR_PROPERTY

Contains the path to the cache directory.

See Also:

Constant Field Values

CONFIG_DIR_PROPERTY

public static final String CONFIG_DIR_PROPERTY

This property is automagically created when the configuration file loading is initiated. It contains the path to the configuration directory.

See Also:

Constant Field Values

CWD_URI

public static final URI CWD_URI

Current working directory URI.

DEFAULT_CACHE_DIR

public static final String DEFAULT_CACHE_DIR

Default cache directory.

See Also:

Constant Field Values

DEFAULT_SERVICE_DATA_DIR

public static final String DEFAULT_SERVICE_DATA_DIR

Default service data directory path.

See Also:

Constant Field Values

RVPF_PROPERTIES

public static final String RVPF_PROPERTIES

Holds the path to the initial properties text.

See Also:

Constant Field Values

SERVICE_DATA_DIR_PROPERTY

public static final String SERVICE_DATA_DIR_PROPERTY

Specifies the service data directory path.

See Also:

Constant Field Values

SERVICE_FILENAME

public static final String SERVICE_FILENAME

Service file name.

See Also:

Constant Field Values

SUBSTITUTION_DEFERRED_PROPERTY

public static final String SUBSTITUTION_DEFERRED_PROPERTY

Asks to defer substitution when a marker is of the form '$${x}'.

See Also:

Constant Field Values

SUBSTITUTION_ENABLED_PROPERTY

public static final String SUBSTITUTION_ENABLED_PROPERTY

Enables or disables the marker substitution mode where a marker is of the form '${x}'. The 'x' would be the name of a property.

See Also:

Constant Field Values

SYSTEM_PROPERTY_PREFIX

public static final String SYSTEM_PROPERTY_PREFIX

The system property prefix for RVPF specific properties.

See Also:

Constant Field Values

UUID_FILENAME

public static final String UUID_FILENAME

UUID file name.

See Also:

Constant Field Values

Constructor Detail

Config

public Config(@Nonnull
              String serviceName)

Constructs an instance.

Parameters:

serviceName - The service name (may be empty).

Config

public Config(@Nonnull
              String serviceName,
              @Nonnull
              ConfigProperties properties)

Constructs an instance.

Parameters:

serviceName - The service name (may be empty).

properties - The properties.

Method Detail

dataDir

@Nonnull
 @CheckReturnValue
public static final File dataDir(@Nonnull
                                                               Optional<File> parentDir,
                                                               @Nonnull
                                                               KeyedGroups serviceProperties,
                                                               @Nonnull
                                                               String dataDirProperty,
                                                               @Nonnull
                                                               String defaultDirName)

Returns a data directory.

Parameters:

parentDir - An optional parent directory.

serviceProperties - The service properties.

dataDirProperty - The data directory property.

defaultDirName - The default directory name.

Returns:

The data directory.

addClassDefEntity

public final void addClassDefEntity(@Nonnull
                                    ClassDefEntity classDef)

Adds a class definition entity.

Parameters:

classDef - The class definition entity.

addClassLibEntity

public final void addClassLibEntity(@Nonnull
                                    ClassLibEntity classLib)

Adds a class library entity.

Parameters:

classLib - The class library entity.

addServiceContext

public final void addServiceContext(@Nonnull
                                    ServiceContext serviceContext)

Adds properties for a Service.

If the Service already exists, the new informations are appended to those already present.

Parameters:

serviceContext - The properties.

containsProperties

@CheckReturnValue
public final boolean containsProperties(@Nonnull
                                                           String key)

Asks if this contains a properties group.

Parameters:

key - The properties group key (name).

Returns:

True if the properties group is present.

containsProperty

@CheckReturnValue
public final boolean containsProperty(@Nonnull
                                                         String key)

Asks if this contains a property.

Parameters:

key - The property key (name).

Returns:

True if the property is present.

createURL

@Nullable
 @CheckReturnValue
public final URL createURL(@Nonnull
                                                          String from,
                                                          @Nonnull
                                                          Optional<URL> context)

Creates a URL.

If the context is null, if the 'config.dir' property is defined, it is used as context, otherwise, the document is searched as a resource on the classpath; if not found, the context is set to the current directory.

Parameters:

from - The document source.

context - The optional current directory context.

Returns:

A new URL (null when malformed).

fetchSystemProperties

public final void fetchSystemProperties()

Fetches system properties.

All system properties having a name beginning with '"rvpf."' are added with the '"rvpf."' prefix removed. These properties have precedence over any other.

getBooleanValue

@CheckReturnValue
public final boolean getBooleanValue(@Nonnull
                                                        String key)

Gets a boolean value for a key, defaulting to false.

If the key is not found or its value is unrecognized, false will be returned.

Parameters:

key - The name of the value.

Returns:

The requested value or false.

getBooleanValue

@CheckReturnValue
public final boolean getBooleanValue(@Nonnull
                                                        String key,
                                                        boolean defaultValue)

Gets a boolean value, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The key for the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getCacheDir

@Nullable
 @CheckReturnValue
public final File getCacheDir(@Nonnull
                                                             String section,
                                                             @Nonnull
                                                             Optional<UUID> uuid,
                                                             @Nonnull
                                                             Optional<String> ident)

Gets the cache directory.

The section name is used as the name of a subdirectory of the cache directory specified in this configuration. When supplied, the UUID is used to generate a name for a further subdirectory level.

When the resulting directory is absent, it is created and initialized.

Parameters:

section - The name of the cache section.

uuid - An optional UUID as subsection.

ident - An optional service identification.

Returns:

The cache directory (null on failure).

getClassDef

@Nonnull
 @CheckReturnValue
public final Optional<? extends ClassDef> getClassDef(@Nonnull
                                                                                    String key,
                                                                                    @Nonnull
                                                                                    Optional<ClassDef> defaultClassDef)

Gets a ClassDef for a key, providing a default.

Parameters:

key - The key for the ClassDef.

defaultClassDef - The optional default for the key.

Returns:

The requested ClassDef or the provided default.

getClassDefEntity

@Nonnull
 @CheckReturnValue
public final Optional<ClassDefEntity> getClassDefEntity(@Nonnull
                                                                                      String name)

Gets a class definition entity.

Parameters:

name - The name of the class definition entity.

Returns:

The optional class definition entity.

getClassDefs

@Nonnull
 @CheckReturnValue
public final ClassDef[] getClassDefs(@Nonnull
                                                                   String key)

Gets the ClassDef array for the specified key.

Parameters:

key - The key for the requested ClassDef array.

Returns:

The ClassDef array (may be empty).

getClassLibEntity

@Nonnull
 @CheckReturnValue
public final Optional<ClassLibEntity> getClassLibEntity(@Nonnull
                                                                                      String name)

Gets a class library entity.

Parameters:

name - The name of the class library entity.

Returns:

The optional class library entity.

getClassLoader

@Nonnull
 @CheckReturnValue
public final ServiceClassLoader getClassLoader()

Gets the service class loader.

If the service class loader has not been set before, an instance is requested from its class.

Returns:

The service class loader.

getConfigDir

@Nonnull
 @CheckReturnValue
public final Optional<String> getConfigDir()

Gets the 'config.dir' property.

Returns:

The optional 'config.dir' property.

getDataDir

@Nonnull
 @CheckReturnValue
public final File getDataDir()

Gets the data directory.

Returns:

The data directory.

getDoubleValue

@CheckReturnValue
public final double getDoubleValue(String key,
                                                      double defaultValue)

Gets a double value, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The key for the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getElapsedValue

@Nonnull
 @CheckReturnValue
public final Optional<ElapsedTime> getElapsedValue(@Nonnull
                                                                                 String key,
                                                                                 @Nonnull
                                                                                 Optional<ElapsedTime> defaultValue,
                                                                                 @Nonnull
                                                                                 Optional<ElapsedTime> emptyValue)

Gets an elapsed time value, providing a default.

Parameters:

key - The key for the value.

defaultValue - The optional default value.

emptyValue - The optional assumed value for empty.

Returns:

The requested value, empty, or the provided default.

See Also:

KeyedValues

getEntities

@Nonnull
 @CheckReturnValue
public final Optional<HashMap<String,Entity>> getEntities()

Gets the entities.

Returns:

The optional entities.

getFile

@Nonnull
 @CheckReturnValue
public final File getFile(String path)

Gets a File instance for a path.

If the path is relative, it will use either the config URL as base if it is a file, or the current directory.

Parameters:

path - The path.

Returns:

The File instance.

getIntValue

@CheckReturnValue
public final int getIntValue(@Nonnull
                                                String key,
                                                int defaultValue)

Gets an int value, providing a default.

If the key is not found or its value is unrecognized the default will be returned.

Parameters:

key - The key for the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getPasswordValue

@Nonnull
 @CheckReturnValue
public final Optional<char[]> getPasswordValue(@Nonnull
                                                                             String key)

Gets a password value.

Parameters:

key - The key for the value.

Returns:

The optional password value.

getProperties

@Nonnull
 @CheckReturnValue
public final ConfigProperties getProperties()

Gets the values.

Returns:

The values.

getPropertiesGroup

@Nonnull
 @CheckReturnValue
public final KeyedGroups getPropertiesGroup(@Nonnull
                                                                          String key)

Gets a group of properties.

Parameters:

key - The name of the group.

Returns:

The properties.

getPropertiesGroups

@Nonnull
 @CheckReturnValue
public final KeyedGroups[] getPropertiesGroups(@Nonnull
                                                                             String key)

Gets the groups of configuration properties for a specified key.

Parameters:

key - The name of the groups.

Returns:

An array of configuration property groups (may be empty).

getRootName

@Nonnull
 @CheckReturnValue
public final String getRootName()

Gets the root element name of the document used to load this config.

Returns:

The root element name.

getService

@Nonnull
 @CheckReturnValue
public final Service getService()

Gets the service owning this config.

Returns:

The service.

getServiceContext

@Nonnull
 @CheckReturnValue
public final Optional<ServiceContext> getServiceContext(@Nonnull
                                                                                      String key)

Gets a service context.

The service aliases will be searched when the key does not correspond to a service definition.

Parameters:

key - The name of the service.

Returns:

The service context (may be empty).

getServiceContexts

@Nonnull
 @CheckReturnValue
public final Collection<ServiceContext> getServiceContexts()

Gets the service contexts.

Returns:

The service contexts.

getServiceName

@Nonnull
 @CheckReturnValue
public final String getServiceName()

Gets the service name.

Returns:

The service name.

getServiceName

@Nonnull
 @CheckReturnValue
public final Optional<String> getServiceName(String key)

Gets a service name.

Parameters:

key - Either an alias or the name itself.

Returns:

The service name (empty if unknown).

getServiceProperties

@Nonnull
 @CheckReturnValue
public final ConfigProperties getServiceProperties()

Gets the service properties.

Returns:

The service properties.

getServiceUUID

@Nonnull
 @CheckReturnValue
public final Optional<UUID> getServiceUUID()

Gets the service UUID.

Returns:

The optional service UUID.

getStamp

@Nonnull
 @CheckReturnValue
public final Optional<DateTime> getStamp()

Gets the last modified stamp.

Returns:

The optional last modified stamp.

getStringValue

@Nonnull
 @CheckReturnValue
public final Optional<String> getStringValue(@Nonnull
                                                                           String key)

Gets a string value.

Parameters:

key - The key for the value.

Returns:

The requested value or empty.

getStringValue

@Nonnull
 @CheckReturnValue
public final Optional<String> getStringValue(@Nonnull
                                                                           String key,
                                                                           @Nonnull
                                                                           Optional<String> defaultValue)

Gets a string value, providing a default.

Parameters:

key - The key for the value.

defaultValue - The default value.

Returns:

The requested value or the provided default.

getStringValues

@Nonnull
 @CheckReturnValue
public final String[] getStringValues(@Nonnull
                                                                    String key)

Gets the string values for the specified key.

Parameters:

key - The key for the values.

Returns:

An array of values (may be empty).

getURL

@Nonnull
 @CheckReturnValue
public URL getURL()

Gets the URL from which this Config was loaded.

Returns:

The URL.

hasService

@CheckReturnValue
public final boolean hasService()

Asks if this configuration is linked to a service.

Returns:

True if this configuration is linked to a service.

isIncluded

@CheckReturnValue
public boolean isIncluded(@Nonnull
                                             URL url)

Asks if the supplied URL is already included.

A subsequent call with an URL which is equal to the supplied URL will return true. This is used while loading the documents to avoid multiple inclusions of the same document.

Parameters:

url - The supplied URL.

Returns:

True if already included.

keepEntities

public final void keepEntities(@Nonnull
                               Optional<HashMap<String,Entity>> entities)

Keeps the entities.

Keeps alive the entities, even if they are not referenced.

Parameters:

entities - The object containing references to all the entities.

registerClassLib

@CheckReturnValue
public boolean registerClassLib(@Nonnull
                                                   String classLibName)

Registers a ClassLib.

Parameters:

classLibName - The name of the ClassLib.

Returns:

True on success.

registerClassLoader

public final void registerClassLoader()

Registers the class loader.

restoreState

public final void restoreState(@Nonnull
                               Object state)

Restores the state.

Used to cancel state modifications caused by the repeated loading of child documents (metadata).

Parameters:

state - The saved state.

returnEntities

@Nonnull
public final Optional<HashMap<String,Entity>> returnEntities()

Returns the entities that were kept.

Returns:

The optional entities.

saveState

@Nonnull
 @CheckReturnValue
public final Object saveState()

Saves the state.

Returns:

A copy of the state.

setClassLoader

public final void setClassLoader(@Nonnull
                                 Optional<ServiceClassLoader> classLoader)

Sets the service class loader.

When the service class loader is not supplied, an instance is requested from its class.

Parameters:

classLoader - The service class loader (may be empty).

setConfigDir

public final void setConfigDir(@Nonnull
                               String dir)

Sets the 'config.dir' property.

Parameters:

dir - The new value for the 'config.dir' property.

setRootName

public final void setRootName(@Nonnull
                              String rootName)

Sets the root element name of the document used to load this Config.

Parameters:

rootName - The root element name.

setService

public final void setService(@Nonnull
                             Service service)

Sets the service owning this Config.

Parameters:

service - The service.

setServiceProperties

public final void setServiceProperties(@Nonnull
                                       ConfigProperties properties)

Sets the service properties.

Parameters:

properties - The service properties.

setURL

public void setURL(@Nonnull
                   URL url)

Sets the URL from which this Config was loaded.

Parameters:

url - The URL.

setUpService

public final void setUpService()

Sets up the service.

Establishes the set of properties that are specific to the current service.

substitute

@Nonnull
 @CheckReturnValue
public final Params substitute(@Nonnull
                                                             Params params)

Substitutes markers in parameter string values.

Parameters:

params - The original parameters.

Returns:

Cloned parameters with markers substituted.

substitute

@Nonnull
 @CheckReturnValue
public final String substitute(@Nonnull
                                                             String text,
                                                             boolean deferred)

Substitutes markers in a given text.

A substitution marker would be a '${x}' property reference.

Note: should be called only while substitutions are enabled.

Parameters:

text - The text possibly containing substitution markers.

deferred - True if substitution of '$${x}' should be deferred.

Returns:

The text with markers substituted.

tearDown

public void tearDown()

Tears down what has been set up.

toString

public String toString()

Overrides:

toString in class Object

updateStamp

public final void updateStamp(@Nonnull
                              Optional<DateTime> stamp)

Updates the last modified stamp.

Parameters:

stamp - The last modified stamp.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.