ome.logic

Class ConfigImpl

java.lang.Object

ome.logic.AbstractLevel2Service

ome.logic.ConfigImpl

All Implemented Interfaces:

IConfig, LocalConfig, ServiceInterface, SelfConfigurableService

@Transactional(readOnly=true)
public class ConfigImpl
extends AbstractLevel2Service
implements LocalConfig

implementation of the IConfig service interface. Also used as the main developer example for developing (stateless) ome.logic implementations. See source code documentation for more.

Since:

3.0-M3

Version:

$Revision$, $Date$

Author:

Josh Moore, josh.moore at gmx.de

See Also:

IConfig

Field Summary

Fields inherited from class ome.logic.AbstractLevel2Service

iQuery, iUpdate, metadata, queryFactory, readOnlyStatus, sec

Fields inherited from interface ome.api.IConfig

VERSION_REGEX

Constructor Summary

Constructors

Constructor and Description
ConfigImpl()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getClientConfigDefaults() reads the etc/omero.properties file and returns all the key/value pairs that are found there which match the prefix "omero.client".
java.util.Map<java.lang.String,java.lang.String>	getClientConfigValues() retrieves configuration values like IConfig.getConfigValues(String) but only those with the prefix "omero.client".
java.util.Map<java.lang.String,java.lang.String>	getConfigDefaults() reads the etc/omero.properties file and returns all the key/value pairs that are found there.
java.lang.String	getConfigValue(java.lang.String key) see IConfig.getConfigValue(String)
java.util.Map<java.lang.String,java.lang.String>	getConfigValues(java.lang.String keyRegex) retrieves configuration values from the backend store which match the given regex.
java.util.Date	getDatabaseTime() see IConfig.getDatabaseTime()
java.lang.String	getDatabaseUuid() Provides the UUID for this OMERO (database) instance.
java.lang.String	getDatabaseVersion() Retrieves the newest database patch.
java.lang.String	getInternalValue(java.lang.String key) Provides a configuration value, ignoring the visibility of the given value.
java.util.Date	getServerTime() see IConfig.getServerTime()
java.lang.Class<? extends ServiceInterface>	getServiceInterface()
java.lang.String	getVersion() see IConfig.getVersion()
void	setConfigValue(java.lang.String key, java.lang.String value) see IConfig.setConfigValue(String, String)
boolean	setConfigValueIfEquals(java.lang.String key, java.lang.String value, java.lang.String test) see IConfig.setConfigValueIfEquals(String, String, String)
void	setCurrentDetails(CurrentDetails currentDetails) CurrentDetails setter for dependency injection.
void	setDatabaseIdentity(DatabaseIdentity db)
void	setPreferenceContext(PreferenceContext prefs) PreferenceContext setter for dependency injection.
void	setSqlAction(SqlAction sql) SqlAction setter for dependency injection.

Methods inherited from class ome.logic.AbstractLevel2Service

getBeanHelper, getExtendedMetadata, getQueryFactory, getSecuritySystem, selfConfigure, setExtendedMetadata, setQueryFactory, setQueryService, setReadOnlyStatus, setSecuritySystem, setUpdateService

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigImpl

public ConfigImpl()

Method Detail

setSqlAction

public final void setSqlAction(SqlAction sql)

SqlAction setter for dependency injection.

Parameters:

sql - the SQL action instance

See Also:

BeanHelper.throwIfAlreadySet(Object, Object)

setPreferenceContext

public final void setPreferenceContext(PreferenceContext prefs)

PreferenceContext setter for dependency injection.

Parameters:

prefs - the preference context

See Also:

BeanHelper.throwIfAlreadySet(Object, Object)

setCurrentDetails

public final void setCurrentDetails(CurrentDetails currentDetails)

CurrentDetails setter for dependency injection.

Parameters:

currentDetails - the details of the current thread's security context

See Also:

BeanHelper.throwIfAlreadySet(Object, Object)

setDatabaseIdentity

public final void setDatabaseIdentity(DatabaseIdentity db)

getServiceInterface

public final java.lang.Class<? extends ServiceInterface> getServiceInterface()

Specified by:

getServiceInterface in interface SelfConfigurableService

getServerTime

public java.util.Date getServerTime()

see IConfig.getServerTime()

Specified by:

getServerTime in interface IConfig

Returns:

Non-null Date representation of the server's own time.

getDatabaseTime

public java.util.Date getDatabaseTime()

see IConfig.getDatabaseTime()

Specified by:

getDatabaseTime in interface IConfig

Returns:

Non-null Date representation of the database's time.

getConfigValue

public java.lang.String getConfigValue(java.lang.String key)

see IConfig.getConfigValue(String)

Specified by:

getConfigValue in interface IConfig

Parameters:

key - The non-null name of the desired configuration value

Returns:

The String value linked to this key, possibly null if not set.

getConfigValues

public java.util.Map<java.lang.String,java.lang.String> getConfigValues(java.lang.String keyRegex)

Description copied from interface: IConfig

retrieves configuration values from the backend store which match the given regex. Any configuration value which would throw an exception on being loaded is omitted.

Specified by:

getConfigValues in interface IConfig

Parameters:

keyRegex - The non-null regex of the desired configuration values

Returns:

a Map from the found keys to the linked values.

getConfigDefaults

public java.util.Map<java.lang.String,java.lang.String> getConfigDefaults()

Description copied from interface: IConfig

reads the etc/omero.properties file and returns all the key/value pairs that are found there. Since this file is not to be edited its assumed that these values are in the public domain and so there's no need to protect them.

Specified by:

getConfigDefaults in interface IConfig

Returns:

a Map from the found keys to the linked values.

getClientConfigValues

public java.util.Map<java.lang.String,java.lang.String> getClientConfigValues()

Description copied from interface: IConfig

retrieves configuration values like IConfig.getConfigValues(String) but only those with the prefix "omero.client".

Specified by:

getClientConfigValues in interface IConfig

Returns:

a Map from the found keys to the linked values.

getClientConfigDefaults

public java.util.Map<java.lang.String,java.lang.String> getClientConfigDefaults()

Description copied from interface: IConfig

reads the etc/omero.properties file and returns all the key/value pairs that are found there which match the prefix "omero.client".

Specified by:

getClientConfigDefaults in interface IConfig

Returns:

a Map from the found keys to the linked values.

getInternalValue

public java.lang.String getInternalValue(java.lang.String key)

Description copied from interface: LocalConfig

Provides a configuration value, ignoring the visibility of the given value.

Specified by:

getInternalValue in interface LocalConfig

setConfigValue

@Transactional(readOnly=false)
public void setConfigValue(java.lang.String key,
                                                          java.lang.String value)

see IConfig.setConfigValue(String, String)

Specified by:

setConfigValue in interface IConfig

Parameters:

key - The non-null name of the desired configuration value

value - The String value to assign to the given key.

setConfigValueIfEquals

@Transactional(readOnly=false)
public boolean setConfigValueIfEquals(java.lang.String key,
                                                                     java.lang.String value,
                                                                     java.lang.String test)
                                                              throws ApiUsageException,
                                                                     SecurityViolation

see IConfig.setConfigValueIfEquals(String, String, String)

Specified by:

setConfigValueIfEquals in interface IConfig

Returns:

See above.

Throws:

ApiUsageException

SecurityViolation

See Also:

IConfig.setConfigValue(String, String)

getVersion

public java.lang.String getVersion()

see IConfig.getVersion()

Specified by:

getVersion in interface IConfig

Returns:

Returns the release version

See Also:

IConfig.VERSION_REGEX

getDatabaseVersion

public java.lang.String getDatabaseVersion()

Description copied from interface: LocalConfig

Retrieves the newest database patch. Also functions a simple DB ping.

Specified by:

getDatabaseVersion in interface LocalConfig

getDatabaseUuid

public java.lang.String getDatabaseUuid()

Description copied from interface: IConfig

Provides the UUID for this OMERO (database) instance. To make imports and exports function properly, only one physical database should be active with a given instance UUID. All other copies of the database with that UUID are invalid as soon as one modification is made. This value is stored in the configuration table under the key "omero.db.uuid"

Specified by:

getDatabaseUuid in interface IConfig

Returns:

String not null.