Skip navigation links

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. 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

void	addConfigListener(ConfigListener listener)
java.util.List<java.lang.String>	getActiveContextConfigurationIds() The information returned by this API should not be cached as the list of active context configurations may change with time.
ContextConfiguration	getContextBootstrapConfiguration(java.lang.String contextId) 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(java.lang.String contextId) 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()
ContextConfiguration	getJpsContextConfiguration(java.lang.String contextId)
java.util.List<ServiceProviderDescriptor>	getServiceProviders() This method gives all OPSS service provider descriptors configured in OPSS configuration repository.
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()

This method gives all OPSS service provider descriptors configured in OPSS configuration repository.

Returns:

the list of OPSS ServiceProvider Descriptors.

Throws:

ConfigurationRuntimeException - if there was an error in fetching the configuration

getContextConfiguration

ContextConfiguration getContextConfiguration(java.lang.String contextId)
                                             throws 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:

contextId - the ContextId or Alias (if the contextId was aliased ConfigurationManagementService.setAlias(String, String)) for which the Configuration is desired

Returns:

The configuration defined for the given context in OPSS configuration repository.

Throws:

ConfigurationException - if there was an error in fetching the configuration or a configuration with the contextID is not registered/ACTIVE

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

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

getContextBootstrapConfiguration

ContextConfiguration getContextBootstrapConfiguration(java.lang.String contextId)
                                                      throws 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:

contextId - the ContextId or Alias (if the contextId was aliased ConfigurationManagementService.setAlias(String, String)) for which the Bootstrap Configuration is desired

Returns:

the bootstrap ContextConfiguration for the contextId.

Throws:

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

ConfigurationException - if there was an error in fetching the configuration or a configuration with the contextID is not registered/ACTIVE

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

getActiveContextConfigurationIds

java.util.List<java.lang.String> getActiveContextConfigurationIds()
                                                                  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 contextId's of Configurations in ACTIVE STATE.

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.

getJpsContextConfiguration

ContextConfiguration getJpsContextConfiguration(java.lang.String contextId)
                                                throws ConfigurationException

Returns:

the Configuration of a jpsContext defined in OOTB jps-config.xml as a ContextConfiguration

Throws:

ConfigurationException - if there was an error in fetching the configuration

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

Skip navigation links