|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.sm.ServiceConfigManager
The class ServiceConfigurationManager
provides interfaces
to manage the service's configuration data. It provides access to
ServiceConfig
which represents a single "configuration"
in the service. It manages configuration data only for GLOBAL
and ORGANIZATION types.
Constructor Summary | |
ServiceConfigManager(SSOToken token,
java.lang.String serviceName,
java.lang.String version)
Creates an instance of ServiceConfigManager for the
given service and version. |
Method Summary | |
void |
addConfiguration(java.io.InputStream in)
Adds instances, global and organization configurations |
java.lang.String |
addListener(ServiceListener listener)
Registers for changes to service's configuration. |
ServiceConfig |
createGlobalConfig(java.util.Map attrs)
Creates global configuration for the default instance of the service given the configuration attributes. |
ServiceConfig |
createOrganizationConfig(java.lang.String orgName,
java.util.Map attrs)
Creates organization configuration for the default instance of the service given configuration attributes. |
void |
deleteOrganizationConfig(java.lang.String orgName)
Deletes the organization configuration data for the given organization. |
boolean |
equals(java.lang.Object o)
Compares this object with the given object. |
ServiceConfig |
getGlobalConfig(java.lang.String instanceName)
Returns the global configuration for the given service instance. |
java.util.Set |
getGroupNames()
Returns the configuration group names |
ServiceInstance |
getInstance(java.lang.String instanceName)
Returns the service instance given the instance name |
java.util.Set |
getInstanceNames()
Returns the service instance names |
java.lang.String |
getName()
Returns the name of the service. |
ServiceConfig |
getOrganizationConfig(java.lang.String orgName,
java.lang.String instanceName)
Returns the organization configuration for the given organization and instance name. |
java.lang.String |
getVersion()
Returns the service version. |
void |
removeGlobalConfiguration(java.lang.String groupName)
Deletes the global configuration data for the given group name. |
void |
removeInstance(java.lang.String instanceName)
Removes the instance form the service |
void |
removeListener(java.lang.String listenerID)
Removes the listener from the service for the given listener ID. |
void |
removeOrganizationConfiguration(java.lang.String orgName,
java.lang.String groupName)
Deletes the organization's group configuration data. |
java.lang.String |
toString()
Returns String representation of the service's configuration data, along with instances and groups. |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ServiceConfigManager(SSOToken token, java.lang.String serviceName, java.lang.String version) throws SMSException, SSOException
ServiceConfigManager
for the
given service and version. It requires an user identity, that
will used to perform operations with. It is assumed that
the application calling this constructor should authenticate
the user.
token
- single sign on token of the user identity on whose
behalf the operations are performed.serviceName
- the name of the serviceversion
- the version of the service
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredMethod Detail |
public java.lang.String getName()
public java.lang.String getVersion()
public java.util.Set getInstanceNames() throws SMSException
SMSException
- if an error has occurred while performing the operationpublic java.util.Set getGroupNames() throws SMSException
SMSException
- if an error has occurred while performing the operationpublic ServiceInstance getInstance(java.lang.String instanceName) throws SMSException, SSOException
instanceName
- the name of the service instance
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic void removeInstance(java.lang.String instanceName) throws SMSException, SSOException
instanceName
- the service instance name
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic ServiceConfig getGlobalConfig(java.lang.String instanceName) throws SMSException, SSOException
instanceName
- the service instance name
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic ServiceConfig getOrganizationConfig(java.lang.String orgName, java.lang.String instanceName) throws SMSException, SSOException
orgName
- the name of the organizationinstanceName
- the service configuration instance name
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic ServiceConfig createGlobalConfig(java.util.Map attrs) throws SMSException, SSOException
attrs
- map of attribute values.
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic ServiceConfig createOrganizationConfig(java.lang.String orgName, java.util.Map attrs) throws SMSException, SSOException
orgName
- name of organization.attrs
- map of attribute values.
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic void addConfiguration(java.io.InputStream in) throws SMSException, SSOException
in
- input stream of configuration data.
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic void removeGlobalConfiguration(java.lang.String groupName) throws SMSException, SSOException
null
, it used the default group name.
groupName
- name of group.
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic void deleteOrganizationConfig(java.lang.String orgName) throws SMSException, SSOException
orgName
- name of organization.
SMSException
- if an error has occurred while performing the operation
SSOException
- if the user's single sign on token is invalid or expiredpublic void removeOrganizationConfiguration(java.lang.String orgName, java.lang.String groupName) throws SMSException, SSOException
orgName
- name of organization.groupName
- name of group.
SMSException
- if an error has occurred while performing the
operation
SSOException
- if the user's single sign on token is invalid
or expiredpublic java.lang.String addListener(ServiceListener listener)
listener
- callback object that will be invoked when schema changes.
public void removeListener(java.lang.String listenerID)
listenerID
- the listener ID issued when the
listener was registeredpublic boolean equals(java.lang.Object o)
o
- object for comparison.
public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |