Package com.iplanet.am.sdk

Interface AMOrganizationalUnit

  • All Superinterfaces:
    AMConstants, AMObject
    public interface AMOrganizationalUnit
extends AMObject
    Deprecated.
    As of Sun Java System Access Manager 7.1.

    The AMOrganizationalUnit interface provides methods to manage organizational unit AMOrganizationalUnit 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)) { AMOrganizationalUnit org =
 amsc.getOrganizationalUnit(oDN); }

    • Method Detail

      • createOrganizations

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

      • createOrganizations

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

      • deleteOrganizations

        void deleteOrganizations​(Set organizations)
                  throws AMException,
                         SSOException
        Deprecated.
        Deletes organizations
        Parameters:
        organizations - The set of organizations 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.

      • getOrganization

        AMOrganization getOrganization​(String dn)
                        throws AMException,
                               SSOException
        Deprecated.
        Gets the organization by DN
        Parameters:
        dn - DN
        Returns:
        The 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.

      • getOrganizations

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

      • getNumberOfOrganizations

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

      • searchOrganizations

        Set searchOrganizations​(String wildcard,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for organizations in this organizational unit 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 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

      • searchOrganizations

        AMSearchResults searchOrganizations​(String wildcard,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for organizations in this organizational unit 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 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

      • searchOrganizations

        Set searchOrganizations​(String wildcard,
                        Map avPairs,
                        int level)
                 throws AMException,
                        SSOException
        Deprecated.
        Searches for organizations in this organizational unit 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 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 organizations
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of 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

      • searchOrganizations

        AMSearchResults searchOrganizations​(String wildcard,
                                    Map avPairs,
                                    AMSearchControl searchControl)
                             throws AMException,
                                    SSOException
        Deprecated.
        Searches for organizations in this organizational unit 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 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 organizations.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a Set of DNs of 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.

      • createSubOrganizationalUnits

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

      • createSubOrganizationalUnits

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

      • deleteSubOrganizationalUnits

        void deleteSubOrganizationalUnits​(Set subOrganizationalUnits)
                           throws AMException,
                                  SSOException
        Deprecated.
        Deletes sub organizational units
        Parameters:
        subOrganizationalUnits - The set of sub 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

      • getSubOrganizationalUnit

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

      • getSubOrganizationalUnits

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

      • getNumberOfSubOrganizationalUnits

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

      • searchSubOrganizationalUnits

        Set searchSubOrganizationalUnits​(String wildcard,
                                 int level)
                          throws AMException,
                                 SSOException
        Deprecated.
        Searches for sub organizational units in this organizational unit 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 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

      • searchSubOrganizationalUnits

        AMSearchResults searchSubOrganizationalUnits​(String wildcard,
                                             AMSearchControl searchControl)
                                      throws AMException,
                                             SSOException
        Deprecated.
        Searches for sub organizational units in this organizational unit 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 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.

      • searchSubOrganizationalUnits

        Set searchSubOrganizationalUnits​(String wildcard,
                                 Map avPairs,
                                 int level)
                          throws AMException,
                                 SSOException
        Deprecated.
        Searches for sub organizational units in this organizational unit 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 organizational units
        level - the search level that needs to be used ( AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)
        Returns:
        Set Set of DNs of sub 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

      • searchSubOrganizationalUnits

        AMSearchResults searchSubOrganizationalUnits​(String wildcard,
                                             Map avPairs,
                                             AMSearchControl searchControl)
                                      throws AMException,
                                             SSOException
        Deprecated.
        Searches for sub organizational units in this organizational unit 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 organizational units.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a Set of DNs of sub 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 organizational unit.
        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 organizational unit.
        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
        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 organizational unit 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 organizational unit 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 organizational unit 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 organizational unit 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 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 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 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 - 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 organizational unit 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 organizational unit 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 organizational unit 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 organizational unit 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

      • 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 organizational unit.
        Returns:
        The 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 organizational unit.
        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 organizational unit 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

        AMSearchResults searchAssignableDynamicGroups​(String wildcard,
                                              AMSearchControl searchControl)
                                       throws AMException,
                                              SSOException
        Deprecated.
        Searches for assignable dynamic groups in this organizational unit 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 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 organizational unit 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 organizational unit 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

      • 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.

      • 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 there is an internal error in the access management 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 unit.
        Returns:
        The Set of DNs 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

      • 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 unit.
        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 unit 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 there is an internal error in the access management 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 unit 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 unit 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 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 unit 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 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

      • 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

      • 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 organizational unit.
        Returns:
        The Set of DNs 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

      • 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 organizational unit.
        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

      • searchStaticGroups

        Set searchStaticGroups​(String wildcard,
                       int level)
                throws AMException,
                       SSOException
        Deprecated.
        Searches for static groups in this organizational unit 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

        AMSearchResults searchStaticGroups​(String wildcard,
                                   AMSearchControl searchControl)
                            throws AMException,
                                   SSOException
        Deprecated.
        Searches for static groups in this organizational unit 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 organizational unit 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
        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 organizational unit 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.
        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.

      • searchGroups

        Set searchGroups​(String wildcard,
                 Map avPairs,
                 int level)
          throws AMException,
                 SSOException
        Deprecated.
        Searches for groups in this organizational unit 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 organizational unit 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 - 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 people container objects created.
        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

      • deletePeopleContainers

        void deletePeopleContainers​(Set 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.
        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 organizational unit.
        Returns:
        The 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 organizational unit.
        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 organizational unit 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 organizational unit 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 organizational unit 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 - 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 organizational unit 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 GroupContainer 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 groupContainer, and the value is a Map to represent Attribute-Value Pairs.
        Returns:
        set of GroupContainer 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 organizational unit.
        Returns:
        The 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 organizational unit.
        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 organizational unit 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 organizational unit 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 - 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 there is an internal error in the access management data store.
        SSOException - if the single sign on token is no longer valid.

      • createUsers

        Set createUsers​(Set 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 there is an internal error in the access management 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

      • deleteUsers

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

      • 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 organizational unit.
        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 organizational unit 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

        AMSearchResults searchUsers​(String wildcard,
                            AMSearchControl searchControl)
                     throws AMException,
                            SSOException
        Deprecated.
        Searches for users in this organizational unit 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 organizational unit 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 organizational unit 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 of 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 organizational unit using wildcards and filter. Wildcards can be specified such as a*, *, *a. To further refine the search, filter can be specified so that DNs of users with matching filter 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 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 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 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

      • 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 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

      • registerService

        void registerService​(String serviceName,
                     boolean createTemplate,
                     boolean activate)
              throws AMException,
                     SSOException
        Deprecated.
        Register a service for this organizational unit.
        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.
        Unregister a service for this organizational unit.
        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 organizational unit and its roles.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store.
        SSOException - if the single sign on token is no longer valid.

      • modifyAllPolicyTemplates

        void modifyAllPolicyTemplates​(String serviceName,
                              Set policyDNs)
                       throws AMException,
                              SSOException
        Deprecated.
        Modifies all the templates under this organizational unit that contain any policyDN in given policyDNs.
        Parameters:
        serviceName - service name.
        policyDNs - Set of policy DN string.
        Throws:
        AMException - if an error is encountered when trying to access/retrieve data from the data store.
        SSOException - if the single sign on token is no longer valid.

      • deleteAllNamedPolicyTemplates

        boolean deleteAllNamedPolicyTemplates​(String policyDN)
                               throws AMException,
                                      SSOException
        Deprecated.
        Deletes all the named policy templates for this Organizational Unit 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 templates existed and were 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.

      • getAssignedPolicyDNs

        Set getAssignedPolicyDNs()
                  throws AMException,
                         SSOException
        Deprecated.
        Returns all the assigned policies for this organizational unit.
        Returns:
        a set of assigned policy DNs
        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.

      • isPolicyAssigned

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

      • 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 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

      • assignService

        void assignService​(String serviceName,
                   Map attrMap)
            throws AMException,
                   SSOException
        Deprecated.
        Assign service to the organizational unit. Also sets the attributes as provided in the map. If the service is already assigned to the user than it sets the attribute-values as defined in the attribute map. Attribute value is validated before being set. Any values for attributes already there are replaced with the ones provided in the attribute map.
        Parameters:
        serviceName - Name of service to be assigned to user.
        attrMap - Map of attribute name and values (as a Set) to be set
        Throws:
        AMException - if an error is encounters when trying to access/retrieve data from the 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 organizational unit. 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​(String type,
                   Set entities)
            throws AMException,
                   SSOException
        Deprecated.
        Create managed entities in this container. Supported entities, as defined in the configuration service DAI, can be created using this method.
        Parameters:
        type - Type of entity to be create (For example "user" or "agent"
        entities - Set of names for the entities to be created
        Returns:
        Set of AMEntity objects
        Throws:
        AMException - If there is an error when trying to save to the data store
        SSOException - if the single sign on token is invalid.

      • createEntities

        Set createEntities​(String stype,
                   Map entities)
            throws AMException,
                   SSOException
        Deprecated.
        Creates entities and initializes their attributes. Supported entities, as defined in the configuration service DAI, can be created using this method.
        Parameters:
        stype - Type of entity to be create (For example "user" or "agent"
        entities - Map where the key is the name of the entity, and the value is a Map to represent Attribute-Value Pairs
        Returns:
        Set of AMEntity objects created
        Throws:
        AMException - if an error is encountered when trying to create entity in the data store.
        SSOException - if the single sign on token is no longer valid

      • searchEntities

        Set searchEntities​(String wildcard,
                   int level,
                   String eSearchTemplate,
                   Map avPairs)
            throws AMException,
                   SSOException
        Deprecated.
        Searches for resources in this organization using wildcards and attribute values. Wildcards can be specified such as a*, *, *a. SDK uses the eSearchTemplate, if provided. Otherwise, it uses the BasicEntitySearch template.
        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)
        eSearchTemplate - Name of search template to be used. If a null is passed then the default search template for entities BasicEntitySearch is 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 resources 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.

      • searchEntities

        AMSearchResults searchEntities​(String wildcard,
                               Map avPairs,
                               String eSearchTemplate,
                               AMSearchControl searchControl)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for resources in this people container 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
        eSearchTemplate - Name of search template to be used.
        searchControl - specifies the search scope to be used, VLV ranges etc.
        Returns:
        AMSearchResults which contains a Set DNs of resources 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.

      • searchEntities

        AMSearchResults searchEntities​(String wildcard,
                               AMSearchControl searchControl,
                               String avfilter,
                               String eSearchTemplate)
                        throws AMException,
                               SSOException
        Deprecated.
        Searches for entities in this container using wildcards and a filter. Wildcards can be specified such as a*, *, *a. To further refine the search, a filter can be passed, which is used to further qualify the basic entity search filter.
        Parameters:
        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.
        eSearchTemplate - Name of search template to be used. If a null is passed then the default search template for entities BasicEntitySearch is used.
        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.

      • deleteEntities

        void deleteEntities​(Set resources)
             throws AMException,
                    SSOException
        Deprecated.
        Deletes a set of resources in this people container.
        Parameters:
        resources - The set of resource DNs to be removed.
        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.

      • getSupportedTypes

        Set getSupportedTypes()
               throws AMException,
                      SSOException
        Deprecated.
        Returns a set of the supported entity names in this container. This will help the application or console determine what kind of entities are stored in this container, and accordingly look for them.
        Returns:
        Set of names of the supported objects in this container.
        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.

      • setSupportedTypes

        void setSupportedTypes​(Set sTypes)
                throws AMException,
                       SSOException
        Deprecated.
        Sets the list of supported types for this container.
        Parameters:
        sTypes - The set of supported entity 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.