Class GovernanceOfficerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.governanceofficer.server.GovernanceOfficerRESTServices

public class GovernanceOfficerRESTServices extends TokenController
The GovernanceOfficerRESTServices provides the server-side implementation of the Governance Officer Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.
  • Constructor Details

    • GovernanceOfficerRESTServices

      public GovernanceOfficerRESTServices()
      Default constructor
  • Method Details

    • createGovernanceDefinition

      public GUIDResponse createGovernanceDefinition(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create a governance definition.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the governance definition.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • createGovernanceDefinitionFromTemplate

      public GUIDResponse createGovernanceDefinitionFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a governance definition using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
    • updateGovernanceDefinition

      public VoidResponse updateGovernanceDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, UpdateElementRequestBody requestBody)
      Update the properties of a governance definition.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the governance definition (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • linkPeerDefinitions

      public VoidResponse linkPeerDefinitions(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, NewRelationshipRequestBody requestBody)
      Attach two peer governance definitions.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      governanceDefinitionOneGUID - unique identifier of the first governance definition
      governanceDefinitionTwoGUID - unique identifier of the second governance definition
      relationshipTypeName - name of the relationship to use
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • detachPeerDefinitions

      public VoidResponse detachPeerDefinitions(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, DeleteRequestBody requestBody)
      Detach a governance definition from one of its peers.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      governanceDefinitionOneGUID - unique identifier of the first governance definition
      governanceDefinitionTwoGUID - unique identifier of the second governance definition
      relationshipTypeName - name of the relationship to use
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • attachSupportingDefinition

      public VoidResponse attachSupportingDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, NewRelationshipRequestBody requestBody)
      Attach a supporting governance definition.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      governanceDefinitionOneGUID - unique identifier of the first governance definition
      governanceDefinitionTwoGUID - unique identifier of the second governance definition
      relationshipTypeName - name of the relationship to use
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • detachSupportingDefinition

      public VoidResponse detachSupportingDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, DeleteRequestBody requestBody)
      Detach a governance definition from a supporting governance definition.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      governanceDefinitionOneGUID - unique identifier of the first governance definition
      governanceDefinitionTwoGUID - unique identifier of the second governance definition
      relationshipTypeName - name of the relationship to use
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • deleteGovernanceDefinition

      public VoidResponse deleteGovernanceDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, DeleteRequestBody requestBody)
      Delete a governance definition.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • getGovernanceDefinitionsByName

      public OpenMetadataRootElementsResponse getGovernanceDefinitionsByName(String serverName, String viewServiceURLMarker, FilterRequestBody requestBody)
      Retrieve the list of governance definition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
    • getGovernanceDefinitionByGUID

      public OpenMetadataRootElementResponse getGovernanceDefinitionByGUID(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, GetRequestBody requestBody)
      Retrieve the list of governance definition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
    • findGovernanceDefinitions

      public OpenMetadataRootElementsResponse findGovernanceDefinitions(String serverName, String viewServiceURLMarker, SearchStringRequestBody requestBody)
      Retrieve the list of governance definition metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
    • getGovernanceDefinitionInContext

      public OpenMetadataRootElementResponse getGovernanceDefinitionInContext(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, ResultsRequestBody requestBody)
      Return the governance definition associated with a unique identifier and the other governance definitions linked to it.
      Parameters:
      serverName - name of the server instance to connect to
      viewServiceURLMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the governance definition
      requestBody - additional query parameters
      Returns:
      governance definition and its linked elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems
    • linkDesignToImplementation

      public VoidResponse linkDesignToImplementation(String serverName, String viewServiceURLMarker, String designGUID, String implementationGUID, NewRelationshipRequestBody requestBody)
      Attach a design object such as a solution component or governance definition to its implementation via the ImplementedBy relationship. Request body is optional.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      designGUID - unique identifier of the design object such as a governance definition or solution component
      implementationGUID - unique identifier of the second governance definition
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • detachDesignFromImplementation

      public VoidResponse detachDesignFromImplementation(String serverName, String viewServiceURLMarker, String designGUID, String implementationGUID, DeleteRequestBody requestBody)
      Detach a governance definition from its implementation.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      designGUID - unique identifier of the design object such as a governance definition or solution component
      implementationGUID - unique identifier of the second governance definition
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • linkImplementationResource

      public VoidResponse linkImplementationResource(String serverName, String viewServiceURLMarker, String designGUID, String implementationResourceGUID, NewRelationshipRequestBody requestBody)
      Attach a design object such as a solution component or governance definition to one of its implementation resource via the ImplementationResource relationship. Request body is optional.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      designGUID - unique identifier of the design object such as a governance definition or solution component
      implementationResourceGUID - unique identifier of the implementation resource
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • detachImplementationResource

      public VoidResponse detachImplementationResource(String serverName, String viewServiceURLMarker, String designGUID, String implementationResourceGUID, DeleteRequestBody requestBody)
      Detach a design object such as a governance definition or solution component from one of its implementation resources
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      designGUID - unique identifier of the design object such as a governance definition or solution component
      implementationResourceGUID - unique identifier of the implementation resource
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.