Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class ITProfileManagerClient

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.ITProfileManagerClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
public class ITProfileManagerClient extends Object implements org.odpi.openmetadata.accessservices.itinfrastructure.api.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(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    ITProfileManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    ITProfileManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    ITProfileManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.
    ITProfileManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ContactMethodProperties properties)
    Add a new contact method to the profile.
    void
    addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties)
    Link a user identity to a profile.
    String
    createITProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itUserId, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ITProfileProperties properties)
    Create a definition of an IT profile.
    String
    createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties newIdentity)
    Create a UserIdentity.
    void
    deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String contactMethodGUID)
    Remove an obsolete contact method from the profile.
    void
    deleteITProfile(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID)
    Remove the definition of an IT profile.
    void
    deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID)
    Remove a user identity object.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement>
    findITProfile(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of matching profiles for the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement>
    findUserIdentities(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of user identity metadata elements that contain the search string.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement
    getITProfileByGUID(String userId, String itProfileGUID)
    Return information about a specific IT profile.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement>
    getITProfileByName(String userId, String name, int startFrom, int pageSize)
    Return information about a named IT profile.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement
    getITProfileByUserId(String userId, String itProfileUserId)
    Return information about a specific IT profile.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement>
    getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of user identity metadata elements with a matching qualified name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement
    getUserIdentityByGUID(String userId, String userIdentityGUID)
    Retrieve the userIdentity metadata element with the supplied unique identifier.
    void
    linkITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)
    Link a piece of infrastructure to an IT profile.
    void
    removeIdentityFromProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID)
    Unlink a user identity from a profile.
    void
    unlinkITInfrastructureFromProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveTime)
    Remove the link between a piece of infrastructure to an IT profile.
    void
    updateITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)
    Update the effectivity dates of a link from a piece of infrastructure to an IT profile.
    void
    updateITProfile(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ITProfileProperties properties)
    Update the definition of an IT profile.
    void
    updateProfileIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties)
    Update the properties of the relationship between a user identity and profile.
    void
    updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties properties)
    Update a UserIdentity.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ITProfileManagerClient

      public ITProfileManagerClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 services
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - bad input parameters

    • ITProfileManagerClient

      public ITProfileManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ITProfileManagerClient

      public ITProfileManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - bad input parameters

    • ITProfileManagerClient

      public ITProfileManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - bad input parameters

    • ITProfileManagerClient

      public ITProfileManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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 services
      restClient - pre-initialized REST client
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

  • Method Details

    • createITProfile

      public String createITProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itUserId, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ITProfileProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a definition of an IT profile. If the itInfrastructureGUID is provided, it is connected to the infrastructure element that the profile describes using the ITInfrastructureProfile relationship. If the itUserId is specified, a UserIdentity for that userId is found/created and connected to the new IT profile.
      Specified by:
      createITProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itInfrastructureGUID - unique identifier of the piece of IT infrastructure that is described by the new IT profile.
      itUserId - user Id used by the IT Infrastructure
      properties - properties for a IT profile
      Returns:
      unique identifier of IT profile
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • updateITProfile

      public void updateITProfile(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ITProfileProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the definition of an IT profile.
      Specified by:
      updateITProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itProfileGUID - unique identifier of IT profile
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      properties - properties to change
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • deleteITProfile

      public void deleteITProfile(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the definition of an IT profile.
      Specified by:
      deleteITProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itProfileGUID - unique identifier of IT profile
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - guid or userId is null; guid is not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • addContactMethod

      public String addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ContactMethodProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Add a new contact method to the profile.
      Specified by:
      addContactMethod in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itProfileGUID - identifier of the profile to update.
      properties - properties of contact method.
      Returns:
      unique identifier (guid) for the new contact method.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteContactMethod

      public void deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String contactMethodGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Remove an obsolete contact method from the profile.
      Specified by:
      deleteContactMethod in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      contactMethodGUID - unique identifier (guid) for the obsolete contact method.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • linkITInfrastructureToProfile

      public void linkITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Link a piece of infrastructure to an IT profile.
      Specified by:
      linkITInfrastructureToProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itInfrastructureGUID - unique identifier of the IT Infrastructure element
      itProfileGUID - unique identifier of the IT profile
      effectiveFrom - start date for the relationship
      effectiveTo - end date for the relationship
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • updateITInfrastructureToProfile

      public void updateITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the effectivity dates of a link from a piece of infrastructure to an IT profile.
      Specified by:
      updateITInfrastructureToProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itInfrastructureGUID - unique identifier of the IT Infrastructure element
      itProfileGUID - unique identifier of the IT profile
      effectiveFrom - start date for the relationship
      effectiveTo - end date for the relationship
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • unlinkITInfrastructureFromProfile

      public void unlinkITInfrastructureFromProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Remove the link between a piece of infrastructure to an IT profile.
      Specified by:
      unlinkITInfrastructureFromProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
      externalSourceName - name of the software server capability entity that represented the external source
      itInfrastructureGUID - unique identifier of the IT Infrastructure element
      itProfileGUID - unique identifier of the IT profile
      effectiveTime - time that the relationship is active - null for any time
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getITProfileByGUID

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement getITProfileByGUID(String userId, String itProfileGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about a specific IT profile.
      Specified by:
      getITProfileByGUID in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      itProfileGUID - unique identifier for the IT profile
      Returns:
      properties of the IT profile
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - itProfileGUID or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getITProfileByUserId

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement getITProfileByUserId(String userId, String itProfileUserId) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about a specific IT profile.
      Specified by:
      getITProfileByUserId in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      itProfileUserId - unique identifier for the IT profile
      Returns:
      properties of the IT profile
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - itProfileUserId or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • getITProfileByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement> getITProfileByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return information about a named IT profile.
      Specified by:
      getITProfileByName in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      name - unique name for the IT profile
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching IT profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - security access problem

    • findITProfile

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ITProfileElement> findITProfile(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Retrieve the list of matching profiles for the search string.
      Specified by:
      findITProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      searchString - RegEx string to search for
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching IT profiles
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - the server is not available.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

    • createUserIdentity

      public String createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties newIdentity) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Create a UserIdentity. This is not connected to a profile.
      Specified by:
      createUserIdentity in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      newIdentity - properties for the new userIdentity.
      Returns:
      unique identifier of the UserIdentity
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateUserIdentity

      public void updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.UserIdentityProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Update a UserIdentity.
      Specified by:
      updateUserIdentity in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      userIdentityGUID - unique identifier of the UserIdentity
      isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
      properties - updated properties for the new userIdentity
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteUserIdentity

      public void deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Remove a user identity object. This will fail if the profile would be left without an associated user identity.
      Specified by:
      deleteUserIdentity in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      userIdentityGUID - unique identifier of the UserIdentity
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addIdentityToProfile

      public void addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Link a user identity to a profile. This will fail if the user identity is already connected to a profile.
      Specified by:
      addIdentityToProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      profileGUID - the profile to add the identity to.
      userIdentityGUID - additional userId for the profile.
      properties - the properties that describe how the owner of the profile uses the user identity
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateProfileIdentity

      public void updateProfileIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actors.ProfileIdentityProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Update the properties of the relationship between a user identity and profile.
      Specified by:
      updateProfileIdentity in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      userIdentityGUID - additional userId for the profile
      profileGUID - the profile to add the identity to
      isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false
      properties - the properties that describe how the owner of the profile uses the user identity
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeIdentityFromProfile

      public void removeIdentityFromProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Unlink a user identity from a profile.
      Specified by:
      removeIdentityFromProfile in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - the name of the calling user.
      externalSourceGUID - unique identifier of software server capability representing the caller
      externalSourceName - unique name of software server capability representing the caller
      userIdentityGUID - unique identifier of the UserIdentity
      profileGUID - profile to remove it from.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findUserIdentities

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement> findUserIdentities(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findUserIdentities in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getUserIdentitiesByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement> getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.
      Specified by:
      getUserIdentitiesByName in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getUserIdentityByGUID

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.UserIdentityElement getUserIdentityByGUID(String userId, String userIdentityGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the userIdentity metadata element with the supplied unique identifier.
      Specified by:
      getUserIdentityByGUID in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ITProfileManagerInterface
      Parameters:
      userId - calling user
      userIdentityGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)