com.neeve.config.impl

Class ConfigRepositoryBase

java.lang.Object

com.neeve.config.ConfigObject

com.neeve.config.impl.ConfigRepositoryBase

All Implemented Interfaces:

IConfigRepository

Direct Known Subclasses:

MemConfigRepository, PftConfigRepository

public abstract class ConfigRepositoryBase
extends ConfigObject
implements IConfigRepository

Base implementation of a configuration repository.

This class supplies the base implementation for a configuration repository. The provider should extend this class and complete the implementation.

Method Summary

Modifier and Type	Method and Description
void	close() Implementation of IConfigRepository.close()
void	commit() Implementation of IConfigRepository.commit()
IConfigComplexEntityContainer	createComplexEntityContainer(String address) Implementation of IConfigRepository.createComplexEntityContainer(java.lang.String)
IConfigComplexEntityContainer	createComplexEntityContainerObject(String address, boolean markAsDirty) Create a configuration complex entity container object.
IConfigSimpleEntityContainer	createSimpleEntityContainer(String address) Implementation of IConfigRepository.createSimpleEntityContainer(java.lang.String)
IConfigSimpleEntityContainer	createSimpleEntityContainerObject(String address, boolean markAsDirty) Create a configuration simple entity container object.
void	deserialize(String str, boolean markAsDirty) Implementation of IConfigRepository.deserialize(java.lang.String, boolean)
IConfigComplexEntity	getComplexEntity(String address) Implementation of IConfigRepository.getComplexEntity(java.lang.String)
IConfigComplexEntityContainer	getComplexEntityContainer(String address) Implementation of IConfigRepository.getComplexEntityContainer(java.lang.String)
String	getDescriptor() Implementation of IConfigRepository.getDescriptor()
IConfigSimpleEntity	getSimpleEntity(String address) Implementation of IConfigRepository.getSimpleEntity(java.lang.String)
IConfigSimpleEntityContainer	getSimpleEntityContainer(String address) Implementation of IConfigRepository.getSimpleEntityContainer(java.lang.String)
IConfigComplexEntityContainer	removeComplexEntityContainer(String address) Implementation of IConfigRepository.removeComplexEntityContainer(java.lang.String)
IConfigSimpleEntityContainer	removeSimpleEntityContainer(String address) Implementation of IConfigRepository.removeSimpleEntityContainer(java.lang.String)
void	serialize(StringBuilder builder) Implementation of IConfigRepository.serialize(java.lang.StringBuilder)
String	toString() Get a string representation of the repository
void	traverse(String filter, IConfigTraversalCallback callback) Implementation of IConfigRepository.traverse(java.lang.String, com.neeve.config.IConfigTraversalCallback)

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

createSimpleEntityContainerObject

public final IConfigSimpleEntityContainer createSimpleEntityContainerObject(String address,
                                                                            boolean markAsDirty)
                                                                     throws EConfigException

Create a configuration simple entity container object.

Parameters:

addr - The address of the entity container. The address must start with '/'. An IllegalArgumentException is thrown in otherwise.

markAsDirty - Indicates whether the newly created object should be marked as dirty. The value supplied to this parameter is typically false when objects are created by the provider during the initial repository open.

Returns:

Returns the created container.

Throws:

EConfigException - Thrown in case the repository already has a content object at the supplied address.

Threading:

This method is not safe for concurrent access by multiple threads.

This method is intended for use by provider implementations to create simple entity container objects when loaded from the durable storage.

createComplexEntityContainerObject

public final IConfigComplexEntityContainer createComplexEntityContainerObject(String address,
                                                                              boolean markAsDirty)
                                                                       throws EConfigException

Create a configuration complex entity container object.

Parameters:

addr - The address of the entity container. The address must start with '/'. An IllegalArgumentException is thrown in otherwise.

markAsDirty - Indicates whether the newly created object should be marked as dirty. The value supplied to this parameter is typically false when objects are created by the provider during the initial repository open.

Returns:

Returns the created container.

Throws:

EConfigException - Thrown in case the repository already has a content object at the supplied address.

Threading:

This method is not safe for concurrent access by multiple threads.

This method is intended for use by provider implementations to create complex entity container objects when loaded from the durable storage.

getDescriptor

public final String getDescriptor()

Implementation of IConfigRepository.getDescriptor()

Specified by:

getDescriptor in interface IConfigRepository

Returns:

The descriptor. A value of null indicates the repository was not created using a descriptor.

createSimpleEntityContainer

public final IConfigSimpleEntityContainer createSimpleEntityContainer(String address)
                                                               throws EConfigException

Implementation of IConfigRepository.createSimpleEntityContainer(java.lang.String)

Specified by:

createSimpleEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container. The address must start with '/'. An IllegalArgumentException is thrown in otherwise.

Returns:

Returns the created container.

Throws:

EConfigException - Thrown in case the repository already has a content object at the supplied address.

createComplexEntityContainer

public final IConfigComplexEntityContainer createComplexEntityContainer(String address)
                                                                 throws EConfigException

Implementation of IConfigRepository.createComplexEntityContainer(java.lang.String)

Specified by:

createComplexEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container. The address must start with '/'. An IllegalArgumentException is thrown in otherwise.

Returns:

Returns the created container.

Throws:

EConfigException - Thrown in case the repository already has a content object at the supplied address.

getSimpleEntityContainer

public final IConfigSimpleEntityContainer getSimpleEntityContainer(String address)

Implementation of IConfigRepository.getSimpleEntityContainer(java.lang.String)

Specified by:

getSimpleEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container.

Returns:

Returns null if the address does not refer to a valid entity container.

getComplexEntityContainer

public final IConfigComplexEntityContainer getComplexEntityContainer(String address)

Implementation of IConfigRepository.getComplexEntityContainer(java.lang.String)

Specified by:

getComplexEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container.

Returns:

Returns null if the address does not refer to a valid entity container.

getSimpleEntity

public final IConfigSimpleEntity getSimpleEntity(String address)

Implementation of IConfigRepository.getSimpleEntity(java.lang.String)

Specified by:

getSimpleEntity in interface IConfigRepository

Parameters:

address - The address of the entity.

Returns:

Returns null if the address does not refer to a valid simple entity.

getComplexEntity

public final IConfigComplexEntity getComplexEntity(String address)

Implementation of IConfigRepository.getComplexEntity(java.lang.String)

Specified by:

getComplexEntity in interface IConfigRepository

Parameters:

address - The address of the entity.

Returns:

Returns null if the address does not refer to a valid simple entity.

removeSimpleEntityContainer

public final IConfigSimpleEntityContainer removeSimpleEntityContainer(String address)

Implementation of IConfigRepository.removeSimpleEntityContainer(java.lang.String)

Specified by:

removeSimpleEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container to remove.

Returns:

Returns the removed container or null if a simple container with the supplied address does not exist.

removeComplexEntityContainer

public final IConfigComplexEntityContainer removeComplexEntityContainer(String address)

Implementation of IConfigRepository.removeComplexEntityContainer(java.lang.String)

Specified by:

removeComplexEntityContainer in interface IConfigRepository

Parameters:

address - The address of the entity container to remove.

Returns:

Returns the removed container or null if a complex container with the supplied address does not exist.

traverse

public final void traverse(String filter,
                           IConfigTraversalCallback callback)

Implementation of IConfigRepository.traverse(java.lang.String, com.neeve.config.IConfigTraversalCallback)

Specified by:

traverse in interface IConfigRepository

Parameters:

filter - The address filter. The '*' character matches one or more characters. "..." is a level wilcard i.e. it matches everything at and below the level at which "..." appears. For example, "a*\/b*" will match "aa/ba" and "ab/bb" while "a*\/b*\/..." will match "aa/bb/c/d/e/f" and "ab/bb/c".

callback - The callback notified for each of the config objects encountered during the traversal.

serialize

public final void serialize(StringBuilder builder)

Implementation of IConfigRepository.serialize(java.lang.StringBuilder)

Specified by:

serialize in interface IConfigRepository

deserialize

public final void deserialize(String str,
                              boolean markAsDirty)
                       throws EConfigException

Implementation of IConfigRepository.deserialize(java.lang.String, boolean)

Specified by:

deserialize in interface IConfigRepository

Parameters:

str - The string to derialize from.

markAsDirty - Indicates whether the created entity and entity container objects are marked as dirty or not.

Throws:

EConfigException

commit

public final void commit()
                  throws EConfigException

Implementation of IConfigRepository.commit()

Specified by:

commit in interface IConfigRepository

Throws:

EConfigException - Thrown in case an error was encountered in committing the changes to storage.

This method commits any changes made to the repository to durable storage (determined by parameters passed to the configuration provider during repository open). The method walks through each entity and entity container that has changed since the repository was opened or last committed and delegates the commit for each one of them to the configuration provider.

close

public final void close()
                 throws EConfigException

Implementation of IConfigRepository.close()

Specified by:

close in interface IConfigRepository

Throws:

EConfigException - Thrown in case an error was encountered in closing the repository

This method closes the respository. This method should be the last call made to the respository.

toString

public final String toString()

Get a string representation of the repository

Overrides:

toString in class Object