Package com.sun.identity.sm

Class ServiceInstance

java.lang.Object

com.sun.identity.sm.ServiceInstance

public class ServiceInstance
extends Object

The class ServiceInstance provides methods to manage service's instance variables.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String attrName, Set values)	Adds the given attribute name and values to the attribute set.
Map	getAttributes()	Returns the attributes that are associated with the service's instances.
String	getGroup()	Returns the group name from which the configuration parameters for the instance must be obtained.
String	getName()	Returns the instance name.
String	getServiceName()	Returns the service name.
String	getURI()	Returns the URL of the service.
String	getVersion()	Returns the service version.
void	removeAttribute(String attrName)	Removes the specified attribute name and its values from the attribute set.
void	removeAttributeValues(String attrName, Set values)	Removes the specified attribute's values.
void	replaceAttributeValue(String attrName, String oldValue, String newValue)	Replaces the attribute's old value with the new value.
void	replaceAttributeValues(String attrName, Set oldValues, Set newValues)	Replaces the attribute's old values with the new values
void	setAttributes(Map attrs)	Sets the attributes that are specific to the service instance.
void	setGroup(String groupName)	Sets the group name for this instance.
void	setURI(String uri)	Sets the URI for the service instance.
String	toString()	Returns the String representation of the ServiceInstance object.
String	toXML()
protected void	validate()
protected void	validateServiceInstance()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the instance name.

Returns:

the instance name.

getServiceName

public String getServiceName()

Returns the service name.

Returns:

the service name.

getVersion

public String getVersion()

Returns the service version.

Returns:

the service version.

getGroup

public String getGroup()

Returns the group name from which the configuration parameters for the instance must be obtained.

Returns:

the group name from which the configuration parameters for the instance must be obtained.

setGroup

public void setGroup(String groupName)
              throws SSOException,
                     SMSException

Sets the group name for this instance.

Parameters:

groupName - name of group.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

getURI

public String getURI()

Returns the URL of the service. Will be null if the service does not have an URI.

Returns:

the URL of the service. Will be null if the service does not have an URI.

setURI

public void setURI(String uri)
            throws SSOException,
                   SMSException

Sets the URI for the service instance.

Parameters:

uri - URI of the service instance.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

toString

public String toString()

Returns the String representation of the ServiceInstance object.

Overrides:

toString in class Object

Returns:

the String representation of the ServiceInstance object.

getAttributes

public Map getAttributes()

Returns the attributes that are associated with the service's instances.

Returns:

the attributes that are associated with the service's instances.

setAttributes

public void setAttributes(Map attrs)
                   throws SSOException,
                          SMSException

Sets the attributes that are specific to the service instance. It is up to the service developer to define the set of attributes and values

Parameters:

attrs - map of attribute name to values.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

addAttribute

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

Adds the given attribute name and values to the attribute set.

Parameters:

attrName - name of attribute.

values - values to be added.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

removeAttribute

public void removeAttribute(String attrName)
                     throws SSOException,
                            SMSException

Removes the specified attribute name and its values from the attribute set.

Parameters:

attrName - name of attribute.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

removeAttributeValues

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

Removes the specified attribute's values.

Parameters:

attrName - name of attribute.

values - values to be removed.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

replaceAttributeValue

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

Replaces the attribute's old value with the new value.

Parameters:

attrName - name of attribute.

oldValue - old value.

newValue - new value.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

replaceAttributeValues

public void replaceAttributeValues(String attrName,
                                   Set oldValues,
                                   Set newValues)
                            throws SSOException,
                                   SMSException

Replaces the attribute's old values with the new values

Parameters:

attrName - name of attribute.

oldValues - old values.

newValues - new values.

Throws:

SSOException - if the user's single sign on token is invalid or expired

SMSException - if an error occurred while performing the operation

toXML

public String toXML()

validate

protected void validate()

validateServiceInstance

protected void validateServiceInstance()
                                throws SMSException

Throws:

SMSException