omero.api

Class _IConfigTie

java.lang.Object

Ice.ObjectImpl

omero.api._IConfigDisp

omero.api._IConfigTie

All Implemented Interfaces:

Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _IConfigOperations, _IConfigOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, IConfig, ServiceInterface

public class _IConfigTie
extends _IConfigDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.api._IConfigDisp

__ids

Fields inherited from interface omero.api.IConfig

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_IConfigTie(_IConfigOperations delegate)
_IConfigTie()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object rhs)
void	getClientConfigDefaults_async(AMD_IConfig_getClientConfigDefaults __cb, Ice.Current __current) Reads the etc/omero.properties file and returns all the key/value pairs that are found there which match the prefix omero.client.
void	getClientConfigValues_async(AMD_IConfig_getClientConfigValues __cb, Ice.Current __current) Retrieves configuration values like getConfigValues but only those with the prefix omero.client.
void	getConfigDefaults_async(AMD_IConfig_getConfigDefaults __cb, Ice.Current __current) Reads the etc/omero.properties file and returns all the key/value pairs that are found there.
void	getConfigValue_async(AMD_IConfig_getConfigValue __cb, java.lang.String key, Ice.Current __current) Retrieves a configuration value from the backend store.
void	getConfigValues_async(AMD_IConfig_getConfigValues __cb, java.lang.String keyRegex, Ice.Current __current) Retrieves configuration values from the backend store which match the given regex.
void	getDatabaseTime_async(AMD_IConfig_getDatabaseTime __cb, Ice.Current __current) Checks the database for its time using a SELECT statement.
void	getDatabaseUuid_async(AMD_IConfig_getDatabaseUuid __cb, Ice.Current __current) Provides the UUID for this OMERO (database) instance.
void	getServerTime_async(AMD_IConfig_getServerTime __cb, Ice.Current __current) Checks the current server for its time.
void	getVersion_async(AMD_IConfig_getVersion __cb, Ice.Current __current) Provides the release version.
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
void	setConfigValue_async(AMD_IConfig_setConfigValue __cb, java.lang.String key, java.lang.String value, Ice.Current __current) Sets a configuration value in the backend store.
void	setConfigValueIfEquals_async(AMD_IConfig_setConfigValueIfEquals __cb, java.lang.String key, java.lang.String value, java.lang.String test, Ice.Current __current) Calls setConfigValue if and only if the configuration property is currently equal to the test argument.

Methods inherited from class omero.api._IConfigDisp

___getClientConfigDefaults, ___getClientConfigValues, ___getConfigDefaults, ___getConfigValue, ___getConfigValues, ___getDatabaseTime, ___getDatabaseUuid, ___getServerTime, ___getVersion, ___setConfigValue, ___setConfigValueIfEquals, __dispatch, __readImpl, __writeImpl, getClientConfigDefaults_async, getClientConfigValues_async, getConfigDefaults_async, getConfigValue_async, getConfigValues_async, getDatabaseTime_async, getDatabaseUuid_async, getServerTime_async, getVersion_async, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setConfigValue_async, setConfigValueIfEquals_async

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_IConfigTie

public _IConfigTie()

_IConfigTie

public _IConfigTie(_IConfigOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getClientConfigDefaults_async

public void getClientConfigDefaults_async(AMD_IConfig_getClientConfigDefaults __cb,
                                          Ice.Current __current)
                                   throws ServerError

Description copied from interface: _IConfigOperations

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_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getClientConfigValues_async

public void getClientConfigValues_async(AMD_IConfig_getClientConfigValues __cb,
                                        Ice.Current __current)
                                 throws ServerError

Description copied from interface: _IConfigOperations

Retrieves configuration values like getConfigValues but only those with the prefix omero.client.

Specified by:

getClientConfigValues_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getConfigDefaults_async

public void getConfigDefaults_async(AMD_IConfig_getConfigDefaults __cb,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _IConfigOperations

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_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getConfigValue_async

public void getConfigValue_async(AMD_IConfig_getConfigValue __cb,
                                 java.lang.String key,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _IConfigOperations

Retrieves a configuration value from the backend store. Permissions applied to the configuration value may cause a SecurityViolation to be thrown.

Specified by:

getConfigValue_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

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

__current - The Current object for the invocation.

Throws:

ServerError

getConfigValues_async

public void getConfigValues_async(AMD_IConfig_getConfigValues __cb,
                                  java.lang.String keyRegex,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _IConfigOperations

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_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

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

__current - The Current object for the invocation.

Throws:

ServerError

getDatabaseTime_async

public void getDatabaseTime_async(AMD_IConfig_getDatabaseTime __cb,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _IConfigOperations

Checks the database for its time using a SELECT statement.

Specified by:

getDatabaseTime_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getDatabaseUuid_async

public void getDatabaseUuid_async(AMD_IConfig_getDatabaseUuid __cb,
                                  Ice.Current __current)
                           throws ServerError

Description copied from interface: _IConfigOperations

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_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getServerTime_async

public void getServerTime_async(AMD_IConfig_getServerTime __cb,
                                Ice.Current __current)
                         throws ServerError

Description copied from interface: _IConfigOperations

Checks the current server for its time. This value may be variant depending on whether the service is clustered or not.

Specified by:

getServerTime_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getVersion_async

public void getVersion_async(AMD_IConfig_getVersion __cb,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _IConfigOperations

Provides the release version. OMERO-internal values will be in the form Major.minor.patch, starting with the value 4.0.0 for the 4.0 release, Spring 2009. Customized values should begin with a alphabetic sequence followed by a hyphen: ACME-0.0.1 and any build information should follow the patch number also with a hyphen: 4.0.0-RC1. These values will be removed by getVersion

Specified by:

getVersion_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setConfigValue_async

public void setConfigValue_async(AMD_IConfig_setConfigValue __cb,
                                 java.lang.String key,
                                 java.lang.String value,
                                 Ice.Current __current)
                          throws ServerError

Description copied from interface: _IConfigOperations

Sets a configuration value in the backend store. Permissions applied to the configuration value may cause a SecurityViolation to be thrown. If the value is null or empty, then the configuration will be removed in all writable configuration sources. If the configuration is set in a non-modifiable source (e.g. in a property file on the classpath), then a subsequent call to getConfigValue will return that value.

Specified by:

setConfigValue_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

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

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

__current - The Current object for the invocation.

Throws:

ServerError

setConfigValueIfEquals_async

public void setConfigValueIfEquals_async(AMD_IConfig_setConfigValueIfEquals __cb,
                                         java.lang.String key,
                                         java.lang.String value,
                                         java.lang.String test,
                                         Ice.Current __current)
                                  throws ServerError

Description copied from interface: _IConfigOperations

Calls setConfigValue if and only if the configuration property is currently equal to the test argument. If the test is null or empty, then the configuration property will be set only if missing.

Specified by:

setConfigValueIfEquals_async in interface _IConfigOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError