Package org.odpi.openmetadata.accessservices.governanceprogram.server

Class GovernanceRolesRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.GovernanceRolesRESTServices
public class GovernanceRolesRESTServices extends Object
The GovernanceRolesRESTServices provides the server-side implementation of the GovernanceRolesInterface from the Open Metadata Access Service (OMAS). This interface provides the ability to governance roles and link/unlink them to individuals.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GovernanceRolesRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    appointGovernanceRole(String serverName, String userId, String governanceRoleGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)
    Link a person to a governance role.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceRole(String serverName, String userId, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleRequestBody requestBody)
    Create the governance role.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteGovernanceRole(String serverName, String userId, String governanceRoleGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.ExternalSourceRequestBody requestBody)
    Remove the requested governance role.
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleAppointeeListResponse
    getCurrentGovernanceRoleAppointments(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
    Return all the governance roles and their incumbents (if any).
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleResponse
    getGovernanceRoleByGUID(String serverName, String userId, String governanceRoleGUID)
    Retrieve a governance role description by unique guid.
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse
    getGovernanceRoleByRoleId(String serverName, String userId, String roleId)
    Retrieve the properties of a governance role using its unique name.
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleHistoryResponse
    getGovernanceRoleHistoryByGUID(String serverName, String userId, String governanceRoleGUID)
    Retrieve a governance role description by unique guid along with the history of who has been appointed to the role.
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse
    getGovernanceRolesByDomainId(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
    Return all the defined governance roles.
    org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse
    getGovernanceRolesByTitle(String serverName, String userId, String title, int startFrom, int pageSize)
    Retrieve all the governance roles for a particular title.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkRoleToResource(String serverName, String userId, String governanceRoleGUID, String resourceGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
    Link a governance role to the description of a resource that the role is responsible for.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkRoleToResponsibility(String serverName, String userId, String governanceRoleGUID, String responsibilityGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
    Link a governance role to a governance control that defines a governance responsibility that a person fulfils.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    relieveGovernanceRole(String serverName, String userId, String governanceRoleGUID, String appointmentGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)
    Unlink a person from a governance role appointment.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unlinkRoleFromResource(String serverName, String userId, String governanceRoleGUID, String resourceGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
    Remove the link between a governance role and a resource.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unlinkRoleFromResponsibility(String serverName, String userId, String governanceRoleGUID, String responsibilityGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
    Remove the link between a governance role and a governance responsibility.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceRole(String serverName, String userId, String governanceRoleGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleRequestBody requestBody)
    Update selected fields for the governance role.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GovernanceRolesRESTServices

      public GovernanceRolesRESTServices()
      Default constructor

  • Method Details

    • createGovernanceRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceRole(String serverName, String userId, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleRequestBody requestBody)
      Create the governance role.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      requestBody - properties of the governance role.
      Returns:
      Unique identifier (guid) of the governance role or InvalidParameterException the governance domain or appointment id is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • updateGovernanceRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceRole(String serverName, String userId, String governanceRoleGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleRequestBody requestBody)
      Update selected fields for the governance role.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      governanceRoleGUID - unique identifier (guid) of the governance role.
      requestBody - properties of the governance role
      Returns:
      void response or UnrecognizedGUIDException the unique identifier of the governance role is either null or invalid or InvalidParameterException the title is null or the governanceDomain/appointmentId does not match the existing values associated with the governanceRoleGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • linkRoleToResponsibility

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkRoleToResponsibility(String serverName, String userId, String governanceRoleGUID, String responsibilityGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
      Link a governance role to a governance control that defines a governance responsibility that a person fulfils.
      Parameters:
      serverName - name of server instance to call
      userId - calling user
      governanceRoleGUID - unique identifier of the governance role
      responsibilityGUID - unique identifier of the governance responsibility control
      requestBody - relationship request body
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlinkRoleFromResponsibility

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unlinkRoleFromResponsibility(String serverName, String userId, String governanceRoleGUID, String responsibilityGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
      Remove the link between a governance role and a governance responsibility.
      Parameters:
      serverName - name of server instance to call
      userId - calling user
      governanceRoleGUID - unique identifier of the governance role
      responsibilityGUID - unique identifier of the governance responsibility control
      requestBody - external source request body
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • linkRoleToResource

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkRoleToResource(String serverName, String userId, String governanceRoleGUID, String resourceGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
      Link a governance role to the description of a resource that the role is responsible for.
      Parameters:
      serverName - name of server instance to call
      userId - calling user
      governanceRoleGUID - unique identifier of the governance role
      resourceGUID - unique identifier of the resource description
      requestBody - relationship request body
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlinkRoleFromResource

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unlinkRoleFromResource(String serverName, String userId, String governanceRoleGUID, String resourceGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.RelationshipRequestBody requestBody)
      Remove the link between a governance role and a resource.
      Parameters:
      serverName - name of server instance to call
      userId - calling user
      governanceRoleGUID - unique identifier of the governance role
      resourceGUID - unique identifier of the resource description
      requestBody - external source request body
      Returns:
      void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteGovernanceRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteGovernanceRole(String serverName, String userId, String governanceRoleGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.ExternalSourceRequestBody requestBody)
      Remove the requested governance role.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      governanceRoleGUID - unique identifier (guid) of the governance role.
      requestBody - external source request body
      Returns:
      void response or UnrecognizedGUIDException the unique identifier of the governance role is either null or invalid or InvalidParameterException the appointmentId or governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getGovernanceRoleByGUID

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleResponse getGovernanceRoleByGUID(String serverName, String userId, String governanceRoleGUID)
      Retrieve a governance role description by unique guid.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      governanceRoleGUID - unique identifier (guid) of the governance role.
      Returns:
      governance role object or UnrecognizedGUIDException the unique identifier of the governance role is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getGovernanceRoleHistoryByGUID

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleHistoryResponse getGovernanceRoleHistoryByGUID(String serverName, String userId, String governanceRoleGUID)
      Retrieve a governance role description by unique guid along with the history of who has been appointed to the role.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      governanceRoleGUID - unique identifier (guid) of the governance role.
      Returns:
      governance role object or UnrecognizedGUIDException the unique identifier of the governance role is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getGovernanceRoleByRoleId

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse getGovernanceRoleByRoleId(String serverName, String userId, String roleId)
      Retrieve the properties of a governance role using its unique name. The results are returned as a list since it is possible that two roles have the same identifier due to the distributed nature of the open metadata ecosystem. By returning all the search results here it is possible to manage the duplicates through this interface.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      roleId - the unique identifier of the governance role.
      Returns:
      governance role object or InvalidParameterException the governanceRoleGUID or governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getGovernanceRolesByDomainId

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse getGovernanceRolesByDomainId(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
      Return all the defined governance roles.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      domainIdentifier - domain of interest - 0 means all domains
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of governance role objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getGovernanceRolesByTitle

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleListResponse getGovernanceRolesByTitle(String serverName, String userId, String title, int startFrom, int pageSize)
      Retrieve all the governance roles for a particular title. The title can include regEx wildcards.
      Parameters:
      serverName - name of server instance to call
      userId - calling user
      title - short description of the role
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of governance role objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • getCurrentGovernanceRoleAppointments

      public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceRoleAppointeeListResponse getCurrentGovernanceRoleAppointments(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
      Return all the governance roles and their incumbents (if any).
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      domainIdentifier - identifier of domain - 0 means all
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of governance role objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • appointGovernanceRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse appointGovernanceRole(String serverName, String userId, String governanceRoleGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)
      Link a person to a governance role. Only one person may be appointed at any one time.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      governanceRoleGUID - unique identifier (guid) of the governance role.
      requestBody - unique identifier for the profile
      Returns:
      unique identifier (guid) of the appointment relationship or UnrecognizedGUIDException the unique identifier of the governance role or profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

    • relieveGovernanceRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse relieveGovernanceRole(String serverName, String userId, String governanceRoleGUID, String appointmentGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)
      Unlink a person from a governance role appointment.
      Parameters:
      serverName - name of server instance to call
      userId - the name of the calling user.
      governanceRoleGUID - unique identifier (guid) of the governance role.
      requestBody - unique identifier for the profile.
      appointmentGUID - unique identifier (guid) of the appointment relationship
      Returns:
      void response or UnrecognizedGUIDException the unique identifier of the governance role or profile is either null or invalid or InvalidParameterException the profile is not linked to this governance role or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.