Package org.odpi.openmetadata.viewservices.governanceofficer.server

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 urlMarker, NewElementRequestBody requestBody)
      Create a governance definition.
      Parameters:
      serverName - name of called server.
      urlMarker - 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 urlMarker, 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
      urlMarker - 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 urlMarker, String governanceDefinitionGUID, UpdateElementRequestBody requestBody)
      Update the properties of a governance definition.
      Parameters:
      serverName - name of called server.
      urlMarker - 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 urlMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, NewRelationshipRequestBody requestBody)
      Attach two peer governance definitions.
      Parameters:
      serverName - name of called server
      urlMarker - 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 urlMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, DeleteRequestBody requestBody)
      Detach a governance definition from one of its peers.
      Parameters:
      serverName - name of called server
      urlMarker - 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 urlMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, NewRelationshipRequestBody requestBody)
      Attach a supporting governance definition.
      Parameters:
      serverName - name of called server
      urlMarker - 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 urlMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, DeleteRequestBody requestBody)
      Detach a governance definition from a supporting governance definition.
      Parameters:
      serverName - name of called server
      urlMarker - 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.

    • addGovernanceDefinitionToElement

      public VoidResponse addGovernanceDefinitionToElement(String serverName, String urlMarker, String elementGUID, String definitionGUID, NewRelationshipRequestBody requestBody)
      Link a governance definition to an element using the GovernedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to link
      definitionGUID - identifier of the governance definition to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeGovernanceDefinitionFromElement

      public VoidResponse removeGovernanceDefinitionFromElement(String serverName, String urlMarker, String elementGUID, String definitionGUID, DeleteRequestBody requestBody)
      Remove the GovernedBy relationship between a governance definition and an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the metadata element to update
      definitionGUID - identifier of the governance definition to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkGovernanceResults

      public VoidResponse linkGovernanceResults(String serverName, String urlMarker, String governanceMetricGUID, String dataSourceGUID, NewRelationshipRequestBody requestBody)
      Attach a governance metric to an asset that represents the data store where the measurements are located.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      governanceMetricGUID - unique identifier of the metric to link
      dataSourceGUID - identifier of the asset to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • detachGovernanceResults

      public VoidResponse detachGovernanceResults(String serverName, String urlMarker, String governanceMetricGUID, String dataSourceGUID, DeleteRequestBody requestBody)
      Detach a governance metric from an asset that represents the data store where the measurements are located.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      governanceMetricGUID - unique identifier of the metric
      dataSourceGUID - identifier of the asset to unlink
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • licenseElement

      public GUIDResponse licenseElement(String serverName, String urlMarker, String elementGUID, String licenseTypeGUID, NewRelationshipRequestBody requestBody)
      Link an element to a license type and include details of the license in the relationship properties.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element being licensed
      licenseTypeGUID - unique identifier for the license type
      requestBody - the properties of the license
      Returns:
      guid or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateLicense

      public VoidResponse updateLicense(String serverName, String urlMarker, String licenseGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of a license. Remember to include the licenseId in the properties if the element has multiple licenses for the same license type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      licenseGUID - unique identifier for the license type
      requestBody - the properties of the license
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlicenseElement

      public VoidResponse unlicenseElement(String serverName, String urlMarker, String licenseGUID, DeleteRequestBody requestBody)
      Remove the license for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      licenseGUID - unique identifier for the license type
      requestBody - external source information.
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • certifyElement

      public GUIDResponse certifyElement(String serverName, String urlMarker, String elementGUID, String certificationTypeGUID, NewRelationshipRequestBody requestBody)
      Link an element to a certification type and include details of the certification in the relationship properties.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element being certified
      certificationTypeGUID - unique identifier for the certification type
      requestBody - the properties of the certification
      Returns:
      guid or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateCertification

      public VoidResponse updateCertification(String serverName, String urlMarker, String certificationGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of a certification. Remember to include the certificationId in the properties if the element has multiple certifications for the same certification type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      certificationGUID - unique identifier for the certification type
      requestBody - the properties of the certification
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • decertifyElement

      public VoidResponse decertifyElement(String serverName, String urlMarker, String certificationGUID, DeleteRequestBody requestBody)
      Remove the certification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      certificationGUID - unique identifier for the certification type
      requestBody - external source information.
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteGovernanceDefinition

      public VoidResponse deleteGovernanceDefinition(String serverName, String urlMarker, String governanceDefinitionGUID, DeleteRequestBody requestBody)
      Delete a governance definition.
      Parameters:
      serverName - name of called server
      urlMarker - 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 urlMarker, 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
      urlMarker - 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 urlMarker, 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
      urlMarker - 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 urlMarker, 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
      urlMarker - 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)

    • linkDesignToImplementation

      public VoidResponse linkDesignToImplementation(String serverName, String urlMarker, 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
      urlMarker - 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 urlMarker, String designGUID, String implementationGUID, DeleteRequestBody requestBody)
      Detach a governance definition from its implementation.
      Parameters:
      serverName - name of called server
      urlMarker - 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 urlMarker, 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
      urlMarker - 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 urlMarker, 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
      urlMarker - 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.