Package omero.api

Class _IConfigDisp

  • All Implemented Interfaces:
    Ice.Object, java.io.Serializable, java.lang.Cloneable, _IConfigOperations, _IConfigOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, IConfig, ServiceInterface
    Direct Known Subclasses:
    _IConfigTie
    public abstract class _IConfigDisp
extends Ice.ObjectImpl
implements IConfig
    Access to server configuration. These methods provide access to the state and configuration of the server and its components (e.g. the database). However, it should not be assumed that two subsequent calls to a proxy for this service will go to the same server due to clustering. Not all possible server configuration is available through this API. Some values (such as DB connection info, ports, etc.) must naturally be set before this service is accessible. Manages synchronization of the various configuration sources internally. It is therefore important that as far as possible all configuration changes take place via this interface and not, for example, directly via java.util.prefs.Preferences. Also used as the main developer example for developing (stateless) ome.api interfaces. See source code documentation for more.
    See Also:
    Serialized Form

    • Field Detail

      • __ids

        public static final java.lang.String[] __ids

    • Constructor Detail

      • _IConfigDisp

        public _IConfigDisp()

    • Method Detail

      • ice_copyStateFrom

        protected void ice_copyStateFrom​(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException
        Throws:
        java.lang.CloneNotSupportedException

      • ice_isA

        public boolean ice_isA​(java.lang.String s)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Ice.ObjectImpl

      • ice_isA

        public boolean ice_isA​(java.lang.String s,
                       Ice.Current __current)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Ice.ObjectImpl

      • ice_ids

        public java.lang.String[] ice_ids()
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Ice.ObjectImpl

      • ice_ids

        public java.lang.String[] ice_ids​(Ice.Current __current)
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Ice.ObjectImpl

      • ice_id

        public java.lang.String ice_id()
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Ice.ObjectImpl

      • ice_id

        public java.lang.String ice_id​(Ice.Current __current)
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Ice.ObjectImpl

      • ice_staticId

        public static java.lang.String ice_staticId()

      • getConfigDefaults_async

        public final void getConfigDefaults_async​(AMD_IConfig_getConfigDefaults __cb)
                                   throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        Throws:
        ServerError

      • getConfigValue_async

        public final void getConfigValue_async​(AMD_IConfig_getConfigValue __cb,
                                       java.lang.String key)
                                throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        key - The non-null name of the desired configuration value
        Throws:
        ApiUsageException - if the key is null or invalid.
        SecurityViolation - if the value for the key is not readable.
        ServerError

      • getConfigValues_async

        public final void getConfigValues_async​(AMD_IConfig_getConfigValues __cb,
                                        java.lang.String keyRegex)
                                 throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        keyRegex - The non-null regex of the desired configuration values
        Throws:
        ServerError

      • getDatabaseTime_async

        public final void getDatabaseTime_async​(AMD_IConfig_getDatabaseTime __cb)
                                 throws ServerError
        Checks the database for its time using a SELECT statement.
        Specified by:
        getDatabaseTime_async in interface _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        Throws:
        InternalException - though any call can throw an InternalException it is more likely that this can occur while contacting the DB. An exception here most likely means (A) a temporary issue with the DB or (B) a SQL dialect issue which must be corrected by the Omero team.
        ServerError

      • getDatabaseUuid_async

        public final void getDatabaseUuid_async​(AMD_IConfig_getDatabaseUuid __cb)
                                 throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        Throws:
        ServerError

      • getVersion_async

        public final void getVersion_async​(AMD_IConfig_getVersion __cb)
                            throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        Throws:
        ServerError

      • setConfigValue_async

        public final void setConfigValue_async​(AMD_IConfig_setConfigValue __cb,
                                       java.lang.String key,
                                       java.lang.String value)
                                throws ServerError
        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 _IConfigOperationsNC
        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.
        Throws:
        ApiUsageException - if the key is null or invalid.
        SecurityViolation - if the value is not writable.
        ServerError

      • setConfigValueIfEquals_async

        public final void setConfigValueIfEquals_async​(AMD_IConfig_setConfigValueIfEquals __cb,
                                               java.lang.String key,
                                               java.lang.String value,
                                               java.lang.String test)
                                        throws ServerError
        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 _IConfigOperationsNC
        Parameters:
        __cb - The callback object for the operation.
        key -
        Throws:
        ApiUsageException
        SecurityViolation
        ServerError

      • ___getVersion

        public static Ice.DispatchStatus ___getVersion​(IConfig __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

      • ___getConfigValue

        public static Ice.DispatchStatus ___getConfigValue​(IConfig __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

      • ___getConfigValues

        public static Ice.DispatchStatus ___getConfigValues​(IConfig __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

      • ___getConfigDefaults

        public static Ice.DispatchStatus ___getConfigDefaults​(IConfig __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

      • ___getClientConfigValues

        public static Ice.DispatchStatus ___getClientConfigValues​(IConfig __obj,
                                                          IceInternal.Incoming __inS,
                                                          Ice.Current __current)

      • ___getClientConfigDefaults

        public static Ice.DispatchStatus ___getClientConfigDefaults​(IConfig __obj,
                                                            IceInternal.Incoming __inS,
                                                            Ice.Current __current)

      • ___setConfigValue

        public static Ice.DispatchStatus ___setConfigValue​(IConfig __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

      • ___setConfigValueIfEquals

        public static Ice.DispatchStatus ___setConfigValueIfEquals​(IConfig __obj,
                                                           IceInternal.Incoming __inS,
                                                           Ice.Current __current)

      • ___getDatabaseUuid

        public static Ice.DispatchStatus ___getDatabaseUuid​(IConfig __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

      • ___getDatabaseTime

        public static Ice.DispatchStatus ___getDatabaseTime​(IConfig __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

      • ___getServerTime

        public static Ice.DispatchStatus ___getServerTime​(IConfig __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

      • __dispatch

        public Ice.DispatchStatus __dispatch​(IceInternal.Incoming in,
                                     Ice.Current __current)
        Specified by:
        __dispatch in interface Ice.Object
        Overrides:
        __dispatch in class Ice.ObjectImpl

      • __writeImpl

        protected void __writeImpl​(IceInternal.BasicStream __os)
        Overrides:
        __writeImpl in class Ice.ObjectImpl

      • __readImpl

        protected void __readImpl​(IceInternal.BasicStream __is)
        Overrides:
        __readImpl in class Ice.ObjectImpl