com.neurosys.configs

Interface ConfigurationService<K,T,C extends AbstractConfiguration>

All Superinterfaces:

ChangeGenerator<C>, ConfigurationDao<K,T,C>, ConfigurationSource<K,T>, FreeQuery, GenericDao<C>

All Known Implementing Classes:

DefaultConfigurationService

public interface ConfigurationService<K,T,C extends AbstractConfiguration>
extends ConfigurationDao<K,T,C>, ChangeGenerator<C>

Service level wrappers over ConfigurationDao and in turn ConfigurationSource.
Additional services like Authorization, Inherent Caching, event listeners on any setter methods etc

This implements ChangeGenerator and generates an event whenever ConfigurationDao.put(AbstractConfiguration) is called. The new configuration is passed as an event to all the ChangeListeners

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_CACHE_NAME Configurations cached

Fields inherited from interface com.neurosys.configs.ConfigurationSource

NAMESPACE_DELIM

Method Summary

Modifier and Type	Method and Description
void	clearCache(String namespace) Will clear the namespace hierarchy from the cache
Map<K,T>	get(String namespace) Get a Map of key name and corresponding IConfiguration for the specific namespace.
T	get(String namespace, K key)
T	get(String namespace, K key, Collection<Authorization> authorizations) Will throw an exception if it did not find any matching result for the Config Note: param matching is case insensitive
List<Class>	getConfigTypes()
<CD extends ConfigurationDao<String,String,C>> CD	getDao() Dao backing this service
String	keyGen(String namespace, String key)
C	put(C config, Collection<Authorization> authorizations)

Methods inherited from interface com.neurosys.configs.ConfigurationDao

delete, getAll, getConfig, getConfig, getConfigs, getNamespaces, put

Methods inherited from interface com.neurosys.dao.GenericDao

delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Methods inherited from interface com.neurosys.configs.ConfigurationSource

get

Methods inherited from interface com.neurosys.events.ChangeGenerator

addChangeListener, getListeners, notifyAllListeners, setListeners

Field Detail

CONFIGURATION_CACHE_NAME

static final String CONFIGURATION_CACHE_NAME

Configurations cached

See Also:

Constant Field Values

Method Detail

get

T get(String namespace,
      K key,
      Collection<Authorization> authorizations)
throws AuthorizationException

Will throw an exception if it did not find any matching result for the Config
Note: param matching is case insensitive

Parameters:

namespace - as String

key - as K

Collection - of Authorization from the Component trying to access this configuration.

Returns:

AbstractConfiguration

Throws:

AuthorizationException

get

T get(String namespace,
      K key)

Specified by:

get in interface ConfigurationDao<K,T,C extends AbstractConfiguration>

Specified by:

get in interface ConfigurationSource<K,T>

Parameters:

namespace - as String

key - as String

Returns:

value as type T

get

Map<K,T> get(String namespace)

Get a Map of key name and corresponding IConfiguration for the specific namespace.
The key in the returned map, is the key name local to the namespace.

This method may not be supported by some implementations. If namespace does not exist or namespace is null then null is returned. Note: param matching is case insensitive

Specified by:

get in interface ConfigurationSource<K,T>

Parameters:

namespace - as String

Returns:

Map of key and corresponding IConfiguration

clearCache

void clearCache(String namespace)

Will clear the namespace hierarchy from the cache

Parameters:

namespace -

put

C put(C config,
      Collection<Authorization> authorizations)
throws AuthorizationException

Parameters:

config - as C

Collection - of Authorization from the Component trying to access this configuration.

Returns:

AbstractConfiguration

Throws:

AuthorizationException

getConfigTypes

List<Class> getConfigTypes()

Returns:

the Class types of AbstractConfiguration by the App

getDao

<CD extends ConfigurationDao<String,String,C>> CD getDao()

Dao backing this service

Returns:

keyGen

String keyGen(String namespace,
              String key)