com.sun.identity.sm

Class PluginConfig

java.lang.Object

com.sun.identity.sm.PluginConfig

public class PluginConfig
extends Object

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PluginConfig(String name, ServiceConfigManager scm, com.sun.identity.sm.PluginConfigImpl pc) Protected constructor

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String attrName, Set values) Adds a configuration parameter to the service plugin.
Map	getAttributes() Returns the service plugin parameters.
String	getDN() Returns the LDAP DN represented by this plugin object.
String	getName() Returns the name of this service plugin.
int	getPriority() Returns the priority assigned to the service plugin.
String	getServiceName() Returns the name of this service configuration.
String	getVersion() Returns the service version
void	removeAttribute(String attrName) Removes a configuration parameter from the service plugin.
void	removeAttributeValues(String attrName, Set values) Removes the specific values for the given configuration plugin.
void	replaceAttributeValue(String attrName, String oldValue, String newValue) Replaces old value of the configuration parameter with new value.
void	replaceAttributeValues(String attrName, Set oldValues, Set newValues) Replaces the old values of the configuration parameter with the new values.
void	setAttributes(Map attrs) Sets the service plugin parameters.
void	setPriority(int priority) Sets the priority to the service plugin.
String	toString() Returns String representation of the plugin object.
protected void	validate()
protected void	validatePluginConfig()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginConfig

protected PluginConfig(String name,
                       ServiceConfigManager scm,
                       com.sun.identity.sm.PluginConfigImpl pc)
                throws SMSException,
                       SSOException

Protected constructor

Throws:

SMSException

SSOException

Method Detail

getName

public String getName()

Returns the name of this service plugin.

Returns:

the name of this service plugin

getServiceName

public String getServiceName()

Returns the name of this service configuration.

Returns:

the name of this service configuration

getVersion

public String getVersion()

Returns the service version

Returns:

service version

getPriority

public int getPriority()

Returns the priority assigned to the service plugin.

Returns:

the priority assigned to the service plugin

setPriority

public void setPriority(int priority)
                 throws SSOException,
                        SMSException

Sets the priority to the service plugin.

Parameters:

priority - the priority to be assigned to the plugin

Throws:

SSOException

SMSException

getAttributes

public Map getAttributes()

Returns the service plugin 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(Map attrs)
                   throws SMSException,
                          SSOException

Sets the service plugin 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.

Parameters:

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

Throws:

SMSException

SSOException

addAttribute

public void addAttribute(String attrName,
                         Set values)
                  throws SMSException,
                         SSOException

Adds a configuration parameter to the service plugin.

Parameters:

attrName - the name of the attribute to add

values - the set of values to add

Throws:

SMSException

SSOException

removeAttribute

public void removeAttribute(String attrName)
                     throws SMSException,
                            SSOException

Removes a configuration parameter from the service plugin.

Parameters:

attrName - the name of the attribute to remove

Throws:

SMSException

SSOException

removeAttributeValues

public void removeAttributeValues(String attrName,
                                  Set values)
                           throws SMSException,
                                  SSOException

Removes the specific values for the given configuration plugin.

Parameters:

attrName - the name of the attribute

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

Throws:

SMSException

SSOException

replaceAttributeValue

public void replaceAttributeValue(String attrName,
                                  String oldValue,
                                  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

SSOException

replaceAttributeValues

public void replaceAttributeValues(String attrName,
                                   Set oldValues,
                                   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

SSOException

getDN

public String getDN()

Returns the LDAP DN represented by this plugin object.

toString

public String toString()

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

Overrides:

toString in class Object

validate

protected void validate()

validatePluginConfig

protected void validatePluginConfig()
                             throws SMSException

Throws:

SMSException