Package com.iplanet.am.sdk

Interface AMObject

    • Field Detail

      • ORGANIZATION

        static final int ORGANIZATION
        Deprecated.
        Represents an Organization object type
        See Also:
        Constant Field Values

      • ORGANIZATIONAL_UNIT

        static final int ORGANIZATIONAL_UNIT
        Deprecated.
        Represents a Organizational Unit object type
        See Also:
        Constant Field Values

      • GROUP_CONTAINER

        static final int GROUP_CONTAINER
        Deprecated.
        Represents a group container object type
        See Also:
        Constant Field Values

      • PEOPLE_CONTAINER

        static final int PEOPLE_CONTAINER
        Deprecated.
        Represents a People Container object type
        See Also:
        Constant Field Values

      • MANAGED_ROLE

        static final int MANAGED_ROLE
        Deprecated.
        Represents a Managed Role object type
        See Also:
        Constant Field Values

      • FILTERED_ROLE

        static final int FILTERED_ROLE
        Deprecated.
        Represents a Filtered Role object type
        See Also:
        Constant Field Values

      • GROUP

        static final int GROUP
        Deprecated.
        Represents a Group object type
        See Also:
        Constant Field Values

      • STATIC_GROUP

        static final int STATIC_GROUP
        Deprecated.
        Represents a Static Group object type
        See Also:
        Constant Field Values

      • DYNAMIC_GROUP

        static final int DYNAMIC_GROUP
        Deprecated.
        Represents a Dynamic Group object type
        See Also:
        Constant Field Values

      • ASSIGNABLE_DYNAMIC_GROUP

        static final int ASSIGNABLE_DYNAMIC_GROUP
        Deprecated.
        Represents a Dynamic Group object type
        See Also:
        Constant Field Values

      • TEMPLATE

        static final int TEMPLATE
        Deprecated.
        Represents a Template object type
        See Also:
        Constant Field Values

      • POLICY

        static final int POLICY
        Deprecated.
        Represents Policy Information
        See Also:
        Constant Field Values

      • SERVICE

        static final int SERVICE
        Deprecated.
        Represents Service Information
        See Also:
        Constant Field Values

      • ROLE_PROFILE

        static final int ROLE_PROFILE
        Deprecated.
        Represents role profile Information
        See Also:
        Constant Field Values

      • GROUP_PROFILE

        static final int GROUP_PROFILE
        Deprecated.
        Represents group profile Information
        See Also:
        Constant Field Values

      • RESOURCE

        static final int RESOURCE
        Deprecated.
        Represents resource object type
        See Also:
        Constant Field Values

      • ACTIVE

        static final int ACTIVE
        Deprecated.
        Represents the status of an object as active
        See Also:
        Constant Field Values

      • ACTIVE_VALUE

        static final String ACTIVE_VALUE
        Deprecated.
        String representation of the "active" state
        See Also:
        Constant Field Values

      • INACTIVE

        static final int INACTIVE
        Deprecated.
        Represents the status of an object as inactive
        See Also:
        Constant Field Values

      • INACTIVE_VALUE

        static final String INACTIVE_VALUE
        Deprecated.
        String representation of the "inactive" state
        See Also:
        Constant Field Values

      • DELETED

        static final int DELETED
        Deprecated.
        Represents the status of an object as "deleted"
        See Also:
        Constant Field Values

      • DELETED_VALUE

        static final String DELETED_VALUE
        Deprecated.
        String representation of the "deleted" state
        See Also:
        Constant Field Values

      • UNKNOWN_OBJECT_TYPE

        static final int UNKNOWN_OBJECT_TYPE
        Deprecated.
        Represents an object type that cannot be identified
        See Also:
        Constant Field Values

      • UNDETERMINED_OBJECT_TYPE

        static final int UNDETERMINED_OBJECT_TYPE
        Deprecated.
        Used to indicate the object type has not yet determined. Mainly used in caching. Local to this package
        See Also:
        Constant Field Values

    • Method Detail

      • getDN

        String getDN()
        Deprecated.
        Returns the DN of the entry.
        Returns:
        String DN

      • getParentDN

        String getParentDN()
        Deprecated.
        Returns the parent DN of the entry.
        Returns:
        String DN

      • store

        void store()
    throws AMException,
           SSOException
        Deprecated.
        Stores the change to directory server. This method should be called after doing setAttributes so that the changes that are made can be permanently committed to the LDAP data store.
        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.

      • store

        void store​(boolean addValues)
    throws AMException,
           SSOException
        Deprecated.
        Stores the change to directory server. This method should be called after doing setAttributes or any other set methods provided. so that the changes that are made can be permanently committed to the LDAP data store.
        Parameters:
        addValues - If addValues is true, then the attribute values as set in the setAttributes method are added to any existing values for the same attribute in the directory. Otherwise, the attribute values replace existing values in the data store.
        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.

      • isExists

        boolean isExists()
          throws SSOException
        Deprecated.
        Checks if the entry exists in the directory or not. First a syntax check is done on the DN string corresponding to the entry. If the DN syntax is valid, a directory call will be made to check for the existence of the entry.

        NOTE: This method internally invokes a call to the directory to verify the existence of the entry. There could be a performance overhead. Hence, please use your discretion while using this method.

        Returns:
        false if the entry does not have a valid DN syntax or if the entry does not exists in the Directory. False otherwise.
        Throws:
        SSOException - if the single sign on token is no longer valid.

      • getAttributes

        Map getAttributes()
           throws AMException,
                  SSOException
        Deprecated.
        Returns Map of all attributes. Map key is the attribute name and value is the attribute value.
        Returns:
        Map of all attributes.
        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.

      • getAttributesFromDataStore

        Map getAttributesFromDataStore()
                        throws AMException,
                               SSOException
        Deprecated.
        Returns Map of all attributes directly from data store. Map key is the attribute name and value is the attribute value.
        Returns:
        Map of all attributes.
        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.

      • getAttributesByteArray

        Map getAttributesByteArray()
                    throws AMException,
                           SSOException
        Deprecated.
        Returns Map of all attributes. Map key is the attribute name and value is the attribute value in byte[][] format.
        Returns:
        Map of all attributes.
        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.

      • getAttributes

        Map getAttributes​(Set attributeNames)
           throws AMException,
                  SSOException
        Deprecated.
        Returns Map of specified attributes. Map key is the attribute name and value is the attribute value.
        Parameters:
        attributeNames - The Set of attribute names.
        Returns:
        Map of specified attributes.
        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.

      • getAttributesFromDataStore

        Map getAttributesFromDataStore​(Set attributeNames)
                        throws AMException,
                               SSOException
        Deprecated.
        Returns Map of specified attributes directly from data store. Map key is the attribute name and value is the attribute value.
        Parameters:
        attributeNames - The Set of attribute names.
        Returns:
        Map of specified attributes.
        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.

      • getAttributesByteArray

        Map getAttributesByteArray​(Set attributeNames)
                    throws AMException,
                           SSOException
        Deprecated.
        Returns Map of specified attributes. Map key is the attribute name and value is the attribute value in byte[][] format.
        Parameters:
        attributeNames - The Set of attribute names.
        Returns:
        Map of specified attributes. The key of the map is the attribute name and the values in byte[][] format.
        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.

      • getAttribute

        Set getAttribute​(String attributeName)
          throws AMException,
                 SSOException
        Deprecated.
        Returns attribute value.
        Parameters:
        attributeName - Attribute name
        Returns:
        Set of attribute values.
        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.

      • getAttributeByteArray

        byte[][] getAttributeByteArray​(String attributeName)
                        throws AMException,
                               SSOException
        Deprecated.
        Returns attribute value.
        Parameters:
        attributeName - Attribute name
        Returns:
        attribute values in byte[][] format or null if the attribute does not exist.
        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.

      • getStringAttribute

        String getStringAttribute​(String attributeName)
                   throws AMException,
                          SSOException
        Deprecated.
        Returns string type attribute value.
        Parameters:
        attributeName - Attribute name
        Returns:
        String value of attribute
        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.

      • getServiceAttributes

        Map getServiceAttributes​(String serviceName)
                  throws AMException,
                         SSOException
        Deprecated.
        This method has been deprecated. Please use service template objects to obtain service attributes.
        Returns Map of all attributes of specified service. Map key is the attribute name and value is the attribute value.
        Parameters:
        serviceName - Service name
        Returns:
        Map of all attributes of specified service, an empty Map will be returned if no service attribute is defined in the specified service.
        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.
        See Also:
        getTemplate(java.lang.String, int)

      • assignPolicies

        void assignPolicies​(String serviceName,
                    Set policyDNs)
             throws AMException,
                    SSOException
        Deprecated.
        This method has been deprecated. Please use: com.sun.identity.policy package for creating and managing policies.
        Assigns the given policies to this object.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string
        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.

      • unassignPolicies

        void unassignPolicies​(String serviceName,
                      Set policyDNs)
               throws AMException,
                      SSOException
        Deprecated.
        This method has been deprecated. Please use: com.sun.identity.policy package for creating and managing policies.
        Unassigns the given policies from this object.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string
        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.

      • setAttributeByteArray

        void setAttributeByteArray​(String attrName,
                           byte[][] byteValues)
                    throws AMException,
                           SSOException
        Deprecated.
        Sets byte attribute values in this AMObject. Note that this method sets or replaces the attribute value with the new value supplied. Also, the attributes changed by this method are not committed to the LDAP data store unless the method store() is called explicitly.
        Parameters:
        attrName - the attribute name
        byteValues - attribute values in byte[][] format
        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.

      • setAttributesByteArray

        void setAttributesByteArray​(Map attributes)
                     throws AMException,
                            SSOException
        Deprecated.
        Sets byte attribute values in this AMObject. Note that this method sets or replaces the attribute value with the new value supplied. Also, the attributes changed by this method are not committed to the LDAP data store unless the method store() is called explicitly.
        Parameters:
        attributes - Map where key is the attribute name and values are in byte[][] format.
        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.

      • setAttributes

        void setAttributes​(Map attributes)
            throws AMException,
                   SSOException
        Deprecated.
        Sets attribute values in this AMObject. Note that this method sets or replaces the attribute value with the new value supplied. Also, the attributes changed by this method are not committed to the LDAP data store unless the method store() is called explicitly.
        Parameters:
        attributes - Map where key is the attribute name and value is a Set of attribute values. Each of the attribute value must be a string value.
        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.

      • removeAttributes

        void removeAttributes​(Set attributes)
               throws AMException,
                      SSOException
        Deprecated.
        Removes attributes in this AMObject. The attributes are removed from the LDAP data store
        Parameters:
        attributes - The Set of attribute 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.

      • setStringAttribute

        void setStringAttribute​(String attributeName,
                        String value)
                 throws AMException,
                        SSOException
        Deprecated.
        Sets string type attribute value.
        Parameters:
        attributeName - attribute name
        value - value to be set for the attribute 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.

      • delete

        void delete​(boolean recursive)
     throws AMException,
            SSOException
        Deprecated.
        Deletes object(s). This method takes a boolean parameter, if its value is true, will remove the object and any objects under it, otherwise, will try to remove the object only. Two notes on recursive delete. First, be aware of the PERFORMANCE hit when large amount of child objects present. In the soft-delete mode, this method will mark the following objects for deletion: Organization, Group, User purge() should be used to physically delete this object.
        Parameters:
        recursive - if true delete the object and any objects under it, otherwise, delete the object only.
        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.
        See Also:
        purge(boolean, int)

      • search

        Set search​(int level,
           String filter)
    throws AMException,
           SSOException
        Deprecated.
        Search objects based on specified level and filter.
        Parameters:
        level - The search level starting from the object
        filter - The search filter
        Returns:
        Set of object DN's matching the search
        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.

      • addEventListener

        void addEventListener​(AMEventListener listener)
               throws SSOException
        Deprecated.
        Registers a event listener that needs to be invoked when a relevant event occurs. If the listener was already registered, then it is registered only once; no duplicate registration is allowed.

        Object.equals() method on the listener object is used to determine duplicates.

        Parameters:
        listener - listener object that will be called upon when an event occurs.
        Throws:
        SSOException - if errors were encountered in adding a new SSOTokenListener instance

      • removeEventListener

        void removeEventListener​(AMEventListener listener)
        Deprecated.
        Unregisters a previously registered event listener. If the listener was not registered previously, the method simply returns without doing anything.
        Parameters:
        listener - listener object that will be removed or unregistered.

      • createPolicyTemplate

        AMTemplate createPolicyTemplate​(String serviceName,
                                Map attributes)
                         throws UnsupportedOperationException,
                                AMException,
                                SSOException
        Deprecated.
        use com.sun.identity.policy package for creating and managing policies.
        Creates a Policy Template with no priority for the given service associated with this AMObject. This is a convenience method and is equivalent to createTemplate( AMTemplate.POLICY_TEMPLATE, serviceName, attributes).
        Parameters:
        serviceName - service name.
        attributes - Map of attributes name-value pairs.
        Returns:
        AMTemplate the service template for this AMObject.
        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.
        UnsupportedOperationException - if the class implementing this interface does not support this method.

      • createPolicyTemplate

        AMTemplate createPolicyTemplate​(String serviceName,
                                Map attributes,
                                int priority)
                         throws UnsupportedOperationException,
                                AMException,
                                SSOException
        Deprecated.
        use com.sun.identity.policy package for creating and managing policies.
        Creates a Policy Template with a priority for the given service associated with this AMObject. This is a convenience method and is equivalent to createTemplate(AMTemplate.POLICY_TEMPLATE, serviceName, attributes, priority).
        Parameters:
        serviceName - service name.
        attributes - Map of attributes name-value pairs.
        priority - template priority (0 is the highest priority).
        Returns:
        AMTemplate the service template for this AMObject.
        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.
        UnsupportedOperationException - if the class implementing this interface does not support this method.

      • getPolicyTemplate

        AMTemplate getPolicyTemplate​(String serviceName)
                      throws UnsupportedOperationException,
                             AMException,
                             SSOException
        Deprecated.
        This method has been deprecated. Please use: com.sun.identity.policy package for creating and managing policies.
        Returns the policy template for a service defined for this object ignoring any inheritance. This is a convenience method and is equivalent to getTemplate(serviceName, AMTemplate.POLICY_TEMPLATE). AMUser object will throw UnsupportedOperationException because this method is not relevant for AMUser.
        Parameters:
        serviceName - service name.
        Returns:
        AMTemplate the policy template of the service for this object.
        Throws:
        UnsupportedOperationException - if the class implementing this interface does not support this method.
        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

      • getPolicy

        Map getPolicy​(String serviceName)
       throws UnsupportedOperationException,
              AMException,
              SSOException
        Deprecated.
        This method has been deprecated. Please use: com.sun.identity.policy package for creating and managing policies.
        Returns the effective service policy defined at this object after considering any inheritance from any policy templates.
        Parameters:
        serviceName - service name.
        Returns:
        Map the effective service policy for the object after inheritance; key is the attribute name and value is attribute value. An empty Map will be returned if no policy attribute is defined in the specified service.
        Throws:
        UnsupportedOperationException - if the class implementing this interface does not support this method
        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

      • getOrganizationDN

        String getOrganizationDN()
                  throws AMException,
                         SSOException
        Deprecated.
        Returns the object's organization. NOTE: Obtaining an organization DN involves considerable overhead. Hence after obtaining the organization DN, each object saves this information. Consecutives method calls on this object fetch the value stored in the object. Creating a new AMObject instance every time to obtain the organization DN is not recommended.
        Returns:
        The object's organization DN.
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store or the object does not have organization DN.
        SSOException - if the single sign on token is no longer valid.

      • assignServices

        void assignServices​(Map serviceNameAndAttrs)
             throws AMException,
                    SSOException
        Deprecated.
        Assign services to the entity (user/group/organization/organization unit). Also sets the attributes as provided in the map serviceNameAndAttrs. serviceNameAndAttrs is a map of keys which are service names and values which are attribute-value maps. Attribute values are validated against the respective service schemas before being set. Any required attributes (as defined in the service schema) not provided in the attribute Map, will be included and set to default values (picked up from the service schema). Only services which have been registered with the parent organization of the entity (the organization itself, in case the entity is an organization) will be assigned to the entity. So before assigning a service to an entity, registerService() should be used on the parent organization.
        Parameters:
        serviceNameAndAttrs - Map of Service name with Map of Attribute-Value pairs
        Throws:
        AMException - if an error is encounters when trying to access/retrieve data from the data store
        SSOException - if the token is no longer valid
        See Also:
        AMOrganization.registerService(java.lang.String, boolean, boolean)

      • modifyService

        void modifyService​(String serviceName,
                   Map attrMap)
            throws AMException,
                   SSOException
        Deprecated.
        Modify the service attributes of a service assigned to a entity (user/group/organization/organizational unit). It replaces existing service attribute values with the ones provided. If new attribute values are provided, those are set too. Values of the attribute are validated against the service schema. Before the values are replaced in the entry, the ServiceCallback classes, if any, are instantiated and the validateAttribute() method is called.
        Parameters:
        serviceName - Name of the service which has to be modified
        attrMap - Map of attribute names and set of attribute values.
        Throws:
        AMException - if an error occurs during validation or storing
        SSOException - if the single sign on token is no longer valid.

      • setServiceStatus

        void setServiceStatus​(String serviceName,
                      String status)
               throws AMException,
                      SSOException
        Deprecated.
        Set the status of the service for this entity (User/Organization /Group/Organizational Unit). The valid values for the status attribute are defined in the SMS DTD. Before the status attribute is set, it is verified to see if the service is first assigned to the user or not, and that the value for the status is valid per the DTD.
        Parameters:
        serviceName - Name of service whose status attribute has to be changed
        status - One of the status values as defined in the service schema
        Throws:
        AMException - if a data store exception is encountered.
        SSOException - if the single sign on token is no longer valid.

      • getServiceStatus

        String getServiceStatus​(String serviceName)
                 throws AMException,
                        SSOException
        Deprecated.
        Get the status of the service for this entity (user/group/organization/ organizational unit). Returns null, if service is not assigned to the entity.
        Parameters:
        serviceName - Name of service
        Returns:
        status Value of the status attribute
        Throws:
        AMException - if a data store exception is encountered
        SSOException - if single sign on token is no longer valid.

      • unassignServices

        void unassignServices​(Set serviceNames)
               throws AMException,
                      SSOException
        Deprecated.
        Unassigns services from the user/group/organization/ organizational unit.
        Parameters:
        serviceNames - Set of service names
        Throws:
        AMException - if there is an internal error in the access management data store.
        SSOException - if the single sign on token is no longer valid

      • getAssignedServices

        Set getAssignedServices()
                 throws AMException,
                        SSOException
        Deprecated.
        Returns all service names that are assigned to the user/group/organization/organizational unit.
        Returns:
        The Set of service names that are assigned to the user.
        Throws:
        AMException - if there is an internal error in the access management data store.
        SSOException - if the single sign on token is no longer valid

      • purge

        void purge​(boolean recursive,
           int graceperiod)
    throws AMException,
           SSOException
        Deprecated.
        This method will physically delete the entry from the data store. This method will override the soft-delete option, which the method delete() will not. There is a big PERFORMANCE hit if this method is used to delete a large Organization in the recursive mode.
        Parameters:
        recursive - If true, then recursively delete the whole subtree.
        graceperiod - If set to an integer greater than -1, it will verify if the object was last modified at least that many days ago before physically deleting it. Pre/Post Callback plugins as registered in the Administration Service, will be called upon object deletion. If any of the pre-callback classes throw an exception, then the operation is aborted.
        Throws:
        AMException - if there is an internal error in the access management data store.
        SSOException - if the single sign on token is no longer valid
        See Also:
        delete()