Class ITProfileManagerClient

  • All Implemented Interfaces:
    ITProfileManagerInterface

    public class ITProfileManagerClient
    extends java.lang.Object
    implements ITProfileManagerInterface
    OrganizationManagement is the client used by the Organization Integrator OMIS that is responsible with synchronizing organizational structures, profiles rules and users with open metadata.
    • Constructor Summary

      Constructors 
      Constructor Description
      ITProfileManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ITProfileManagerClient​(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.
      ITProfileManagerClient​(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.
      ITProfileManagerClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
      Create a new client that passes userId and password in each HTTP request.
      ITProfileManagerClient​(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 addContactMethod​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itProfileGUID, ContactMethodProperties properties)
      Add a new contact method to the profile.
      void addIdentityToProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID, ProfileIdentityProperties properties)
      Link a user identity to a profile.
      java.lang.String createITProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itInfrastructureGUID, java.lang.String itUserId, ITProfileProperties properties)
      Create a definition of an IT profile.
      java.lang.String createUserIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, UserIdentityProperties newIdentity)
      Create a UserIdentity.
      void deleteContactMethod​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String contactMethodGUID)
      Remove an obsolete contact method from the profile.
      void deleteITProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itProfileGUID)
      Remove the definition of an IT profile.
      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<ITProfileElement> findITProfile​(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<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.
      ITProfileElement getITProfileByGUID​(java.lang.String userId, java.lang.String itProfileGUID)
      Return information about a specific IT profile.
      java.util.List<ITProfileElement> getITProfileByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return information about a named IT profile.
      ITProfileElement getITProfileByUserId​(java.lang.String userId, java.lang.String itProfileUserId)
      Return information about a specific IT profile.
      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 linkITInfrastructureToProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itInfrastructureGUID, java.lang.String itProfileGUID, java.util.Date effectiveFrom, java.util.Date effectiveTo)
      Link a piece of infrastructure to an IT profile.
      void removeIdentityFromProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID)
      Unlink a user identity from a profile.
      void unlinkITInfrastructureFromProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itInfrastructureGUID, java.lang.String itProfileGUID, java.util.Date effectiveTime)
      Remove the link between a piece of infrastructure to an IT profile.
      void updateITInfrastructureToProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itInfrastructureGUID, java.lang.String itProfileGUID, java.util.Date effectiveFrom, java.util.Date effectiveTo)
      Update the effectivity dates of a link from a piece of infrastructure to an IT profile.
      void updateITProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String itProfileGUID, boolean isMergeUpdate, ITProfileProperties properties)
      Update the definition of an IT profile.
      void updateProfileIdentity​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String userIdentityGUID, java.lang.String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)
      Update the properties of the relationship between a user identity and profile.
      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
    • Constructor Detail

      • ITProfileManagerClient

        public ITProfileManagerClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot)
                               throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - bad input parameters
      • ITProfileManagerClient

        public ITProfileManagerClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      AuditLog auditLog)
                               throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ITProfileManagerClient

        public ITProfileManagerClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password)
                               throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - bad input parameters
      • ITProfileManagerClient

        public ITProfileManagerClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password,
                                      AuditLog auditLog)
                               throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - bad input parameters
      • ITProfileManagerClient

        public ITProfileManagerClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      ITInfrastructureRESTClient restClient,
                                      int maxPageSize)
                               throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - pre-initialized REST client
        maxPageSize - pre-initialized parameter limit
        Throws:
        InvalidParameterException - there is a problem with the information about the remote OMAS