com.neurosys.configs

Class DefaultConfigurationService<C extends AbstractConfiguration>

java.lang.Object

com.neurosys.configs.DefaultConfigurationService<C>

Type Parameters:

T -

All Implemented Interfaces:

ConfigurationDao<String,String,C>, ConfigurationService<String,String,C>, ConfigurationSource<String,String>, FreeQuery, GenericDao<C>, ChangeGenerator<C>

public class DefaultConfigurationService<C extends AbstractConfiguration>
extends Object
implements ConfigurationService<String,String,C>

ConfigurationService implementation that wrap the following services over base configuration fetching and setting configs via AbstractConfigurationJPADaoImpl:

• Audit of changes
• Cache eviction on change
• Authorization service for AbstractAuthorizableConfigurations

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.cache.Cache	cache

Fields inherited from interface com.neurosys.configs.ConfigurationService

CONFIGURATION_CACHE_NAME

Fields inherited from interface com.neurosys.configs.ConfigurationSource

NAMESPACE_DELIM

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationService()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
void	clearCache(String namespace) Will clear the namespace hierarchy from the cache
void	delete(C config) Remove a configuration
Long	delete(Long id) A special Delete operation on the entity that will remove the entity and related entities based on id.
Map	get(String namespace) Get a Map of key name and corresponding IConfiguration for the specific namespace.
String	get(String namespace, String key)
String	get(String namespace, String key, Collection<Authorization> authorizations) If an authorizationService is defined it will use it, else will delegate to get(String, String) and log a warning.
String	get(User user, String namespace, String key) Get a configuration in the context to a User
Map	getAll(String namespace) Get a Map of key name and corresponding AbstractConfiguration for the specific namespace.
AuthorizationService	getAuthorizationService() Optional service to perform Authorization on config fetches.
org.springframework.cache.Cache	getCache() Optional cache, if provided will clear the cache fore related entries being set
C	getConfig(C proxy)
C	getConfig(String namespace, String key)
List<C>	getConfigs(String namespace) Get configurations for a namespace and nested namesapces, as a collection of C
List<Class>	getConfigTypes()
<CD extends ConfigurationDao<String,String,C>> CD	getDao() DAO backing this service
List	getListeners() Get list directly.
List<String>	getNamespaces() Get list of namespaces
void	init()
String	keyGen(String namespace, String key)
C	load(Object id)
C	load(Object id, Class c) In some situations the DAO represents an Interface or perhaps a parent of the actual Entity./ The exact type of the entity would have to be Supplied.
void	notifyAllListeners(C event) Whenever a node is selected/updated, it also notifies its listeners.
C	put(C config) Will evict the namespace hierarchy, under which this configuration exists
C	put(C config, Collection<Authorization> authorizations)
List	query(String ql, String dialect, Object... params) Execute a raw Query in the native implementation language.
Page	query(String ql, String dialect, PageInfo pageInfo, Object... params) Execute a raw Query in the native implementation language.
C	save(C c)
void	setAuthorizationService(AuthorizationService authorizationService) Optional service to perform Authorization on config fetches.
void	setCache(org.springframework.cache.Cache cache) Optional cache, if provided will clear the cache fore related entries being set
void	setConfigTypes(List<Class> configTypes)
void	setDao(ConfigurationDao<String,String,C> dao) DAO backing this service
void	setListeners(List listeners) Set list directly.
int	update(String arg0, boolean arg1, Object... arg2) An Update query with optional params

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected org.springframework.cache.Cache cache

Constructor Detail

DefaultConfigurationService

public DefaultConfigurationService()

Method Detail

init

@PostConstruct
public void init()

keyGen

public String keyGen(String namespace,
                     String key)

Specified by:

keyGen in interface ConfigurationService<String,String,C extends AbstractConfiguration>

clearCache

public void clearCache(String namespace)

Description copied from interface: ConfigurationService

Will clear the namespace hierarchy from the cache

Specified by:

clearCache in interface ConfigurationService<String,String,C extends AbstractConfiguration>

put

@Transactional
public C put(C config)

Will evict the namespace hierarchy, under which this configuration exists

Specified by:

put in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Returns:

put

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

Specified by:

put in interface ConfigurationService<String,String,C extends AbstractConfiguration>

Parameters:

config - as C

Returns:

AbstractConfiguration

Throws:

AuthorizationException

getConfig

public C getConfig(C proxy)

Specified by:

getConfig in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

getConfig

public C getConfig(String namespace,
                   String key)

Specified by:

getConfig in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

key - as String

Returns:

AbstractConfiguration

get

public String get(String namespace,
                  String key)

Specified by:

get in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Specified by:

get in interface ConfigurationService<String,String,C extends AbstractConfiguration>

Specified by:

get in interface ConfigurationSource<String,String>

Parameters:

namespace - as String

key - as String

Returns:

value as type T

get

public Map 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 ConfigurationService<String,String,C extends AbstractConfiguration>

Specified by:

get in interface ConfigurationSource<String,String>

Parameters:

namespace - as String

Returns:

Map of key and corresponding IConfiguration

getAll

public Map getAll(String namespace)

Get a Map of key name and corresponding AbstractConfiguration for the specific namespace.
The key in the returned map, is the full key name including namespace, to avoid local key name conflicts in the returned map.
Note that namespaces are assumed to follow a delimited convention defined by ConfigurationSource.NAMESPACE_DELIM This method respects hierarchy based on default convention.
If namespace does not exist or namespace is null then null is returned. Note: param matching is case insensitive NO CACHING ON THIS METHOD

Specified by:

getAll in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace -

Returns:

getNamespaces

public List<String> getNamespaces()

Description copied from interface: ConfigurationDao

Get list of namespaces

Specified by:

getNamespaces in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Returns:

List of String

get

public String get(User user,
                  String namespace,
                  String key)

Get a configuration in the context to a User

Specified by:

get in interface ConfigurationSource<String,String>

Returns:

T

get

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

If an authorizationService is defined it will use it, else will delegate to get(String, String) and log a warning.

Specified by:

get in interface ConfigurationService<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

key - as K

authorizations - as Collection of Authorization

Returns:

AbstractConfiguration

Throws:

AuthorizationException

delete

public void delete(C config)

Description copied from interface: ConfigurationDao

Remove a configuration

Specified by:

delete in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Specified by:

delete in interface GenericDao<C extends AbstractConfiguration>

getConfigs

public List<C> getConfigs(String namespace)

Description copied from interface: ConfigurationDao

Get configurations for a namespace and nested namesapces, as a collection of C

Specified by:

getConfigs in interface ConfigurationDao<String,String,C extends AbstractConfiguration>

Parameters:

namespace - as String

Returns:

Collection of C

getConfigTypes

public List<Class> getConfigTypes()

Specified by:

getConfigTypes in interface ConfigurationService<String,String,C extends AbstractConfiguration>

Returns:

the Class types of AbstractConfiguration by the App

setConfigTypes

public void setConfigTypes(List<Class> configTypes)

getAuthorizationService

public AuthorizationService getAuthorizationService()

Optional service to perform Authorization on config fetches.

See Also:

get(User, String, String), get(String, String, Collection)

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

Optional service to perform Authorization on config fetches.

See Also:

get(User, String, String), get(String, String, Collection)

getDao

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

DAO backing this service

Specified by:

getDao in interface ConfigurationService<String,String,C extends AbstractConfiguration>

Returns:

setDao

public void setDao(ConfigurationDao<String,String,C> dao)

DAO backing this service

getCache

public org.springframework.cache.Cache getCache()

Optional cache, if provided will clear the cache fore related entries being set

setCache

public void setCache(org.springframework.cache.Cache cache)

Optional cache, if provided will clear the cache fore related entries being set

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<C extends AbstractConfiguration>

notifyAllListeners

public void notifyAllListeners(C event)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<C extends AbstractConfiguration>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<C extends AbstractConfiguration>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<C extends AbstractConfiguration>

delete

public Long delete(Long id)

Description copied from interface: GenericDao

A special Delete operation on the entity that will remove the entity and related entities based on id. If the number of records deleted can be determined, that is returned else -1

Specified by:

delete in interface GenericDao<C extends AbstractConfiguration>

Returns:

Long

load

public C load(Object id)

Specified by:

load in interface GenericDao<C extends AbstractConfiguration>

load

public C load(Object id,
              Class c)

Description copied from interface: GenericDao

In some situations the DAO represents an Interface or perhaps a parent of the actual Entity./ The exact type of the entity would have to be Supplied.

Specified by:

load in interface GenericDao<C extends AbstractConfiguration>

Parameters:

id - as Id for Entity

c - as Class of entity

Returns:

save

public C save(C c)

Specified by:

save in interface GenericDao<C extends AbstractConfiguration>

query

public List query(String ql,
                  String dialect,
                  Object... params)
           throws Exception

Description copied from interface: FreeQuery

Execute a raw Query in the native implementation language.
WARNING : Be careful these methods are not called by any service API as it can create a level of direct dependence on the provider/schema.
Dependent on what the implementation layers

Specified by:

query in interface FreeQuery

Parameters:

ql - as String in native Schema language

dialect - as String. NULL or empty or "NATIVE" implies NATIVE, "JPA" implies JPA will be used. Additional dialects can be supported but they will be implementation dependent.

params - as Query parameters to the string.
Impl specific:When using params the Query string can refer to them like ?1, ?2 etc

Returns:

List

Throws:

Exception

query

public Page query(String ql,
                  String dialect,
                  PageInfo pageInfo,
                  Object... params)
           throws Exception

Description copied from interface: FreeQuery

Execute a raw Query in the native implementation language.
WARNING : Be careful these methods are not called by any service API as it can create a level of direct dependence on the provider/schema.
Dependent on what the implementation layers

Specified by:

query in interface FreeQuery

Parameters:

ql - as String in native Schema language

dialect - as String. NULL or empty or "NATIVE" implies NATIVE, "JPA" implies JPA will be used. Additional dialects can be supported but they will be implementation dependent.

pageInfo - as PageInfo for pagination of result

params - as Query parameters to the string
Impl specific:When using params the Query string can refer to them like ?1, ?2 etc

Returns:

Page

Throws:

Exception

update

public int update(String arg0,
                  boolean arg1,
                  Object... arg2)

Description copied from interface: FreeQuery

An Update query with optional params

Specified by:

update in interface FreeQuery

Parameters:

arg0 - as String

arg1 - as boolean, if the query is raw/native or entity based.

arg2 - as List of Object parameters

Returns:

int for number of records updated