org.apache.archiva.components.registry

Interface Registry

All Known Implementing Classes:

CommonsConfigurationRegistry

public interface Registry

The Plexus registry is a single source of external configuration for Plexus components and applications. It can be used by components to source configuration, knowing that it can be used from within applications without the information being hard coded into the component.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(RegistryListener listener) Add a change listener.
void	addConfigurationFromFile(File file) Load configuration from the given file.
void	addConfigurationFromFile(File file, String prefix) Load configuration from the given file.
void	addConfigurationFromResource(String resource) Load configuration from the given classloader resource.
void	addConfigurationFromResource(String resource, String prefix) Load configuration from the given classloader resource.
String	dump() Dump the entire registry to a string, for debugging purposes.
boolean	getBoolean(String key) Get a boolean value from the registry.
boolean	getBoolean(String key, boolean defaultValue) Get a boolean value from the registry.
Collection<String>	getFullKeys() Get all the keys in this registry.
int	getInt(String key) Get an integer value from the registry.
int	getInt(String key, int defaultValue) Get an integer value from the registry.
Collection<String>	getKeys() Get all the keys in this registry.
List	getList(String key) Get a list of strings at the given key in the registry.
Properties	getProperties(String key) TODO move to Map which is more generic ?
Registry	getSection(String name) Get a subsection of the registry, identified by the given name.
String	getString(String key) Get a string value from the registry.
String	getString(String key, String defaultValue) Get a string value from the registry.
Registry	getSubset(String key) Get a subset of the registry, for all keys descended from the given key.
List	getSubsetList(String key) Get a list of subsets of the registry, for all keys descended from the given key.
void	initialize()
boolean	isEmpty() Determine if the registry contains any elements.
void	remove(String key) Remove a keyed element from the registry.
boolean	removeChangeListener(RegistryListener listener)
void	removeSubset(String key) Remove a keyed subset of the registry.
void	save() Save any changes to the registry since it was loaded.
void	setBoolean(String key, boolean value) Set a boolean value in the registry.
void	setInt(String key, int value) Set an integer value in the registry.
void	setString(String key, String value) Set a string value in the registry.

Method Detail

dump

String dump()

Dump the entire registry to a string, for debugging purposes.

Returns:

the registry contents

getString

String getString(String key)

Get a string value from the registry. If not found, null is returned.

Parameters:

key - the key in the registry

Returns:

the value

getString

String getString(String key,
                 String defaultValue)

Get a string value from the registry. If not found, the default value is used.

Parameters:

key - the key in the registry

defaultValue - the default value

Returns:

the value

setString

void setString(String key,
               String value)

Set a string value in the registry.

Parameters:

key - the key in the registry

value - the value to set

getInt

int getInt(String key)

Get an integer value from the registry. If not found, an exception is thrown.

Parameters:

key - the key in the registry

Returns:

the value

Throws:

NoSuchElementException - if the key is not found

getInt

int getInt(String key,
           int defaultValue)

Get an integer value from the registry. If not found, the default value is used.

Parameters:

key - the key in the registry

defaultValue - the default value

Returns:

the value

setInt

void setInt(String key,
            int value)

Set an integer value in the registry.

Parameters:

key - the key in the registry

value - the value to set

getBoolean

boolean getBoolean(String key)

Get a boolean value from the registry. If not found, an exception is thrown.

Parameters:

key - the key in the registry

Returns:

the value

Throws:

NoSuchElementException - if the key is not found

getBoolean

boolean getBoolean(String key,
                   boolean defaultValue)

Get a boolean value from the registry. If not found, the default value is used.

Parameters:

key - the key in the registry

defaultValue - the default value

Returns:

the value

setBoolean

void setBoolean(String key,
                boolean value)

Set a boolean value in the registry.

Parameters:

key - the key in the registry

value - the value to set

addConfigurationFromResource

void addConfigurationFromResource(String resource)
                           throws RegistryException

Load configuration from the given classloader resource.

Parameters:

resource - the location to load the configuration from

Throws:

RegistryException - if a problem occurred reading the resource to add to the registry

addConfigurationFromResource

void addConfigurationFromResource(String resource,
                                  String prefix)
                           throws RegistryException

Load configuration from the given classloader resource.

Parameters:

resource - the location to load the configuration from

prefix - the location to add the configuration at in the registry

Throws:

RegistryException - if a problem occurred reading the resource to add to the registry

addConfigurationFromFile

void addConfigurationFromFile(File file)
                       throws RegistryException

Load configuration from the given file.

Parameters:

file - the location to load the configuration from

Throws:

RegistryException - if a problem occurred reading the resource to add to the registry

addConfigurationFromFile

void addConfigurationFromFile(File file,
                              String prefix)
                       throws RegistryException

Load configuration from the given file.

Parameters:

file - the location to load the configuration from

prefix - the location to add the configuration at in the registry

Throws:

RegistryException - if a problem occurred reading the resource to add to the registry

isEmpty

boolean isEmpty()

Determine if the registry contains any elements.

Returns:

whether the registry contains any elements

getList

List getList(String key)

Get a list of strings at the given key in the registry.

Parameters:

key - the key to lookup

Returns:

the list of strings

getProperties

Properties getProperties(String key)

TODO move to Map which is more generic ? Get the properties at the given key in the registry.

Parameters:

key - the key to lookup

Returns:

the properties

getSubset

Registry getSubset(String key)

Get a subset of the registry, for all keys descended from the given key.

Parameters:

key - the key to take the subset from

Returns:

the registry subset

getSubsetList

List getSubsetList(String key)

Get a list of subsets of the registry, for all keys descended from the given key.

Parameters:

key - the key to take the subsets from

Returns:

the registry subsets

getSection

Registry getSection(String name)

Get a subsection of the registry, identified by the given name. If it doesn't exist, null will be returned.

Parameters:

name - registry section name

Returns:

the registry

save

void save()
   throws RegistryException,
          UnsupportedOperationException

Save any changes to the registry since it was loaded.

Throws:

RegistryException - if there was a problem saving the registry

UnsupportedOperationException - if the registry is not writable

addChangeListener

void addChangeListener(RegistryListener listener)

Add a change listener. Note that settings this on the base registry will only detect 'invalidation' events, not individual changes. You should retrieve the named sub-registry to listen for changes. TODO: this isn't ideal, so maybe fix combined configuration to re-fire it's events to it's own listeners in the c-c implementation

Parameters:

listener - the listener

removeChangeListener

boolean removeChangeListener(RegistryListener listener)

Parameters:

listener -

Returns:

true if has been removed

Since:

2.3

getKeys

Collection<String> getKeys()

Get all the keys in this registry. Keys are only retrieved at a depth of 1.

Returns:

the set of keys

getFullKeys

Collection<String> getFullKeys()

Get all the keys in this registry.

Returns:

the set of keys

Since:

2.1

remove

void remove(String key)

Remove a keyed element from the registry.

Parameters:

key - the key to remove

removeSubset

void removeSubset(String key)

Remove a keyed subset of the registry.

Parameters:

key - the subset to remove

initialize

void initialize()
         throws RegistryException

Throws:

RegistryException