Package com.iplanet.am.sdk

Interface AMTemplate

  • All Superinterfaces:
    AMConstants, AMObject
    public interface AMTemplate
extends AMObject
    Deprecated.
    As of Sun Java System Access Manager 7.1.
    Represents a service template associated with a AMObject. Sun Java System Access Manager distinguishes between virtual and entry attibutes. Per iDS terminology, virtual attribute is an attribute that is not physically stored in an LDAP entry but still returned with the LDAP entry as a result of a LDAP search operation. Virtual attributes are analagous to the "inherited" attributes. Entry attributes are non-inherited attributes. For each AMObject, virtual attributes can be grouped in a Template on a per-service basis. Hence, there may be one service Template per service for any given AMObject. A given object may have more than one Template, in total, one each for each of the services for that object. Such templates determine the service attributes inherited by all the other objects within the scope of this object.

    When any object inherits more than one template for the same service (by virtue of being in the scope of two or more objects with service templates), conflicts between such templates are resolved by the use of template priorities. In this priority scheme, zero is the highest possible priority with the lower priorities extending towards finity. Templates with higher priorities will be favored over and to the exclusion of templates with lower priorities. Templates which do not have an explicitly assigned priority are considered to have the lowest priority possible, or no priority. In the case where two or more templates are being considered for inheritance of an attribute value, and they have the same (or no) priority, the result is undefined, but does not exclude the possibility that a value will be returned, however arbitrarily chosen.

    The two types of templates supported in Identity Management are: Organization templates and Dynamic templates. Organizatin templates manage service attributes of services that are registered to an organization, while dynamic templates manage service attributes for both organizations and roles.

    Note: Policy templates are no longer supported by AM SDK. Use com.sun.identity.policy package to manage policy attributes. 

     
 Code sample on how to obtain service templates from AMOrganization object:
 
 AMTemplate orgTemplate; if (org.orgTemplateExists("iPlanetAMAuthService") {
 orgTemplate = org.getTemplate("iPlanetAMAuthService",
 AMTemplate.ORGANIZATION_TEMPLATE); Map attributes =
 orgTemplate.getAttributes(); - more code here - }
 
 
 AMTemplate dynTemplate = org.getTemplate("iPlanetAMSessionService",
 AMTemplates.DYNAMIC_TEMPLATE); if (dynTemplate.isExists()) { Map attributes =
 dynTemplate.getAttributes(); - more code here - }

    • Field Detail

      • POLICY_TEMPLATE

        static final int POLICY_TEMPLATE
        Deprecated.
        Represents a Policy template type
        See Also:
        Constant Field Values

      • DYNAMIC_TEMPLATE

        static final int DYNAMIC_TEMPLATE
        Deprecated.
        Represents the Dynamic template type
        See Also:
        Constant Field Values

      • ORGANIZATION_TEMPLATE

        static final int ORGANIZATION_TEMPLATE
        Deprecated.
        Represents an Organization template type
        See Also:
        Constant Field Values

      • ALL_TEMPLATES

        static final int ALL_TEMPLATES
        Deprecated.
        Represents both dynamic and policy template for a service
        See Also:
        Constant Field Values

      • UNDEFINED_PRIORITY

        static final int UNDEFINED_PRIORITY
        Deprecated.
        Represents the priority of a template whose priority is not explicitly set.
        See Also:
        Constant Field Values

    • Method Detail

      • getServiceName

        String getServiceName()
        Deprecated.
        Gets the name of the service to which this template belongs. This method can be used in conjunction with SMS APIs to get the AttributeSchema/ServiceSchema for the service.
        Returns:
        service name.

      • getAttributeSchemas

        Set getAttributeSchemas()
                 throws AMException,
                        SSOException
        Deprecated.
        Returns a set of Attribute Schemas that defines the schema (metadata) of this template.
        Returns:
        Set of com.sun.identity.sm.AttributeSchema for this template.
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store.
        SSOException - if the single sign on token is no longer valid.

      • getPriority

        int getPriority()
         throws SSOException
        Deprecated.
        Returns the priority of this template in the DIT.
        Returns:
        priority.
        Throws:
        SSOException - if the single sign on token is no longer valid.

      • setPriority

        void setPriority​(int priority)
          throws AMException,
                 SSOException
        Deprecated.
        Sets the priority of this template in the DIT
        Parameters:
        priority - priority
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store.
        SSOException - if the single sign on token is no longer valid.

      • getType

        int getType()
        Deprecated.
        Gets the type of the template.
        Returns:
        Returns one of the following possible values:
        • DYNAMIC_TEMPLATE
        • ORGANIZATION_TEMPLATE

      • getPolicyNames

        Set getPolicyNames()
            throws AMException,
                   SSOException
        Deprecated.
        Returns a set of policy distinguished names if this AMTemplate is a named policy template, otherwise returns null.
        Returns:
        set of policy distinguished names.
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store.
        SSOException - if the single sign on token is no longer valid.