|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationInstance
ConfigurationInstance
is the interface that provides the
operations on service configuration.
Method Summary | |
---|---|
String |
addListener(ConfigurationListener listener)
Registers for changes to the component's configuration. |
void |
createConfiguration(String realm,
String configName,
Map avPairs)
Creates Configurations. |
void |
deleteConfiguration(String realm,
String configName,
Set attributes)
Deletes Configuration. |
Set |
getAllConfigurationNames(String realm)
Returns all service configuration name for this components. |
Map |
getConfiguration(String realm,
String configName)
Returns Configurations. |
void |
init(String componentName,
Object session)
Initializer. |
void |
removeListener(String listenerID)
Unregisters the listener from the component for the given listener ID. |
void |
setConfiguration(String realm,
String configName,
Map avPairs)
Sets Configurations. |
Method Detail |
---|
void init(String componentName, Object session) throws ConfigurationException
componentName
- Name of the components, e.g. SAML1, SAML2, ID-FFsession
- FM Session object.
ConfigurationException
- if could not initialize the instance.Map getConfiguration(String realm, String configName) throws ConfigurationException
realm
- the name of organization at which the configuration resides.configName
- configuration instance name. e.g. "/sp".
The configName could be null or empty string, which means the default
configuration for this components.
ConfigurationException
- if an error occurred while getting
service configuration.void setConfiguration(String realm, String configName, Map avPairs) throws ConfigurationException
realm
- the name of organization at which the configuration resides.configName
- configuration instance name. e.g. "/sp"
The configName could be null or empty string, which means the default
configuration for this components.avPairs
- Map of key/value pairs to be set in the service
configuration, key is the attribute name, value is
a Set of attribute values.
ConfigurationException
- if could not set service configuration
or service configuration doesn't exist.
UnsupportedOperationException
- if this operation is not
supported by the implementation.void createConfiguration(String realm, String configName, Map avPairs) throws ConfigurationException
realm
- the name of organization at which the configuration resides.configName
- service configuration name. e.g. "/sp"
The configName could be null or empty string, which means the
default configuration for this components.avPairs
- Map of key/value pairs to be set in the service
configuration, key is the attribute name, value is
a Set of attribute values.
ConfigurationException
- if could not create service
configuration.
UnsupportedOperationException
- if this operation is not
supported by the implementation.void deleteConfiguration(String realm, String configName, Set attributes) throws ConfigurationException
realm
- the name of organization at which the configuration resides.configName
- service configuration name. e.g. "/sp"
The configName could be null or empty string, which means the default
configuration for this components.attributes
- A set of attributes to be deleted from the Service
configuration. If the value is null or empty, deletes all service
configuration.
ConfigurationException
- if could not delete service
configuration.
UnsupportedOperationException
- if this operation is not
supported by the implementation.Set getAllConfigurationNames(String realm) throws ConfigurationException
realm
- the name of organization at which the configuration resides.
ConfigurationException
- if could not get all service
configuration names.
UnsupportedOperationException
- if this operation is not
supported by the implementation.String addListener(ConfigurationListener listener) throws ConfigurationException
ConfigurationException
- if could not register the listener.
UnsupportedOperationException
- if this operation is not
supported by the implementation.void removeListener(String listenerID) throws ConfigurationException
listenerID
- the returned id when the listener was registered.
ConfigurationException
- if could not register the listener.
UnsupportedOperationException
- if this operation is not
supported by the implementation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |