Package com.sun.identity.sm

Class ServiceInstance

java.lang.Object
com.sun.identity.sm.ServiceInstance
@SupportedAll public class ServiceInstance extends Object
The class ServiceInstance provides methods to manage service's instance variables.

  • Method Details

    • 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<String,Set<String>> 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(org.forgerock.openam.sm.ConfigurationAttributes 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<String> 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<String> 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<String> oldValues, Set<String> 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