Package com.iplanet.am.sdk

Interface AMOrganization

  • All Superinterfaces:
    AMConstants, AMObject
    public interface AMOrganization
extends AMObject
    Deprecated.
    As of Sun Java System Access Manager 7.1.
    This interface provides methods to manage organization. AMOrganization objects can be obtained by using AMStoreConnection. A handle to this object can be obtained by using the DN of the object. 
     
 AMStoreConnection amsc = new AMStoreConnection(ssotoken); 
 if (amsc.doesEntryExist(oDN)) { 
     AMOrganization org = amsc.getOrganization(oDN); 
 }

    • Method Detail

      • createSubOrganizations

        Set createSubOrganizations​(Set subOrganizations)
                    throws AMException,
                           SSOException
        Deprecated.
        Creates sub-organizations.
        Parameters:
        subOrganizations - The set of sub-organizations names to be created.
        Returns:
        Set set of sub Organization objects created.
        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

      • createSubOrganizations

        Set createSubOrganizations​(Map subOrganizations)
                    throws AMException,
                           SSOException
        Deprecated.
        Creates sub-organizations and initializes their attributes.
        Parameters:
        subOrganizations - Map where the key is the name of the sub organization, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        Set set of sub Organization objects created.
        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.

      • createOrganization

        String createOrganization​(String orgName,
                          String domainName,
                          Map attrMap,
                          Map serviceNamesAndAttrs)
                   throws AMException,
                          SSOException
        Deprecated.
        Creates sub-organizations and initializes their attributes. Initializes service objectclasses and attributes as provided in the serviceNameAndAttrs map.
        Parameters:
        orgName - name of organization to be created under this organization.
        domainName - name of the domain ( example sun.com, iplanet.com).
        attrMap - Map of attribute-value pairs to be set on the entry.
        serviceNamesAndAttrs - Map of service names and attribute-values for that service to be set in the organization entry. serviceNameAndAttrs has service names keys and map of attribute-values (values are in a Set).
        Returns:
        DN of organization created.
        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.

      • deleteSubOrganizations

        void deleteSubOrganizations​(Set subOrganizations)
                     throws AMException,
                            SSOException
        Deprecated.
        Deletes sub organizations.
        Parameters:
        subOrganizations - The set of sub organization DNs to be deleted.
        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

      • getSubOrganization

        AMOrganization getSubOrganization​(String dn)
                           throws AMException,
                                  SSOException
        Deprecated.
        Returns the sub-organization by DN
        Parameters:
        dn - distinguished name.
        Returns:
        The sub Organization object
        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

      • getSubOrganizations

        Set getSubOrganizations​(int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Gets the sub organizations within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Set of sub organizations DNs within the specified level.
        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

      • getNumberOfSubOrganizations

        long getNumberOfSubOrganizations​(int level)
                          throws AMException,
                                 SSOException
        Deprecated.
        Gets number of sub organizations within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of sub organizations within the specified level.
        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

      • searchSubOrganizations

        Set searchSubOrganizations​(String wildcard,
                           int level)
                    throws AMException,
                           SSOException
        Deprecated.
        Searches for sub organizations in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of Sub Organizations 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

      • searchSubOrganizations

        AMSearchResults searchSubOrganizations​(String wildcard,
                                       AMSearchControl searchControl)
                                throws AMException,
                                       SSOException
        Deprecated.
        Searches for sub organizations in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of sub Organizations 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.

      • searchSubOrganizations

        Set searchSubOrganizations​(String wildcard,
                           Map avPairs,
                           int level)
                    throws AMException,
                           SSOException
        Deprecated.
        Searches for sub organizations in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of sub organizations with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching sub organizations
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of sub organizations 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

      • searchSubOrganizations

        AMSearchResults searchSubOrganizations​(String wildcard,
                                       Map avPairs,
                                       AMSearchControl searchControl)
                                throws AMException,
                                       SSOException
        Deprecated.
        Searches for sub organizations in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of sub organizations with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching sub organizations.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a Set of DNs of sub organizations 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.

      • createOrganizationalUnits

        Set createOrganizationalUnits​(Set organizationalUnits)
                       throws AMException,
                              SSOException
        Deprecated.
        Creates organizational units.
        Parameters:
        organizationalUnits - The set of organizational units names to be created.
        Returns:
        set of sub OrganizationalUnit objects created.
        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.

      • createOrganizationalUnits

        Set createOrganizationalUnits​(Map organizationalUnits)
                       throws AMException,
                              SSOException
        Deprecated.
        Creates organizational units and initializes their attributes.
        Parameters:
        organizationalUnits - Map where the key is the name of the organizational unit, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        Set set of OrganizationalUnit objects created.
        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

      • deleteOrganizationalUnits

        void deleteOrganizationalUnits​(Set organizationalUnits)
                        throws AMException,
                               SSOException
        Deprecated.
        Deletes organizational units
        Parameters:
        organizationalUnits - The set of organizational units DNs to be deleted.
        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.

      • getOrganizationalUnit

        AMOrganizationalUnit getOrganizationalUnit​(String dn)
                                    throws AMException,
                                           SSOException
        Deprecated.
        Gets the organizational unit by DN.
        Parameters:
        dn - distinguished name.
        Returns:
        The OrganizationalUnit object
        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

      • getOrganizationalUnits

        Set getOrganizationalUnits​(int level)
                    throws AMException,
                           SSOException
        Deprecated.
        Gets the organizational units within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        The Set of organizational units DNs within the specified level.
        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

      • getNumberOfOrganizationalUnits

        long getNumberOfOrganizationalUnits​(int level)
                             throws AMException,
                                    SSOException
        Deprecated.
        Gets number of organizational units within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of organizational units within the specified level.
        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

      • searchOrganizationalUnits

        Set searchOrganizationalUnits​(String wildcard,
                              int level)
                       throws AMException,
                              SSOException
        Deprecated.
        Searches for organizational units in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of organizational units 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

      • searchOrganizationalUnits

        AMSearchResults searchOrganizationalUnits​(String wildcard,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException
        Deprecated.
        Searches for organizational units in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains a set of DNs of organizational units 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

      • searchOrganizationalUnits

        Set searchOrganizationalUnits​(String wildcard,
                              Map avPairs,
                              int level)
                       throws AMException,
                              SSOException
        Deprecated.
        Searches for organizational units in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of organizational units with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching organizational units
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of organizational units 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

      • searchOrganizationalUnits

        AMSearchResults searchOrganizationalUnits​(String wildcard,
                                          Map avPairs,
                                          AMSearchControl searchControl)
                                   throws AMException,
                                          SSOException
        Deprecated.
        Searches for organizational units in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of organizational units with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching organizational units
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains a Set of DNs of organizational units 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

      • createRoles

        Set createRoles​(Set roles)
         throws AMException,
                SSOException
        Deprecated.
        Creates roles.
        Parameters:
        roles - The set of Roles' names to be created.
        Returns:
        Set set of Role objects created.
        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

      • createRoles

        Set createRoles​(Map roles)
         throws AMException,
                SSOException
        Deprecated.
        Creates roles.
        Parameters:
        roles - Map where the key is the name of the role, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        Set set of Role objects created.
        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

      • deleteRoles

        void deleteRoles​(Set roles)
          throws AMException,
                 SSOException
        Deprecated.
        Deletes roles.
        Parameters:
        roles - The set of roles' DNs to be deleted.
        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

      • getRoles

        Set getRoles​(int level)
      throws AMException,
             SSOException
        Deprecated.
        Gets the roles within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        The Set of Roles' DNs within the specified level.
        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

      • getNumberOfRoles

        long getNumberOfRoles​(int level)
               throws AMException,
                      SSOException
        Deprecated.
        Gets number of roles within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of roles within the specified level.
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store
        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

      • searchRoles

        Set searchRoles​(String wildcard,
                int level)
         throws AMException,
                SSOException
        Deprecated.
        Searches for roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of roles 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

      • searchRoles

        AMSearchResults searchRoles​(String wildcard,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of roles 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

      • searchRoles

        Set searchRoles​(String wildcard,
                Map avPairs,
                int level)
         throws AMException,
                SSOException
        Deprecated.
        Searches for roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching roles
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of roles 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

      • searchRoles

        AMSearchResults searchRoles​(String wildcard,
                            Map avPairs,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching roles
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains a set of DNs of roles 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

      • createFilteredRoles

        Set createFilteredRoles​(Set roles)
                 throws AMException,
                        SSOException
        Deprecated.
        Creates filtered roles.
        Parameters:
        roles - The set of filtered roles' names to be created.
        Returns:
        Set set of FilteredRole objects created.
        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.

      • createFilteredRoles

        Set createFilteredRoles​(Map roles)
                 throws AMException,
                        SSOException
        Deprecated.
        Creates filtered roles.
        Parameters:
        roles - Map where the key is the name of the filtered role, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        set of FilteredRole objects created.
        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.

      • deleteFilteredRoles

        void deleteFilteredRoles​(Set roles)
                  throws AMException,
                         SSOException
        Deprecated.
        Deletes filtered roles.
        Parameters:
        roles - The set of filtered roles' DNs to be deleted.
        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

      • getFilteredRoles

        Set getFilteredRoles​(int level)
              throws AMException,
                     SSOException
        Deprecated.
        Gets the filtered roles within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        The Set of filtered roles' DNs within the specified level.
        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

      • getNumberOfFilteredRoles

        long getNumberOfFilteredRoles​(int level)
                       throws AMException,
                              SSOException
        Deprecated.
        Gets number of filtered roles within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of filtered roles within the specified level.
        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

      • searchFilteredRoles

        Set searchFilteredRoles​(String wildcard,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for filtered roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of filtered roles 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

      • searchFilteredRoles

        AMSearchResults searchFilteredRoles​(String wildcard,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for filtered roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of filtered roles 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.

      • searchFilteredRoles

        Set searchFilteredRoles​(String wildcard,
                        Map avPairs,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for filtered roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of filtered roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching filtered roles
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of filtered roles 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

      • searchFilteredRoles

        AMSearchResults searchFilteredRoles​(String wildcard,
                                    Map avPairs,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for filtered roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of filtered roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching filtered roles.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of filtered roles 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.

      • searchAllRoles

        Set searchAllRoles​(String wildcard,
                   int level)
            throws AMException,
                   SSOException
        Deprecated.
        Searches for all roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set of DNs of all roles 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

      • searchAllRoles

        AMSearchResults searchAllRoles​(String wildcard,
                               AMSearchControl searchControl)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for all roles in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a Set of DNs of all roles 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.

      • searchAllRoles

        Set searchAllRoles​(String wildcard,
                   Map avPairs,
                   int level)
            throws AMException,
                   SSOException
        Deprecated.
        Searches for all roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of all roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching all roles
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set of DNs of all roles 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

      • searchAllRoles

        AMSearchResults searchAllRoles​(String wildcard,
                               Map avPairs,
                               AMSearchControl searchControl)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for all roles in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of all roles with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching all roles
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of all roles 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.

      • createAssignableDynamicGroups

        Set createAssignableDynamicGroups​(Set assignableDynamicGroups)
                           throws AMException,
                                  SSOException
        Deprecated.
        Creates assignable dynamic groups.
        Parameters:
        assignableDynamicGroups - The set of assignable dynamic groups's names to be created.
        Returns:
        set of AssignableDynamicGroup objects created.
        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.

      • createAssignableDynamicGroup

        AMGroup createAssignableDynamicGroup​(String name,
                                     Map attributes,
                                     Map serviceNameAndAttrs)
                              throws AMException,
                                     SSOException
        Deprecated.
        Creates assignable dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.
        Parameters:
        name - of group to be created
        attributes - attribute-value pairs to be set
        serviceNameAndAttrs - service name and attribute map where the map is like this: <serviceName><AttrMap> (attrMap=<attrName><Set of attrvalues>)
        Returns:
        AMGroup object of newly created group.
        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

      • deleteAssignableDynamicGroups

        void deleteAssignableDynamicGroups​(Set assignableDynamicGroups)
                            throws AMException,
                                   SSOException
        Deprecated.
        Deletes assignable dynamic groups.
        Parameters:
        assignableDynamicGroups - The set of assignable dynamic groups's DNs to be deleted.
        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

      • getAssignableDynamicGroups

        Set getAssignableDynamicGroups​(int level)
                        throws AMException,
                               SSOException
        Deprecated.
        Returns the assignable dynamic groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Set of DNs of AssignableDynamicGroups within the specified level.
        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

      • getNumberOfAssignableDynamicGroups

        long getNumberOfAssignableDynamicGroups​(int level)
                                 throws AMException,
                                        SSOException
        Deprecated.
        Gets number of assignable dynamic groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of assignable dynamic groups within the specified level.
        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

      • searchAssignableDynamicGroups

        Set searchAssignableDynamicGroups​(String wildcard,
                                  int level)
                           throws AMException,
                                  SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of assignable dynamic groups 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

      • searchAssignableDynamicGroups

        Set searchAssignableDynamicGroups​(String wildcard,
                                  int level,
                                  String groupSearchTemplate,
                                  Map avPairs)
                           throws AMException,
                                  SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. Otherwise the default search template is used.
        Parameters:
        wildcard - pattern to be used in the search.
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB).
        groupSearchTemplate - name of the search template to be used to perform this search.
        avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.
        Returns:
        Set of DNs of assignable dynamic groups 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.

      • searchAssignableDynamicGroups

        AMSearchResults searchAssignableDynamicGroups​(String wildcard,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of assignable dynamic groups 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.

      • searchAssignableDynamicGroups

        Set searchAssignableDynamicGroups​(String wildcard,
                                  Map avPairs,
                                  int level)
                           throws AMException,
                                  SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching assignable dynamic groups
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of assignable dynamic groups 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

      • searchAssignableDynamicGroups

        AMSearchResults searchAssignableDynamicGroups​(String wildcard,
                                              Map avPairs,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching assignable dynamic groups.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of assignable dynamic groups 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.

      • searchAssignableDynamicGroups

        AMSearchResults searchAssignableDynamicGroups​(String wildcard,
                                              Map avPairs,
                                              String groupSearchTemplate,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching assignable dynamic groups
        groupSearchTemplate - Name of search template to be used to perform
        searchControl - specifies the search scope to be used, VLV ranges etc., the search.
        Returns:
        AMSearchResults which contains a set of DNs of assignable dynamic groups 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.

      • createDynamicGroups

        Set createDynamicGroups​(Map dynamicGroups)
                 throws AMException,
                        SSOException
        Deprecated.
        Creates dynamic groups and initializes their attributes.
        Parameters:
        dynamicGroups - Map where the key is the name of the dynamic group, and the value is a Map to represent Attribute-Value Pairs.
        Returns:
        Set of AMDynamicGroup objects created
        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.

      • createDynamicGroup

        AMGroup createDynamicGroup​(String name,
                           Map attributes,
                           Map serviceNameAndAttrs)
                    throws AMException,
                           SSOException
        Deprecated.
        Creates dynamic group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.
        Parameters:
        name - of group to be created
        attributes - to be set in group
        serviceNameAndAttrs - service name and attribute map where the map is like this: <serviceName><AttrMap> (attrMap=<attrName><Set of attrvalues>)
        Returns:
        AMGroup object of newly created group.
        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.

      • deleteDynamicGroups

        void deleteDynamicGroups​(Set dynamicGroups)
                  throws AMException,
                         SSOException
        Deprecated.
        Deletes dynamic groups.
        Parameters:
        dynamicGroups - The set of dynamic groups's DNs to be deleted.
        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

      • getDynamicGroups

        Set getDynamicGroups​(int level)
              throws AMException,
                     SSOException
        Deprecated.
        Gets the dynamic groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        The Set of DNs of DynamicGroups within the specified level.
        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

      • getNumberOfDynamicGroups

        long getNumberOfDynamicGroups​(int level)
                       throws AMException,
                              SSOException
        Deprecated.
        Gets number of dynamic groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of dynamic groups within the specified level.
        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

      • searchDynamicGroups

        Set searchDynamicGroups​(String wildcard,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of dynamic groups 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

      • searchDynamicGroups

        Set searchDynamicGroups​(String wildcard,
                        int level,
                        String groupSearchTemplate,
                        Map avPairs)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. Otherwise uses the the default GroupSearch template.
        Parameters:
        wildcard - pattern to be used in the search.
        level - the search level that needs to be used.
        groupSearchTemplate - name of the search template to be used to perform this search.
        avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter. (AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        set of DNs of dynamic groups 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.

      • searchDynamicGroups

        AMSearchResults searchDynamicGroups​(String wildcard,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains a set of DNs of dynamic groups 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.

      • searchDynamicGroups

        Set searchDynamicGroups​(String wildcard,
                        Map avPairs,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching dynamic groups
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of dynamic groups 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

      • searchDynamicGroups

        AMSearchResults searchDynamicGroups​(String wildcard,
                                    Map avPairs,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching dynamic groups
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains set a of DNs of dynamic groups 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.

      • searchDynamicGroups

        AMSearchResults searchDynamicGroups​(String wildcard,
                                    Map avPairs,
                                    String groupSearchTemplate,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for dynamic groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of dynamic groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching dynamic groups
        groupSearchTemplate - Name of search template to be used to perform the search.
        searchControl - specifies the search scope to be used
        Returns:
        AMSearchResults which contains a Set of DNs of dynamic groups 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.

      • createStaticGroups

        Set createStaticGroups​(Set groups)
                throws AMException,
                       SSOException
        Deprecated.
        Creates static groups.
        Parameters:
        groups - The set of static groups's names to be created.
        Returns:
        set of AMStaticGroup objects created.
        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.

      • createStaticGroup

        AMGroup createStaticGroup​(String name,
                          Map attributes,
                          Map serviceNameAndAttrs)
                   throws AMException,
                          SSOException
        Deprecated.
        Creates static group. Takes serviceNameAndAttr map so that services can be assigned to the group which is just created.
        Parameters:
        name - of group to be created.
        attributes - to be set in group node.
        serviceNameAndAttrs - service name and attribute map where the map is like this: <serviceName><AttrMap> (attrMap=<attrName><Set of attrvalues>).
        Returns:
        AMGroup object of newly created group.
        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.

      • deleteStaticGroups

        void deleteStaticGroups​(Set groups)
                 throws AMException,
                        SSOException
        Deprecated.
        Deletes static groups.
        Parameters:
        groups - The set of static groups's DNs to be deleted.
        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
        AMException - if an error is encountered when trying to access/retrieve data from the data store.

      • getStaticGroups

        Set getStaticGroups​(int level)
             throws AMException,
                    SSOException
        Deprecated.
        Gets the static groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        The Set of DNs of Groups within the specified level.
        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
        AMException - if an error is encountered when trying to access/retrieve data from the data store.

      • getNumberOfStaticGroups

        long getNumberOfStaticGroups​(int level)
                      throws AMException,
                             SSOException
        Deprecated.
        Gets number of static groups within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of static groups within the specified level.
        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.
        AMException - if an error is encountered when trying to access/retrieve data from the data store.

      • searchStaticGroups

        Set searchStaticGroups​(String wildcard,
                       int level)
                throws AMException,
                       SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of static groups 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

      • searchStaticGroups

        Set searchStaticGroups​(String wildcard,
                       int level,
                       String groupSearchTemplate,
                       Map avPairs)
                throws AMException,
                       SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a. Uses the groupSearchTemplate, if provided. If it is null, default search templates are used.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        groupSearchTemplate - name of the search template to be used to perform this search.
        avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.
        Returns:
        Set Set of DNs of static groups 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

      • searchStaticGroups

        AMSearchResults searchStaticGroups​(String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of static groups 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.

      • searchStaticGroups

        Set searchStaticGroups​(String wildcard,
                       Map avPairs,
                       int level)
                throws AMException,
                       SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching groups
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of static groups 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

      • searchStaticGroups

        AMSearchResults searchStaticGroups​(String wildcard,
                                   Map avPairs,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching groups
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set of DNs of static groups 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.

      • searchStaticGroups

        AMSearchResults searchStaticGroups​(String wildcard,
                                   Map avPairs,
                                   String groupSearchTemplate,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
        Deprecated.
        Searches for static groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of static groups with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching static groups.
        groupSearchTemplate - Name of search template to be used to perform the search.
        searchControl - specifies the search scope to be used.
        Returns:
        AMSearchResults which contains a Set of DNs of static groups 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.

      • searchGroups

        Set searchGroups​(String wildcard,
                 Map avPairs,
                 int level)
          throws AMException,
                 SSOException
        Deprecated.
        Searches for groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching groups
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of groups 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

      • searchGroups

        AMSearchResults searchGroups​(String wildcard,
                             Map avPairs,
                             AMSearchControl searchControl)
                      throws AMException,
                             SSOException
        Deprecated.
        Searches for groups in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching groups.
        searchControl - specifies the search scope to be used.
        Returns:
        AMSearchResults which contains set a of DNs of groups 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.

      • createPeopleContainers

        Set createPeopleContainers​(Set peopleContainers)
                    throws AMException,
                           SSOException
        Deprecated.
        Creates people containers.
        Parameters:
        peopleContainers - The set of people containers' names to be created
        Returns:
        set of PeopleContainer objects created.
        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.

      • createPeopleContainers

        Set createPeopleContainers​(Map peopleContainers)
                    throws AMException,
                           SSOException
        Deprecated.
        Creates people containers and initializes their attributes.
        Parameters:
        peopleContainers - Map where the key is the name of the people container, and the value is a Map to represent attribute-value pairs.
        Returns:
        set of PeopleContainer objects created.
        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.

      • deletePeopleContainers

        void deletePeopleContainers​(Set peopleContainers)
                     throws AMException,
                            SSOException
        Deprecated.
        Deletes people containers.
        Parameters:
        peopleContainers - The set of people containers' DN to be deleted.
        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

      • getPeopleContainers

        Set getPeopleContainers​(int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Gets the people containers within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Set of people containers within the specified level.
        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

      • getNumberOfPeopleContainers

        long getNumberOfPeopleContainers​(int level)
                          throws AMException,
                                 SSOException
        Deprecated.
        Gets number of people containers within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        long Number of people containers within the specified level.
        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

      • searchPeopleContainers

        Set searchPeopleContainers​(String wildcard,
                           int level)
                    throws AMException,
                           SSOException
        Deprecated.
        Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of people containers 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

      • searchPeopleContainers

        AMSearchResults searchPeopleContainers​(String wildcard,
                                       AMSearchControl searchControl)
                                throws AMException,
                                       SSOException
        Deprecated.
        Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set DNs of people containers 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.

      • searchPeopleContainers

        Set searchPeopleContainers​(String wildcard,
                           Map avPairs,
                           int level)
                    throws AMException,
                           SSOException
        Deprecated.
        Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of people containers with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching people containers
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of people containers 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

      • searchPeopleContainers

        AMSearchResults searchPeopleContainers​(String wildcard,
                                       Map avPairs,
                                       AMSearchControl searchControl)
                                throws AMException,
                                       SSOException
        Deprecated.
        Searches for people containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of people containers with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching people containers.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set DNs of people containers 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.

      • createGroupContainers

        Set createGroupContainers​(Set groupContainers)
                   throws AMException,
                          SSOException
        Deprecated.
        Creates group containers.
        Parameters:
        groupContainers - The set of group containers' names to be created.
        Returns:
        set of group container objects created.
        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.

      • createGroupContainers

        Set createGroupContainers​(Map groupContainers)
                   throws AMException,
                          SSOException
        Deprecated.
        Creates group containers and initializes their attributes.
        Parameters:
        groupContainers - Map where the key is the name of the group container, and the value is a Map to represent attribute-value pairs.
        Returns:
        set of group container objects created.
        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.

      • deleteGroupContainers

        void deleteGroupContainers​(Set groupContainers)
                    throws AMException,
                           SSOException
        Deprecated.
        Deletes group containers.
        Parameters:
        groupContainers - The set of group containers' DN to be deleted.
        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

      • getGroupContainers

        Set getGroupContainers​(int level)
                throws AMException,
                       SSOException
        Deprecated.
        Gets the group containers within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        set of group containers within the specified level.
        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

      • getNumberOfGroupContainers

        long getNumberOfGroupContainers​(int level)
                         throws AMException,
                                SSOException
        Deprecated.
        Gets number of group containers within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        long Number of group containers within the specified level.
        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

      • searchGroupContainers

        Set searchGroupContainers​(String wildcard,
                          Map avPairs,
                          int level)
                   throws AMException,
                          SSOException
        Deprecated.
        Searches for group containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of group containers with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching group containers
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of group containers 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

      • searchGroupContainers

        AMSearchResults searchGroupContainers​(String wildcard,
                                      Map avPairs,
                                      AMSearchControl searchControl)
                               throws AMException,
                                      SSOException
        Deprecated.
        Searches for group containers in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of group containers with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching group containers.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set DNs of group containers 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.

      • createUsers

        Set createUsers​(Set users)
         throws AMException,
                SSOException
        Deprecated.
        Creates users in this organization. For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added. If a corresponding template does not exist, the default values are picked up from schema.
        Parameters:
        users - The set of user names to be created in this organization.
        Returns:
        Set Set of User objects created
        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

      • createUsers

        Set createUsers​(Map users)
         throws AMException,
                SSOException
        Deprecated.
        Creates users and initializes their attributes. For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added. If a corresponding template does not exist, the default values are picked up from schema.
        Parameters:
        users - Map where the key is the name of the user, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        Set Set of User objects created
        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

      • createUser

        AMUser createUser​(String uid,
                  Map attrMap,
                  Map serviceNameAndAttrs)
           throws AMException,
                  SSOException
        Deprecated.
        Create user and initializes the attributes. For each user the, object classes specified by organization type attribute iplanet-am-required-services of the service iPlanetAMAdminConsoleService template are added. If a corresponding template does not exist, the default values are picked up from schema. Also services as defined in the arguments, are assigned to the user, with default values being picked up from the service schema if none are provided for required attributes of the service.
        Parameters:
        uid - value of naming attribute for user.
        attrMap - attribute-values to be set in the user entry.
        serviceNameAndAttrs - service names and attributes to be assigned to the user.
        Returns:
        AMUser object of newly created user.
        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

      • deleteUsers

        void deleteUsers​(Set users)
          throws AMException,
                 SSOException
        Deprecated.
        Deletes users from this organization.
        Parameters:
        users - The set of user DN's to be deleted from the organization.
        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.

      • getUserDNs

        Set getUserDNs()
        throws AMException,
               SSOException
        Deprecated.
        Returns the names (DNs) of users in the organization.
        Returns:
        Set The names(DNs) of users in the organization.
        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

      • getUser

        AMUser getUser​(String uid,
               String userSearchTemplate)
        throws AMException,
               SSOException
        Deprecated.
        Returns AMUser object of user in this organization (or in sub organizations), whose naming attribute exactly matches with uid. If userSearchTemplate is not null, then this search template is used otherwise the BasicUserSearchTemplate is used. Any %U in the search filter are replaced with uid. If the search returns more than one user, an exception is thrown because this is a violation of the name space constraint.
        Parameters:
        uid - naming attribute value for user.
        userSearchTemplate - search template.
        Returns:
        AMUser object of user found.
        Throws:
        AMException
        SSOException

      • getNumberOfUsers

        long getNumberOfUsers​(int level)
               throws AMException,
                      SSOException
        Deprecated.
        Gets number of users within the specified level.
        Parameters:
        level - The search level starting from the organization.
        Returns:
        Number of users within the specified level.
        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

      • searchUsers

        Set searchUsers​(String wildcard,
                int level)
         throws AMException,
                SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of Users 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

      • searchUsers

        Set searchUsers​(String wildcard,
                int level,
                String userSearchTemplate,
                Map avPairs)
         throws AMException,
                SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK users the userSearchTemplate, if provided. Otherwise, it uses the BasicUserSearchTemplate. Any %U in the search template are replaced with the wildcard.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        userSearchTemplate - Name of search template to be used. If null is passed then the default search template BasicUserSearch will be used.
        avPairs - This option can be used to further qualify the search filter. The attribute-value pairs provided by this map are appended to the search filter.
        Returns:
        Set DNs of Users 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.

      • searchUsers

        AMSearchResults searchUsers​(String wildcard,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set DNs of users 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.

      • searchUsers

        Set searchUsers​(String wildcard,
                Map avPairs,
                int level)
         throws AMException,
                SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching users
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set DNs of Users 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

      • searchUsers

        AMSearchResults searchUsers​(String wildcard,
                            Map avPairs,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        avPairs - attribute-value pairs to match when searching users.
        searchControl - specifies the search scope to be used, VLV ranges etc.,
        Returns:
        AMSearchResults which contains a set DNs of users 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.

      • searchUsers

        AMSearchResults searchUsers​(String wildcard,
                            Map avPairs,
                            String userSearchTemplate,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search
        avPairs - attribute-value pairs to match when searching users
        userSearchTemplate - Name of user search template to be used.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a set DNs of users 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.

      • searchUsers

        AMSearchResults searchUsers​(String wildcard,
                            AMSearchControl searchControl,
                            String avfilter)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. To further refine the search, attribute-value pairs can be specified so that DNs of users with matching attribute-value pairs will be returned.
        Parameters:
        wildcard - wildcard pattern to be used in the search.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        avfilter - this attribute-value pairs filter will be logical AND with user search filter.
        Returns:
        AMSearchResults which contains a Set DNs of users 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.

      • searchUsers

        AMSearchResults searchUsers​(AMSearchControl searchControl,
                            String avfilter)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organization using attribute values. Wildcards such as can be specified for the attribute values. The DNs of users with matching attribute-value pairs will be returned.
        Parameters:
        searchControl - specifies the search scope to be used, VLV ranges etc.
        avfilter - this attribute-value pairs filter will be logical AND with user search filter.
        Returns:
        AMSearchResults which contains a set of DNs of users matching the search.
        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

      • getNumberOfServices

        long getNumberOfServices()
                  throws AMException,
                         SSOException
        Deprecated.
        Returns the number of services.
        Returns:
        number of services.
        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

      • getRegisteredServiceNames

        Set getRegisteredServiceNames()
                       throws AMException,
                              SSOException
        Deprecated.
        Gets the names of registered services.
        Returns:
        The Set of the names of registered services.
        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

      • registerService

        void registerService​(String serviceName,
                     boolean createTemplate,
                     boolean activate)
              throws AMException,
                     SSOException
        Deprecated.
        Register a service for this organization.
        Parameters:
        serviceName - The name of service to be registered
        createTemplate - true if to create default template
        activate - true if to activate the service
        Throws:
        AMException - if the service does not exist or could not be registered.
        SSOException - if the single sign on token is no longer valid.

      • unregisterService

        void unregisterService​(String serviceName)
                throws AMException,
                       SSOException
        Deprecated.
        Unregisters a service for this organization.
        Parameters:
        serviceName - service name to be unregistered.
        Throws:
        AMException - if the service does not exist or could not be unregistered.
        SSOException - if the single sign on token is no longer valid.

      • unassignAllPolicies

        void unassignAllPolicies​(String serviceName,
                         Set policyDNs)
                  throws AMException,
                         SSOException
        Deprecated.
        Unassigns the given policies from this organization and its roles.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string.
        Throws:
        AMException - if there is an internal problem with access management data store.
        SSOException - if the single sign on token is no longer valid.

      • modifyAllPolicyTemplates

        void modifyAllPolicyTemplates​(String serviceName,
                              Set policyDNs)
                       throws AMException,
                              SSOException
        Deprecated.
        Modifies all the templates under this organization that contain any policyDN in given policyDNs.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string
        Throws:
        AMException - if there is an internal problem with access management data store.
        SSOException - if the single sign on token is no longer valid.

      • deleteAllNamedPolicyTemplates

        boolean deleteAllNamedPolicyTemplates​(String policyDN)
                               throws AMException,
                                      SSOException
        Deprecated.
        Deletes all the named policy templates for this Organization corresponding to the given policy. This includes organizational based and role based policy templates. This is a convenience method.
        Parameters:
        policyDN - a policy DN string
        Returns:
        true if policy templates were found and deleted.
        Throws:
        AMException - if there is an internal problem with access management data store.
        SSOException - if the single sign on token is no longer valid.

      • getAssignedPolicyDNs

        Set getAssignedPolicyDNs()
                  throws AMException,
                         SSOException
        Deprecated.
        Gets all the assigned policies for this Organization
        Returns:
        Set a set of assigned policy DNs
        Throws:
        AMException - if there is an internal problem with access management data store.
        SSOException - if the single sign on token is no longer valid.

      • isPolicyAssigned

        boolean isPolicyAssigned​(String policyDN,
                         String serviceName)
                  throws AMException,
                         SSOException
        Deprecated.
        Returns true if a policyDN is assigned to an organization or a role.
        Parameters:
        policyDN - a policy DN string
        serviceName - service name
        Returns:
        true if policy is assigned to an organization or role.
        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

      • orgTemplateExists

        boolean orgTemplateExists​(String serviceName)
                   throws AMException,
                          SSOException
        Deprecated.
        Returns true if an organizational template exists for the service.
        Parameters:
        serviceName - service name
        Returns:
        true if the organizational template exists.
        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

      • unassignServices

        void unassignServices​(Set serviceNames)
               throws AMException,
                      SSOException
        Deprecated.
        Unassigns services from the organization. Also removes service specific attributes, if defined in the user entry.
        Specified by:
        unassignServices in interface AMObject
        Parameters:
        serviceNames - Set of service 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

      • createEntities

        Set createEntities​(int type,
                   Set entityNames)
            throws AMException,
                   SSOException
        Deprecated.
        This method creates the entities of the given type. The entity is created under a default container, if specified in the DAI service. If the specified default container does not exist, then it is created under the current organization and then the entities are created under it. If no specified container is specified, then the entities are created directly under the organization.
        Parameters:
        type - Type of entity being created. The types supported by SDK are configured in the list of Managed Objects in the DAI service.
        entityNames - Set of names of entities to be created
        Returns:
        Set of AMEntity objects.
        Throws:
        AMException - if an error encountered when trying to set/access the data store.
        SSOException - if the single sign on token of user is no longer valid.

      • createEntities

        Set createEntities​(int type,
                   Map entityNamesAndAttrs)
            throws AMException,
                   SSOException
        Deprecated.
        Creates the entities of the given type. The entity is created under a default container, if specified in the DAI service. If the specified default container does not exist, then it is created under the current organization and then the entities are created under it. If no specified container is specified, then the entities are created directly under the organization.
        Parameters:
        type - Type of entity being created. The types supported by SDK are configured in the list of Managed Objects in the DAI service.
        entityNamesAndAttrs - Map of entity name to a map of attribute name to a set of values.
        Returns:
        Set of AMEntity objects.
        Throws:
        AMException - if an error encountered when trying to set/access the data store.
        SSOException - if the single sign on token of user is no longer valid.

      • searchEntities

        Set searchEntities​(int type,
                   String wildcard,
                   int scope,
                   Map avPairs)
            throws AMException,
                   SSOException
        Deprecated.
        Searches for entities of the given type. The basic search filter is used from the search template as defined in the DAI service. The map of attribute-value pairs is or-ed to the basic search filter along with the wildcard, which is used to specify the naming attribute in the final search filter. The search is conducted under the specified container, if it exists. It the specified container does not exist, then an exception is thrown. If there is no specified container, then the search is performed directly under the organization.
        Parameters:
        type - Type of entity being created. The types supported by SDK are configured in the list of Managed Objects in the DAI service.
        wildcard - Pattern for naming attribute when performing the search.
        scope - Search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB).
        avPairs - Map of attribute-value pairs.
        Returns:
        Set of matching entity distinguished names.
        Throws:
        AMException - If there is an error trying to access the data store.
        SSOException - If the user's single sign on token is invalid.

      • searchEntities

        AMSearchResults searchEntities​(int type,
                               String wildcard,
                               Map avPairs,
                               AMSearchControl ctrls)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for entities of the given type. The basic search filter is used from the search template as defined in the DAI service. The map of attribute-value pairs is or-ed to the basic search filter along with the wildcard, which is used to specify the naming attribute in the final search filter. The search is conducted under the specified container, if it exists. It the specified container does not exist, then an exception is thrown. If there is no specified container, then the search is performed directly under the organization.
        Parameters:
        type - The type of entity to be searched. The types are defined in the list of managed objects in the DAI service.
        wildcard - Pattern for naming attribute when performing the search.
        avPairs - Map of attribute-value pairs.
        ctrls - Search control object specifying various search parameter.
        Returns:
        com.iplanet.am.sdk.AMSearchResults
        Throws:
        AMException - If there is an error trying to access the data store.
        SSOException - If the user's single sign on token is invalid.

      • searchEntities

        AMSearchResults searchEntities​(int type,
                               String wildcard,
                               String avfilter,
                               AMSearchControl ctrl)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for entities of the given type. The basic search filter is used from the search template as defined in the DAI service. The map of attribute-value pairs is or-ed to the basic search filter along with the wildcard, which is used to specify the naming attribute in the final search filter. The search is conducted under the specified container, if it exists. It the specified container does not exist, then an exception is thrown. If there is no specified container, then the search is performed directly under the organization.
        Parameters:
        type - The type of entity to be searched. The types are defined in the list of managed objects in the DAI service.
        wildcard - Pattern for naming attribute when performing the search.
        avfilter - Search filter to add to the basic search filter.
        ctrl - Search control object specifying various search parameter.
        Returns:
        com.iplanet.am.sdk.AMSearchResults
        Throws:
        AMException - If there is an error trying to access the data store.
        SSOException - If the user's single sign on token is invalid.

      • deleteEntities

        void deleteEntities​(int type,
                    Set entityDNs)
             throws AMException,
                    SSOException
        Deprecated.
        Deletes the entities whose fully-qualified distinguished names are provided in the set below.
        Parameters:
        type - Type of entity being deleted.
        entityDNs - Set of the FQDNs of entities to be deleted.
        Throws:
        AMException - If there is an error in trying to access the data store.
        SSOException - If the user's single sign on token is invalid.

      • isActivated

        boolean isActivated()
             throws AMException,
                    SSOException
        Deprecated.
        Returns true if the organization is activated.
        Returns:
        true if the organization is activated.
        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.