|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.sm.ServiceInstance
The class ServiceInstance
provides methods to
manage service's instance variables.
Method Summary | |
void |
addAttribute(java.lang.String attrName,
java.util.Set values)
Adds the given attribute name and values to the attribute set. |
java.util.Map |
getAttributes()
Returns the attributes that are associated with the service's instances. |
java.lang.String |
getGroup()
Returns the group name from which the configuration parameters for the instance must be obtained. |
java.lang.String |
getName()
Returns the instance name. |
java.lang.String |
getServiceName()
Returns the service name. |
java.lang.String |
getURI()
Returns the URL of the service. |
java.lang.String |
getVersion()
Returns the service version. |
void |
removeAttribute(java.lang.String attrName)
Removes the specified attribute name and its values from the attribute set. |
void |
removeAttributeValues(java.lang.String attrName,
java.util.Set values)
Removes the specified attribute's values. |
void |
replaceAttributeValue(java.lang.String attrName,
java.lang.String oldValue,
java.lang.String newValue)
Replaces the attribute's old value with the new value. |
void |
replaceAttributeValues(java.lang.String attrName,
java.util.Set oldValues,
java.util.Set newValues)
Replaces the attribute's old values with the new values |
void |
setAttributes(java.util.Map attrs)
Sets the attributes that are specific to the service instance. |
void |
setGroup(java.lang.String groupName)
Sets the group name for this instance. |
void |
setURI(java.lang.String uri)
Sets the URI for the service instance. |
java.lang.String |
toString()
Returns the String representation of the ServiceInstance
object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String getName()
public java.lang.String getServiceName()
public java.lang.String getVersion()
public java.lang.String getGroup()
public void setGroup(java.lang.String groupName) throws SSOException, SMSException
groupName
- name of group.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic java.lang.String getURI()
null
if the service
does not have an URI.null
if the service
does not have an URI.public void setURI(java.lang.String uri) throws SSOException, SMSException
uri
- URI of the service instance.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic java.lang.String toString()
ServiceInstance
object.toString
in class java.lang.Object
ServiceInstance
object.public java.util.Map getAttributes()
public void setAttributes(java.util.Map attrs) throws SSOException, SMSException
attrs
- map of attribute name to values.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic void addAttribute(java.lang.String attrName, java.util.Set values) throws SSOException, SMSException
attrName
- name of attribute.values
- values to be added.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic void removeAttribute(java.lang.String attrName) throws SSOException, SMSException
attrName
- name of attribute.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic void removeAttributeValues(java.lang.String attrName, java.util.Set values) throws SSOException, SMSException
attrName
- name of attribute.values
- values to be removed.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic void replaceAttributeValue(java.lang.String attrName, java.lang.String oldValue, java.lang.String newValue) throws SSOException, SMSException
attrName
- name of attribute.oldValue
- old value.newValue
- new value.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operationpublic void replaceAttributeValues(java.lang.String attrName, java.util.Set oldValues, java.util.Set newValues) throws SSOException, SMSException
attrName
- name of attribute.oldValues
- old values.newValues
- new values.SSOException
- if the user's single sign on token is invalid or expiredSMSException
- if an error occurred while performing the operation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |