public interface ConfigurationService extends ServiceLifecycle, OpssServiceInstance
The OPSS Runtime is only expected to make use of the getRuntimeConfiguration() method which provides a Normalized Read-Only view of the Configuration. Code dealing with OPSS runtime should not make use of the getMangementConfiguration() method as it is meant for Management Applications.
The Configuration Service can be in one of 2 statesModifier and Type | Interface and Description |
---|---|
static class |
ConfigurationService.SERVICE_MODE
The 3 Service Modes for Configuration Service
|
OpssServiceInstance.State
JpsPersistable.Mode
Modifier and Type | Method and Description |
---|---|
void |
activateTenant(oracle.security.opss.runtime.TenantInfo tenantInfo)
Activate a registered Tenant.
|
void |
addTenantListener(oracle.security.opss.service.config.TenantListener listener) |
void |
deactivateTenant(oracle.security.opss.runtime.TenantInfo tenantInfo)
Deactivate a registered Tenant.
|
ConfigurationService |
getConfiguredConfigurationService(javax.security.auth.callback.CallbackHandler cbh)
This method maybe used by the OPSS runtime post re-association to create a new ConfigurationService that is bootstrapped with its Configuration Repository.
|
ContextConfiguration |
getContextConfiguration(java.lang.String contextId) |
ContextConfiguration |
getDefaultBootstrapConfiguration() |
ContextConfiguration |
getDefaultConfiguration() |
ManagementConfiguration |
getDefaultManagementConfiguration() |
JpsConfiguration |
getJpsConfiguration() |
ManagementConfiguration |
getManagementConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo)
The Management Configuration View is a READ-WRITE view that allows CRUD operations on the Configuration.
|
ConfigurationService.SERVICE_MODE |
getMode() |
java.util.List<ServiceProviderDescriptor> |
getServiceProviders()
This method gives all OPSS service provider descriptors configured in OPSS configuration repository.
|
ContextConfiguration |
getTenantBootstrapConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo)
The bootstrap Configuration View is generally a Normalized ReadOnly view of the persistence layer configuration and is used by the OPSS Runtime.
|
ContextConfiguration |
getTenantConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo)
The Runtime Configuration View is generally a Normalized ReadOnly view of the persistence layer configuration and is used by the OPSS Runtime.
|
java.util.List<java.lang.String> |
getTenants() |
boolean |
isTenantActivated(oracle.security.opss.runtime.TenantInfo tenantInfo) |
boolean |
isTenantRegistered(oracle.security.opss.runtime.TenantInfo tenantInfo) |
void |
listenToConfigChanges(oracle.security.opss.runtime.TenantInfo tenantInfo, ConfigContextChangeListener listener)
Listen to changes to the Config Context of the tenant.
|
void |
listenToConfigChanges(oracle.security.opss.runtime.TenantInfo tenantInfo, java.lang.String serviceInstanceName, ServiceConfigChangeListener listener)
Subscribe to configuration changes for a particular Service Instance.
|
void |
registerTenant(oracle.security.opss.runtime.TenantInfo tenantInfo, java.util.List<ServiceInstanceDescriptor> tenantConfig, java.util.List<ServiceInstanceDescriptor> tenantBootstrapConfig)
Register a new tenant with the Configuration Service.
|
void |
unregisterTenant(oracle.security.opss.runtime.TenantInfo tenantInfo)
Unregister a tenant.
|
postStart, preStart, restart, start, stop, terminate
getState
accept, getName, getServiceProvider
persist, refresh
ConfigurationService.SERVICE_MODE getMode()
ConfigurationService getConfiguredConfigurationService(javax.security.auth.callback.CallbackHandler cbh) throws ConfigurationException
ConfigurationException
- if there was an error in fetching the configurationjava.util.List<ServiceProviderDescriptor> getServiceProviders()
ConfigurationRuntimeException
- if there was an error in fetching the configurationContextConfiguration getDefaultBootstrapConfiguration()
ConfigurationRuntimeException
- if there was an error in fetching the configurationContextConfiguration getDefaultConfiguration()
ConfigurationRuntimeException
- if there was an error in fetching the configurationContextConfiguration getContextConfiguration(java.lang.String contextId)
contextId
- the JpsContextId for which the Configuration is desiredConfigurationRuntimeException
- if there was an error in fetching the configurationvoid registerTenant(oracle.security.opss.runtime.TenantInfo tenantInfo, java.util.List<ServiceInstanceDescriptor> tenantConfig, java.util.List<ServiceInstanceDescriptor> tenantBootstrapConfig) throws ConfigurationException
tenantId
- the tenant ID of a tenanttenantConfig
- the tenant services configurationtenantBootstrapConfig
- the bootstrap configuration for the tenant.TenantRegistrationException
- if a tenant with the tenantId is already registeredAccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeConfigurationException
- if there was an error in fetching the configurationvoid unregisterTenant(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
- the tenant identifierTenantRegistrationException
- if a tenant with the tenantId is not registeredAccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenantActivationException
- if the tenant with the tenantId is active.ConfigurationException
- if there was an error in fetching the configurationboolean isTenantRegistered(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
-ConfigurationException
- if there is an error in fetching the configurationAccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modevoid activateTenant(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
- the tenant id.AccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenantRegistrationException
- if a tenant with the tenantId is not registered.TenantActivationException
- if a tenant with the tenantId is already active.ConfigurationException
- if there was an error in fetching the configurationvoid deactivateTenant(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
- the tenant id.AccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenant
- RegistrationException if a tenant with the tenantId is not registered.TenantActivationException
- if a tenant with the tenantId not active.ConfigurationException
- if there was an error in fetching the configurationboolean isTenantActivated(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
-AccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenantRegistrationException
- if a tenant with the tenantId is not registered.ConfigurationException
- if there was an error in fetching the configurationjava.util.List<java.lang.String> getTenants() throws ConfigurationException
AccessControlException
- if the code does not have permission to invoke this operation.IllegalServiceModeException
- if the Configuration Service is not in MULTITEANT mode.ConfigurationRuntimeException
- if there was an error in fetching the configuration.ConfigurationException
ContextConfiguration getTenantConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
- the ID of the tenant whose configuration is desired.AccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenantRegistrationException
- if a tenant with the tenantId is not registered.TenantActivationException
- if a tenant with the tenentId is not active.ConfigurationException
- if there was an error in fetching the configurationContextConfiguration getTenantBootstrapConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo) throws ConfigurationException
tenantId
- the ID of the tenant whose configuration is desired.ConfigurationRuntimeException
- if there was an error in fetching the configurationAccessControlException
- if the code does not have permission to invoke this operationIllegalServiceModeException
- if the Configuration Service is not in MULTITEANT modeTenantRegistrationException
- if a tenant with the tenantId is not registered.TenantActivationException
- if a tenant with the tenentId is not active.ConfigurationException
- if there was an error in fetching the configurationvoid listenToConfigChanges(oracle.security.opss.runtime.TenantInfo tenantInfo, java.lang.String serviceInstanceName, ServiceConfigChangeListener listener)
serviceInstanceName
- The name of the ServiceInstance Descriptor for which the listener is to be registered. When null is passed, the listener is registered for all ServiceInstances in the current Context.listener
- the Listener.AccessControlException
- if the code does not have permission to invoke this operationServiceNotIntializedException
- if the Config Service is not initialized (Not Connected to Configuration Repository)RegistrationException
- if a tenant with the tenantId is not registered with the systemvoid listenToConfigChanges(oracle.security.opss.runtime.TenantInfo tenantInfo, ConfigContextChangeListener listener)
listener
- the listener to be notified when there is change in the Configuration of this ContextAccessControlException
- if the code does not have permission to invoke this operationServiceNotIntializedException
- if the Config Service is not initia lized (Not Connected to Configuration Repository)RegistrationException
- if a tenant with the tenantId is not regist ered with the systemvoid addTenantListener(oracle.security.opss.service.config.TenantListener listener)
listener
- the should be notified for tenant registrations and un-registrationsAccessControlException
- if the code does not have permission to invoke this operationServiceNotIntializedException
- if the Config Service is not initia lized (Not Connected to Configuration Repository)RegistrationException
- if a tenant with the tenantId is not regist ered with the systemManagementConfiguration getManagementConfiguration(oracle.security.opss.runtime.TenantInfo tenantInfo)
tenantId
- the tenantIdAccessControlException
- when the code invoking this operation does not have permission.AccessControlException
- if the code does not have permission to invoke this operationServiceNotIntializedException
- if the Config Service is not initia lized (Not Connected to Configuration Repository)RegistrationException
- if a tenant with the tenantId is not regist ered with the systemManagementConfiguration getDefaultManagementConfiguration()
JpsConfiguration getJpsConfiguration()