com.sun.identity.sm
Class ServiceConfig

java.lang.Object
  |
  +--com.sun.identity.sm.ServiceConfig

public class ServiceConfig

extends java.lang.Object

The class ServiceConfig provides interfaces to manage the configuration information of a service configuration. It provides methods to get and set configuration parameters for this service configuration.

Method Summary

void	addAttribute(java.lang.String attrName, java.util.Set values) Adds a configuration parameter to the service configuration.
void	addSubConfig(java.lang.String subConfigName, java.lang.String subConfigId, int priority, java.util.Map attrs) Adds a service sub-configuration with configuration parameters.
java.util.Map	getAttributes() Returns the service configuration parameters.
java.lang.String	getComponentName() Returns the service component name.
java.lang.String	getDN() Returns the LDAP DN represented by this ServiceConfig object.
int	getPriority() Returns the priority assigned to the service configuration.
java.lang.String	getServiceName() Returns the name of this service configuration.
ServiceConfig	getSubConfig(java.lang.String subConfigName) Returns the service's sub-configuration given the service's sub-configuration name.
java.util.Set	getSubConfigNames() Returns the names of all service's sub-configurations.
java.util.Set	getSubConfigNames(java.lang.String pattern) Method to get names of service's sub-configurations that match the given pattern.
java.lang.String	getVersion() Returns the service version
void	removeAttribute(java.lang.String attrName) Removes a configuration parameter from the service configuration.
void	removeAttributeValues(java.lang.String attrName, java.util.Set values) Removes the specific values for the given configuration parameter.
void	removeSubConfig(java.lang.String subConfigName) Removes the service sub-configuration.
void	replaceAttributeValue(java.lang.String attrName, java.lang.String oldValue, java.lang.String newValue) Replaces old value of the configuration parameter with new value.
void	replaceAttributeValues(java.lang.String attrName, java.util.Set oldValues, java.util.Set newValues) Replaces the old values of the configuration parameter with the new values.
void	setAttributes(java.util.Map attrs) Sets the service configuration parameters.
void	setPriority(int priority) Sets the priority to the service configuration.
java.lang.String	toString() Returns String representation of the ServiceConfig object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getServiceName

public java.lang.String getServiceName()

Returns the name of this service configuration.

Returns:

the name of this service configuration

getVersion

public java.lang.String getVersion()

Returns the service version

Returns:

service version

getComponentName

public java.lang.String getComponentName()

Returns the service component name. It is "/" seperated and the root component name is "/".

Returns:

service component name

getPriority

public int getPriority()

Returns the priority assigned to the service configuration.

Returns:

the priority assigned to the service configuration

setPriority

public void setPriority(int priority)
                 throws SSOException,
                        SMSException

Sets the priority to the service configuration.

Parameters:

priority - the priority to be assigned to the configuration

getSubConfigNames

public java.util.Set getSubConfigNames()
                                throws SMSException

Returns the names of all service's sub-configurations.

Returns:

set of names of all service's sub-configurations

Throws:

SMSException -

getSubConfigNames

public java.util.Set getSubConfigNames(java.lang.String pattern)
                                throws SMSException

Method to get names of service's sub-configurations that match the given pattern.

Parameters:

pattern - pattern to match for sub-configuration names

Returns:

names of the service sub-configuration

Throws:

SMSException - If an error occured while performing the operation.

getSubConfig

public ServiceConfig getSubConfig(java.lang.String subConfigName)
                           throws SSOException,
                                  SMSException

Returns the service's sub-configuration given the service's sub-configuration name.

Parameters:

subConfigName - The name of the service's sub-configuration to retrieve

Returns:

The ServiceConfig object corresponding to the specified name of the service's sub-config

Throws:

SMSException -

addSubConfig

public void addSubConfig(java.lang.String subConfigName,
                         java.lang.String subConfigId,
                         int priority,
                         java.util.Map attrs)
                  throws SMSException,
                         SSOException

Adds a service sub-configuration with configuration parameters.

Parameters:

subConfigName - the name of service sub-configuration to add

subConfigId - type of service sub-configuration

priority - the priority of the configuration

attrs - configuration parameters for the sub-configuration

Throws:

SMSException -

removeSubConfig

public void removeSubConfig(java.lang.String subConfigName)
                     throws SMSException,
                            SSOException

Removes the service sub-configuration.

Parameters:

subConfigName - name of service sub-configuration to remove

Throws:

SMSException -

getAttributes

public java.util.Map getAttributes()

Returns the service configuration parameters. The keys in the Map contains the attribute names and their corresponding values in the Map is a Set that contains the values for the attribute.

Returns:

the Map where key is the attribute name and value is the Set of attribute values

setAttributes

public void setAttributes(java.util.Map attrs)
                   throws SMSException,
                          SSOException

Sets the service configuration parameters. The keys in the Map contains the attribute names and their corresponding values in the Map is a Set that contains the values for the attribute. This method will replace the existing attribute values with the given one. For attributes that are not specified in attrs, it will not be modified.

Parameters:

attrs - the Map where key is the attribute name and value is the Set of attribute values

Throws:

SMSException -

addAttribute

public void addAttribute(java.lang.String attrName,
                         java.util.Set values)
                  throws SMSException,
                         SSOException

Adds a configuration parameter to the service configuration.

Parameters:

attrName - the name of the attribute to add

values - the set of values to add

Throws:

SMSException -

removeAttribute

public void removeAttribute(java.lang.String attrName)
                     throws SMSException,
                            SSOException

Removes a configuration parameter from the service configuration.

Parameters:

attrName - the name of the attribute to remove

Throws:

SMSException -

removeAttributeValues

public void removeAttributeValues(java.lang.String attrName,
                                  java.util.Set values)
                           throws SMSException,
                                  SSOException

Removes the specific values for the given configuration parameter.

Parameters:

attrName - the name of the attribute

values - set of attribute values to remove from the given attribute

Throws:

SMSException -

replaceAttributeValue

public void replaceAttributeValue(java.lang.String attrName,
                                  java.lang.String oldValue,
                                  java.lang.String newValue)
                           throws SMSException,
                                  SSOException

Replaces old value of the configuration parameter with new value.

Parameters:

attrName - the name of the attribute

oldValue - the old value to remove from the attribute

newValue - the new value to add to the attribute

Throws:

SMSException -

replaceAttributeValues

public void replaceAttributeValues(java.lang.String attrName,
                                   java.util.Set oldValues,
                                   java.util.Set newValues)
                            throws SMSException,
                                   SSOException

Replaces the old values of the configuration parameter with the new values.

Parameters:

attrName - the name of the attribute

oldValues - the set of old values to remove from the attribute

newValues - the set of new values to add to the attribute

Throws:

SMSException -

getDN

public java.lang.String getDN()

Returns the LDAP DN represented by this ServiceConfig object.

toString

public java.lang.String toString()

Returns String representation of the ServiceConfig object. It returns attributes defined and sub configurations.

Overrides:

toString in class java.lang.Object