Class SecurityManagerClient

  • All Implemented Interfaces:
    SecurityManagerInterface

    public class SecurityManagerClient
    extends java.lang.Object
    implements SecurityManagerInterface
    SecurityManagerClient is the client for explicitly managing the user identity entities and associating them with profiles. It is typically used when the relationship between user identities and profiles are many to one.
    • Constructor Summary

      Constructors 
      Constructor Description
      SecurityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      SecurityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      SecurityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      SecurityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, SecurityManagerRESTClient restClient, int maxPageSize)
      Create a new client that passes userId and password in each HTTP request.
      SecurityManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String createSecurityGroup​(java.lang.String userId, SecurityGroupProperties properties)
      Create a new security group.
      java.lang.String createUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, UserIdentityProperties newIdentity)
      Create a UserIdentity.
      void deleteSecurityGroup​(java.lang.String userId, java.lang.String securityGroupGUID)
      Delete a specific security group.
      void deleteUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID)
      Remove a user identity object.
      java.util.List<ActorProfileElement> findActorProfile​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of matching profiles for the search string.
      java.util.List<PersonRoleElement> findPersonRole​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of matching roles for the search string.
      java.util.List<SecurityGroupElement> findSecurityGroups​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Return the list of security groups that match the search string - this can be a regular expression.
      java.util.List<UserIdentityElement> findUserIdentities​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of user identity metadata elements that contain the search string.
      ActorProfileElement getActorProfileByGUID​(java.lang.String userId, java.lang.String actorProfileGUID)
      Return information about a specific actor profile.
      java.util.List<ActorProfileElement> getActorProfileByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return information about a named actor profile.
      ActorProfileElement getActorProfileByUserId​(java.lang.String userId, java.lang.String actorProfileUserId)
      Return information about a specific actor profile.
      java.util.List<PersonRoleAppointee> getAppointees​(java.lang.String userId, java.lang.String personRoleGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of people appointed to a particular role.
      java.util.List<ElementStub> getElementsGovernedBySecurityGroup​(java.lang.String userId, java.lang.String securityGroupGUID, int startFrom, int pageSize)
      Return the elements that are governed by the supplied security group.
      PersonRoleElement getPersonRoleByGUID​(java.lang.String userId, java.lang.String personRoleGUID)
      Return information about a specific person role.
      java.util.List<PersonRoleElement> getPersonRoleByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return information about a named person role.
      SecurityGroupElement getSecurityGroupByGUID​(java.lang.String userId, java.lang.String securityGroupGUID)
      Retrieve the security group metadata element with the supplied unique identifier.
      java.util.List<SecurityGroupElement> getSecurityGroupsForDistinguishedName​(java.lang.String userId, java.lang.String distinguishedName, int startFrom, int pageSize)
      Return the list of security groups associated with a unique distinguishedName.
      java.util.List<UserIdentityElement> getUserIdentitiesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of user identity metadata elements with a matching qualified name.
      UserIdentityElement getUserIdentityByGUID​(java.lang.String userId, java.lang.String userIdentityGUID)
      Retrieve the userIdentity metadata element with the supplied unique identifier.
      void updateSecurityGroup​(java.lang.String userId, java.lang.String securityGroupGUID, boolean isMergeUpdate, SecurityGroupProperties properties)
      Update an existing security group.
      void updateUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)
      Update a UserIdentity.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait