oracle.security.opss.service.config

Interface RuntimeConfigurationService

All Superinterfaces:

JpsPersistable, OpssServiceInstance, ServiceInstance, ServiceLifecycle

public interface RuntimeConfigurationService
extends ServiceLifecycle, OpssServiceInstance

A Service that provides the OPSS Runtime with a view of the Configuration for any named active context. The view provided is a ReadOnly View. The Runtime uses the supplied configuration to instantiate a ServiceContext containing independent services initialized from the configuration. The RuntimeConfigurationService can be queried for configurations stored in in the Configuration Repository or the OOTB jps-config.xml. The methods in this service accept a contextName to identify the context. The contextName is the name set for a ContextConfiguration in the Configuration Repository (via ConfigurationManagementService#setContextName() method), or the "name" attribute of a jpsContext defined in OOTB/specified jps-config.xml Listeners can be registered with the Service which would be notified when there is a change in an active configuration or when an active configuration is deactivated.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.security.opss.service.OpssServiceInstance

OpssServiceInstance.State

Nested classes/interfaces inherited from interface oracle.security.jps.service.JpsPersistable

JpsPersistable.Mode

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfigListener(ConfigListener listener)
java.util.List<java.lang.String>	getActiveContextConfigurationNames() The information returned by this API should not be cached as the list of active context configurations may change with time.
ContextConfiguration	getContextBootstrapConfiguration(ContextNameEncoder contextNameEncoder) The Runtime Bootstrap Configuration View is generally a Normalized ReadOnly view of the persistence layer bootstrap configuration and is primarily intended to be used by the OPSS Runtime.
ContextConfiguration	getContextConfiguration(ContextNameEncoder contextNameEncoder) The Runtime Configuration view is generally a Normalized ReadOnly view of the persistence layer configuration and is primarily intended to be used by the OPSS Runtime.
ContextConfiguration	getDefaultBootstrapConfiguration()
ContextConfiguration	getDefaultConfiguration()
JpsConfiguration	getJpsConfiguration()
java.util.List<ServiceProviderDescriptor>	getServiceProviders()
void	removeConfigListener(ConfigListener listener)

Methods inherited from interface oracle.security.opss.service.ServiceLifecycle

postStart, preStart, restart, start, stop, terminate

Methods inherited from interface oracle.security.opss.service.OpssServiceInstance

getState

Methods inherited from interface oracle.security.jps.service.ServiceInstance

accept, getName, getServiceProvider

Methods inherited from interface oracle.security.jps.service.JpsPersistable

persist, refresh

Method Detail

getServiceProviders

java.util.List<ServiceProviderDescriptor> getServiceProviders()

Returns:

the list of OPSS ServiceProvider Descriptors.

Throws:

ConfigurationRuntimeException - if there was an error in fetching the configuration

getContextConfiguration

ContextConfiguration getContextConfiguration(ContextNameEncoder contextNameEncoder)
                                             throws RegistrationException,
                                                    ConfigurationException

The Runtime Configuration view is generally a Normalized ReadOnly view of the persistence layer configuration and is primarily intended to be used by the OPSS Runtime.

Parameters:

contextNameEncoder - Encoder instance that returns the encoded name of the context for which configuration is desired. desired

Returns:

The configuration defined for the given context in OPSS configuration repository or the OOTB jps-config.xml

Throws:

ConfigurationException - if there was an error in fetching the configuration or the configuration is not in ACTIVE state

RegistrationException - if a configuration with the contextName is not registered

AccessControlException - if the code does not have permission to invoke this operation

java.lang.IllegalArgumentException - if the contextName was supplied as null;

getContextBootstrapConfiguration

ContextConfiguration getContextBootstrapConfiguration(ContextNameEncoder contextNameEncoder)
                                                      throws RegistrationException,
                                                             ConfigurationException

The Runtime Bootstrap Configuration View is generally a Normalized ReadOnly view of the persistence layer bootstrap configuration and is primarily intended to be used by the OPSS Runtime.

Parameters:

contextNameEncoder - Encoder instance that returns the encoded name of the context for which configuration is des ired.

Returns:

The bootstrap configuration identified by the given context in OPSS configuration repository or the OOTB jps-config.xml

Throws:

AccessControlException - if the code does not have permission to invoke this operation

ConfigurationException - if there was an error in fetching the configuration or the configuration is not in ACTIVE state

RegistrationException - if a configuration with the contextName is not registered

java.lang.IllegalArgumentException - if the contextName was supplied as null

getActiveContextConfigurationNames

java.util.List<java.lang.String> getActiveContextConfigurationNames()
                                                                    throws ConfigurationException

The information returned by this API should not be cached as the list of active context configurations may change with time.

Returns:

returns a list of context names of Configurations in ACTIVE STATE. Configurations defined in the OOTB jps-config.xml are considered as implicitly ACTIVE.

Throws:

AccessControlException - if the code does not have permission to invoke this operation.

ConfigurationException - if there was an error in fetching the list of active configurations.

getJpsConfiguration

JpsConfiguration getJpsConfiguration()

Returns:

JpsConfiguration for the OOTB jps-config.xml or the jps-config.xml supplied to the RuntimeConfigurationServiceProvider.getConfigurationService() method.

addConfigListener

void addConfigListener(ConfigListener listener)
                       throws ConfigurationException

Parameters:

listener - the listener to be notified for config ACTIVATION, DEACTIVATION and CHANGE events

Throws:

AccessControlException - if the code does not have permission to invoke this operation

ConfigurationException - if there was an error in registering the listener

java.lang.IllegalArgumentException - if the listener was supplied as null;

removeConfigListener

void removeConfigListener(ConfigListener listener)
                          throws ConfigurationException

Parameters:

listener - the listener to be removed from the notification service

Throws:

ConfigurationException - if there was an error in un-registering the listener or if the listener was not registered.

getDefaultBootstrapConfiguration

ContextConfiguration getDefaultBootstrapConfiguration()

Returns:

the default Bootstrap Configuration as defined in the jps-config.xml supplied to the provider.

Throws:

ConfigurationRuntimeException - if there was an error in fetching the configuration

getDefaultConfiguration

ContextConfiguration getDefaultConfiguration()

Returns:

the default Runtime Configuration as defined in the jps-config.xml supplied to the provider.

Throws:

ConfigurationRuntimeException - if there was an error in fetching the configuration