public interface ConfigurationProxyManager extends OsidProxyManager, ConfigurationProfile
The configuration manager provides access to sessions to retrieve and
manage configurations. Methods in this manager support the passing a
Proxy.
A manager may support federation in that values can
be accessed in a specified configuration and paramaters 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(Proxy proxy)
Gets a configuration administration session.
|
ConfigurationBatchProxyManager |
getConfigurationBatchProxyManager()
Gets a
ConfigurationProxyManager. |
ConfigurationHierarchyDesignSession |
getConfigurationHierarchyDesignSession(Proxy proxy)
Gets a hierarchy design service for configurations.
|
ConfigurationHierarchySession |
getConfigurationHierarchySession(Proxy proxy)
Gets a hierarchy traversal service for configurations.
|
ConfigurationLookupSession |
getConfigurationLookupSession(Proxy proxy)
Gets a configuration lookup session.
|
ConfigurationNotificationSession |
getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver,
Proxy proxy)
Gets the notification session for subscribing to changes to
configurations.
|
ConfigurationQuerySession |
getConfigurationQuerySession(Proxy proxy)
Gets a configuration query session.
|
ConfigurationRulesProxyManager |
getConfigurationRulesProxyManager()
Gets a
ConfigurationProxyManager. |
ConfigurationSearchSession |
getConfigurationSearchSession(Proxy proxy)
Gets a configuration search session.
|
ParameterAdminSession |
getParameterAdminSession(Proxy proxy)
Gets a parameter administration session.
|
ParameterAdminSession |
getParameterAdminSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a parameter administration session using the supplied
configuration.
|
ParameterConfigurationAssignmentSession |
getParameterConfigurationAssignmentSession(Proxy proxy)
Gets a session for managing mappings of parameters to configurations.
|
ParameterConfigurationSession |
getParameterConfigurationSession(Proxy proxy)
Gets a session for examining mappings of parameters to configurations.
|
ParameterLookupSession |
getParameterLookupSession(Proxy proxy)
Gets a parameter lookup session
|
ParameterLookupSession |
getParameterLookupSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a parameter lookup session using the supplied configuration.
|
ParameterNotificationSession |
getParameterNotificationSession(ParameterReceiver parameterReceiver,
Proxy proxy)
Gets a parameter notification session.
|
ParameterNotificationSession |
getParameterNotificationSessionForConfiguration(ParameterReceiver parameterReceiver,
Id configurationId,
Proxy proxy)
Gets a parameter notification session using the specified
configuration.
|
ParameterQuerySession |
getParameterQuerySession(Proxy proxy)
Gets a parameter query session
|
ParameterQuerySession |
getParameterQuerySessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a parameter query session using the supplied configuration.
|
ParameterSearchSession |
getParameterSearchSession(Proxy proxy)
Gets a parameter search session
|
ParameterSearchSession |
getParameterSearchSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a parameter search session using the supplied configuration.
|
ParameterSmartConfigurationSession |
getParameterSmartConfigurationSession(Id configurationId,
Proxy proxy)
Gets a session for managing smart configurations of parameters.
|
ValueAdminSession |
getValueAdminSession(Proxy proxy)
Gets a configuration value administration session.
|
ValueAdminSession |
getValueAdminSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a value administration session using the supplied configuration.
|
ValueLookupSession |
getValueLookupSession(Proxy proxy)
Gets a configuration value lookup session.
|
ValueLookupSession |
getValueLookupSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a configuration value lookup session using the supplied
configuration.
|
ValueNotificationSession |
getValueNotificationSession(ValueReceiver valueReceiver,
Proxy proxy)
Gets a value notification session.
|
ValueNotificationSession |
getValueNotificationSessionForConfiguration(ValueReceiver valueReceiver,
Id configurationId,
Proxy proxy)
Gets a value notification session using the specified configuration
|
ValueQuerySession |
getValueQuerySession(Proxy proxy)
Gets a configuration value query session.
|
ValueQuerySession |
getValueQuerySessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a configuration value query session using the supplied
configuration.
|
ValueRetrievalSession |
getValueRetrievalSession(Proxy proxy)
Gets a configuration value retrieval session.
|
ValueRetrievalSession |
getValueRetrievalSessionForConfiguration(Id configurationId,
Proxy proxy)
Gets a configuration value retrieval session using the supplied
configuration.
|
ValueSearchSession |
getValueSearchSession(Proxy proxy)
Gets a configuration value search session.
|
ValueSearchSession |
getValueSearchSessionForConfiguration(Id configurationId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ValueRetrievalSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueRetrieval()
is false
optional
- This method must be implemented if
supportsValueRetrieval()
is true.
ValueRetrievalSession getValueRetrievalSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueRetrievalSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ValueLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueLookup()
is false
optional
- This method must be implemented if
supportsValueLookup()
is true.
ValueLookupSession getValueLookupSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueLookupSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ValueQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueQuery()
is false
optional
- This method must be implemented if
supportsValueQuery()
is true.
ValueQuerySession getValueQuerySessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueQuerySession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ValueSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueSearch()
is false
optional
- This method must be implemented if
supportsValueLookup()
is true.
ValueSearchSession getValueSearchSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueSearchSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueSearch()
or supportsVisibleFederation()
is
False
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueSearch()
are true
ValueNotificationSession getValueNotificationSession(ValueReceiver valueReceiver, Proxy proxy) throws OperationFailedException
valueReceiver
- notification callbackproxy
- a proxy ValueNotificationSession
NullArgumentException
- valueReceiver
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
valueReceiver
- notification callbackconfigurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueNotificationSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- valueReceiver,
configurationId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsValueNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueNotification()
are true.
ValueAdminSession getValueAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ValueAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueAdmin()
is false
optional
- This method must be implemented if
supportsValueAdmin()
is true.
ValueAdminSession getValueAdminSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ValueAdminSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsValueSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsValueAdmin()
are true.
ParameterLookupSession getParameterLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterLookup()
is false
optional
- This method must be implemented if
supportsParameterLookup()
is true.
ParameterLookupSession getParameterLookupSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParamaterLookupSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
is null
OperationFailedException
- unable to complete requestoptional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterLookup()
are true.
ParameterQuerySession getParameterQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterQuery()
is false
optional
- This method must be implemented if
supportsParameterQuery()
is true.
ParameterQuerySession getParameterQuerySessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParamaterQuerySession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
is null
OperationFailedException
- unable to complete requestoptional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterQuery()
are true.
ParameterSearchSession getParameterSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSearch()
is false
optional
- This method must be implemented if
supportsParameterSearch()
is true.
ParameterSearchSession getParameterSearchSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParamaterSearchSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterAdmin()
is false
optional
- This method must be implemented if
supportsParameterAdmin()
is true.
ParameterAdminSession getParameterAdminSessionForConfiguration(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParameterAdminSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsVisibleFederation()
and
supportsParameterAdmin()
are true.
ParameterNotificationSession getParameterNotificationSession(ParameterReceiver parameterReceiver, Proxy proxy) throws OperationFailedException
parameterReceiver
- notification callbackproxy
- a proxy ParameterNotificationSession
NullArgumentException
- parameterReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
parameterReceiver
- notification callbackconfigurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParameterNotificationSession
NotFoundException
- registryId
is not
foundNullArgumentException
- parameterReceiver,
configurationId,
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterConfigurationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterConfiguration()
is false
optional
- This method must be implemented if
supportsParameterConfiguration()
is true.
ParameterConfigurationAssignmentSession getParameterConfigurationAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParameterConfigurationAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterConfigurationAssignment()
is
false
optional
- This method must be implemented if
supportsParameterConfigurationAssignment()
is
true.
ParameterSmartConfigurationSession getParameterSmartConfigurationSession(Id configurationId, Proxy proxy) throws NotFoundException, OperationFailedException
configurationId
- the Id
of the
Configuration
to useproxy
- a proxy ParameterSmartConfigurationSession
NotFoundException
- configurationId
is
not foundNullArgumentException
- configuratinId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParameterSmartConfiguration()
is false
optional
- This method must be implemented if
supportsParameterSmartConfiguration()
is
true.
ConfigurationLookupSession getConfigurationLookupSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfigurationLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationLookup()
is false
optional
- This method must be implemented if
supportsConfigurationLookup()
is true.
ConfigurationQuerySession getConfigurationQuerySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfigurationQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationQuery()
is false
optional
- This method must be implemented if
supportsConfigurationQuery()
is true.
ConfigurationSearchSession getConfigurationSearchSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfigurationSearchSession
OperationFailedException
- proxy
is
null
NullArgumentException
- unable to complete requestUnimplementedException
-
supportsConfigurationSearch()
is false
optional
- This method must be implemented if
supportsConfigurationSearch()
is true.
ConfigurationNotificationSession getConfigurationNotificationSession(ConfigurationReceiver configurationReceiver, Proxy proxy) throws OperationFailedException
configurationReceiver
- notification callbackproxy
- a proxy ConfigurationNotificationSession
NullArgumentException
- configurationReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationNotification()
is false
optional
- This method must be implemented if
supportsConfigurationNotification()
is
true.
ConfigurationAdminSession getConfigurationAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfigurationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationAdmin()
is false
optional
- This method must be implemented if
supportsConfigurationAdmin()
is true.
ConfigurationHierarchySession getConfigurationHierarchySession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfiguraqtionHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationHierarchy()
is false
optional
- This method must be implemented if
supportsConfigurationHierarchy()
is true.
ConfigurationHierarchyDesignSession getConfigurationHierarchyDesignSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ConfigurationHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationHierarchyDesign()
is false
optional
- This method must be implemented if
supportsConfigurationHierarchyDesign()
is
true.
ConfigurationBatchProxyManager getConfigurationBatchProxyManager() throws OperationFailedException
ConfigurationProxyManager.
ConfigurationBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationBatch()
is false
optional
- This method must be implemented if
supportsConfigurationBatch()
is true.
ConfigurationRulesProxyManager getConfigurationRulesProxyManager() throws OperationFailedException
ConfigurationProxyManager.
ConfigurationRulesProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsConfigurationRules()
is false
optional
- This method must be implemented if
supportsConfigurationRules()
is true.