public interface ConfigurationManager extends OsidManager, ConfigurationProfile
The configuration manager provides access sessions to retrieve and manage configurations. A manager may support federation in that values can be accessed in a specified configuration and parameters may be defined in a specified registry. The sessions included in this manager are:
ValueRetrievalSession:
a basic session for
retrieving configuration values ValueLookupSession:
a basic session for looking up
configuration values ValueQuerySession:
a basic session for querying
configuration values ValueSearchSession:
a basic session for searching
configuration values ValueAdminSession:
a session for setting and
changing configuration values ValueNotificationSession:
a session for
subscribing to changes of configuration values ParameterLookupSession:
a session for retrieving
defined parameters ParameterQuerySession:
a session for querying
defined parameters ParameterSearchSession:
a session for searching
defined parameters ParameterAdminSession:
a session for creating,
updating and deleting parameter definitions ParameterNoitificationSession:
a session for
subscribing to adds and changes of parameters ParamaterRegistrySession:
a session for examining
mappings of parameters to registries ParamaterRegistryAssignmentSession:
a session for
making mappings of parameters to registries ParameterConfigurationSession:
a session for
examining mappings of parameters to configurations ParameterConfigurationAssignmentSession:
a session
for mapping parameters to configurations ParameterSmartConfigurationSession:
a session for
managing smart configurations of parameters ConfigurationLookupSession:
a session for
retrieving configurations ConfigurationQuerySession:
a session for querying
configurations ConfigurationSearchSession:
a session for
searching configurations ConfigurationAdminSession:
a session for creating
and updating configurations ConfigurationNotificationSession:
a session for
subscribing to adds and changes to configurations ConfigurationHierarchySession:
a session for
traversing a hierarchy of configurations ConfigurationHierarchyDesignSession:
a session for
managing a hierarchy of configurations Modifier and Type | Method and Description |
---|---|
ConfigurationAdminSession |
getConfigurationAdminSession()
Gets a configuration administration session.
|
ConfigurationBatchManager |
getConfigurationBatchManager()
Gets a
ConfigurationBatchManager. |
ConfigurationHierarchyDesignSession |
getConfigurationHierarchyDesignSession()
Gets a hierarchy design service for configurations.
|
ConfigurationHierarchySession |
getConfigurationHierarchySession()
Gets a hierarchy traversal service for configurations.
|
ConfigurationLookupSession |
getConfigurationLookupSession()
Gets a configuration lookup session.
|
ConfigurationNotificationSession |
getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver)
Gets the notification session for subscribing to changes to
configurations.
|
ConfigurationQuerySession |
getConfigurationQuerySession()
Gets a configuration query session.
|
ConfigurationRulesManager |
getConfigurationRulesManager()
Gets a
ConfigurationRulesManager. |
ConfigurationSearchSession |
getConfigurationSearchSession()
Gets a configuration search session.
|
ParameterAdminSession |
getParameterAdminSession()
Gets a parameter administration session.
|
ParameterAdminSession |
getParameterAdminSessionForConfiguration(Id configurationId)
Gets a parameter administration session using the supplied
configuration.
|
ParameterConfigurationAssignmentSession |
getParameterConfigurationAssignmentSession()
Gets a session for managing mappings of parameters to configurations.
|
ParameterConfigurationSession |
getParameterConfigurationSession()
Gets a session for looking up mappings of parameters to
configurations.
|
ParameterLookupSession |
getParameterLookupSession()
Gets a parameter lookup session
|
ParameterLookupSession |
getParameterLookupSessionForConfiguration(Id configurationId)
Gets a parameter lookup session using the supplied configuration.
|
ParameterNotificationSession |
getParameterNotificationSession(ParameterReceiver parameterReceiver)
Gets a parameter notification session.
|
ParameterNotificationSession |
getParameterNotificationSessionForConfiguration(ParameterReceiver parameterReceiver,
Id configurationId)
Gets a parameter notification session using the specified
configuration.
|
ParameterQuerySession |
getParameterQuerySession()
Gets a parameter query session
|
ParameterQuerySession |
getParameterQuerySessionForConfiguration(Id configurationId)
Gets a parameter search session using the supplied configuration.
|
ParameterSearchSession |
getParameterSearchSession()
Gets a parameter search session
|
ParameterSearchSession |
getParameterSearchSessionForConfiguration(Id configurationId)
Gets a parameter search session using the supplied configuration.
|
ParameterSmartConfigurationSession |
getParameterSmartConfigurationSession(Id configurationId)
Gets a session for managing smart configurations.
|
ValueAdminSession |
getValueAdminSession()
Gets a configuration value administration session.
|
ValueAdminSession |
getValueAdminSessionForConfiguration(Id configurationId)
Gets a value administration session using the supplied configuration.
|
ValueLookupSession |
getValueLookupSession()
Gets a configuration value lookup session.
|
ValueLookupSession |
getValueLookupSessionForConfiguration(Id configurationId)
Gets a configuration value lookup session using the supplied
configuration.
|
ValueNotificationSession |
getValueNotificationSession(ValueReceiver valueReceiver)
Gets a value notification session.
|
ValueNotificationSession |
getValueNotificationSessionForConfiguration(ValueReceiver valueReceiver,
Id configurationId)
Gets a value notification session using the specified configuration
|
ValueQuerySession |
getValueQuerySession()
Gets a configuration value query session.
|
ValueQuerySession |
getValueQuerySessionForConfiguration(Id configurationId)
Gets a configuration value query session using the supplied
configuration.
|
ValueRetrievalSession |
getValueRetrievalSession()
Gets a configuration value retrieval session.
|
ValueRetrievalSession |
getValueRetrievalSessionForConfiguration(Id configurationId)
Gets a configuration value retrieval session using the supplied
configuration.
|
ValueSearchSession |
getValueSearchSession()
Gets a configuration value search session
|
ValueSearchSession |
getValueSearchSessionForConfiguration(Id configurationId)
Gets a configuration value search session using the supplied
configuration.
|
changeBranch, initialize, rollbackService
close
getConfigurationRecordTypes, getConfigurationSearchRecordTypes, getParameterRecordTypes, getParameterSearchRecordTypes, getValueConditionRecordTypes, getValueRecordTypes, getValueSearchRecordTypes, supportsConfigurationAdmin, supportsConfigurationBatch, supportsConfigurationHierarchy, supportsConfigurationHierarchyDesign, supportsConfigurationLookup, supportsConfigurationNotification, supportsConfigurationQuery, supportsConfigurationRecordType, supportsConfigurationRules, supportsConfigurationSearch, supportsConfigurationSearchRecordType, supportsParameterAdmin, supportsParameterConfiguration, supportsParameterConfigurationAssignment, supportsParameterLookup, supportsParameterNotification, supportsParameterQuery, supportsParameterRecordType, supportsParameterSearch, supportsParameterSearchRecordType, supportsParameterSmartConfiguration, supportsValueAdmin, supportsValueConditionRecordType, supportsValueLookup, supportsValueNotification, supportsValueQuery, supportsValueRecordType, supportsValueRetrieval, supportsValueSearch, supportsValueSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ValueRetrievalSession getValueRetrievalSession() throws OperationFailedException
ValueRetrievalSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueRetrieval()
is false
optional
- This method must be implemented if
supportsValueRetrieval()
is true.
ValueRetrievalSession getValueRetrievalSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ValueRetrievalSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueRetrieval()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueRetrieval()
are true.
ValueLookupSession getValueLookupSession() throws OperationFailedException
ValueLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueLookup()
is false
optional
- This method must be implemented if
supportsValueLookup()
is true.
ValueLookupSession getValueLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ValueLookupSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueLookup()
are true.
ValueQuerySession getValueQuerySession() throws OperationFailedException
ValueQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueQuery()
is false
optional
- This method must be implemented if
supportsValueQuery()
is true.
ValueQuerySession getValueQuerySessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ValueQuerySession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueQuery()
are true.
ValueSearchSession getValueSearchSession() throws OperationFailedException
ValueSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueSearch()
is false
optional
- This method must be implemented if
supportsValueSearch()
is true.
ValueSearchSession getValueSearchSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ValueSearchSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueSearch()
are true.
ValueAdminSession getValueAdminSession() throws OperationFailedException
ValueAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueAdmin()
is false
optional
- This method must be implemented if
supportsValueAdmin()
is true.
ValueAdminSession getValueAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ValueAdminSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- supportsValueAdmin()
or supportsVisibleFederation()
is
false
UnimplementedException
- supportsValueAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueAdmin()
are true.
ValueNotificationSession getValueNotificationSession(ValueReceiver valueReceiver) throws OperationFailedException
valueReceiver
- the notification callback ValueNotificationSession
NullArgumentException
- valueReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueNotification()
is false
optional
- This method must be implemented if
supportsValueNotification()
is true.
ValueNotificationSession getValueNotificationSessionForConfiguration(ValueReceiver valueReceiver, Id configurationId) throws NotFoundException, OperationFailedException
valueReceiver
- the notification callbackconfigurationId
- the Id
of the
Configuration
to use ValueNotificationSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- valueReceiver
or
configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueNotification()
are true.
ParameterLookupSession getParameterLookupSession() throws OperationFailedException
ParameterLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterLookup()
is false
optional
- This method must be implemented if
supportsParameterLookup()
is true.
ParameterLookupSession getParameterLookupSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ParamaterLookupSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterLookup()
are true.
ParameterQuerySession getParameterQuerySession() throws OperationFailedException
ParameterQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterQuery()
is false
optional
- This method must be implemented if
supportsParameterQuery()
is true.
ParameterQuerySession getParameterQuerySessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ParamaterQuerySession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterQuery()
are true.
ParameterSearchSession getParameterSearchSession() throws OperationFailedException
ParameterSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSearch()
is false
optional
- This method must be implemented if
supportsParameterSearch()
is true.
ParameterSearchSession getParameterSearchSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ParamaterSearchSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterSearch()
are true.
ParameterAdminSession getParameterAdminSession() throws OperationFailedException
ParameterAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterAdmin()
is false
optional
- This method must be implemented if
supportsParameterAdmin()
is true.
ParameterAdminSession getParameterAdminSessionForConfiguration(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ParameterAdminSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterAdmin()
are true.
ParameterNotificationSession getParameterNotificationSession(ParameterReceiver parameterReceiver) throws OperationFailedException
parameterReceiver
- the notification callback ParameterNotificationSession
NullArgumentException
- parameterReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterNotification()
is false
optional
- This method must be implemented if
supportsParameterNotification()
is true.
ParameterNotificationSession getParameterNotificationSessionForConfiguration(ParameterReceiver parameterReceiver, Id configurationId) throws NotFoundException, OperationFailedException
parameterReceiver
- the notification callbackconfigurationId
- the Id
of the
Configuration
to use ParameterNotificationSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- parameterReceiver
or configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterNotification()
are true.
ParameterConfigurationSession getParameterConfigurationSession() throws OperationFailedException
ParameterConfigurationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterConfiguration()
is false
optional
- This method must be implemented if
supportsParameterConfiguration()
is true.
ParameterConfigurationAssignmentSession getParameterConfigurationAssignmentSession() throws OperationFailedException
ParameterConfigurationAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterConfigurationAssignment()
is
false
optional
- This method must be implemented if
supportsParameterConfigurationAssignment()
is
true.
ParameterSmartConfigurationSession getParameterSmartConfigurationSession(Id configurationId) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to use ParameterSmartConfigurationSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSmartConfiguration()
is false
optional
- This method must be implemented if
supportsParameterSmartConfiguration()
is
true.
ConfigurationLookupSession getConfigurationLookupSession() throws OperationFailedException
ConfigurationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationLookup()
is false
optional
- This method must be implemented if
supportsConfigurationLookup()
is true.
ConfigurationQuerySession getConfigurationQuerySession() throws OperationFailedException
ConfigurationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationQuery()
is false
optional
- This method must be implemented if
supportsConfigurationQuery()
is true.
ConfigurationSearchSession getConfigurationSearchSession() throws OperationFailedException
ConfigurationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationSearch()
is false
optional
- This method must be implemented if
supportsConfigurationSearch()
is true.
ConfigurationAdminSession getConfigurationAdminSession() throws OperationFailedException
ConfigurationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationAdmin()
is false
optional
- This method must be implemented if
supportsConfigurationAdmin()
is true.
ConfigurationNotificationSession getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver) throws OperationFailedException
configurationReceiver
- the notification callback ConfigurationNotificationSession
NullArgumentException
- configurationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationNotification()
is false
optional
- This method must be implemented if
supportsConfigurationNotification()
is
true.
ConfigurationHierarchySession getConfigurationHierarchySession() throws OperationFailedException
ConfigurationHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationHierarchy()
is false
optional
- This method must be implemented if
supportsConfigurationHierarchy()
is true.
ConfigurationHierarchyDesignSession getConfigurationHierarchyDesignSession() throws OperationFailedException
ConfigurationHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationHierarchyDesign()
is false
optional
- This method must be implemented if
supportsConfigurationHierarchyDesign()
is
true.
ConfigurationBatchManager getConfigurationBatchManager() throws OperationFailedException
ConfigurationBatchManager.
ConfigurationBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationBatch()
is false
optional
- This method must be implemented if
supportsConfigurationBatch()
is true.
ConfigurationRulesManager getConfigurationRulesManager() throws OperationFailedException
ConfigurationRulesManager.
ConfigurationRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationRules()
is false
optional
- This method must be implemented if
supportsConfigurationRules()
is true.