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

Class GovernanceDomainRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.GovernanceDomainRESTServices
public class GovernanceDomainRESTServices extends Object
GovernanceDomainRESTServices sets up the governance domains that are part of an organization governance. Each governance domain describes a focus for governance.

  • Constructor Details

    • GovernanceDomainRESTServices

      public GovernanceDomainRESTServices()
      Default constructor

  • Method Details

    • createGovernanceDomainSet

      public GUIDResponse createGovernanceDomainSet(String serverName, String userId, ReferenceableRequestBody requestBody)
      Create a new metadata element to represent the root of a Governance Domain Set.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element 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)

    • updateGovernanceDomainSet

      public VoidResponse updateGovernanceDomainSet(String serverName, String userId, String governanceDomainSetGUID, ReferenceableRequestBody requestBody)
      Update the metadata element representing a Governance Domain Set.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainSetGUID - unique identifier of the metadata element to remove
      requestBody - new properties for this element
      Returns:
      void 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)

    • removeGovernanceDomainSet

      public VoidResponse removeGovernanceDomainSet(String serverName, String userId, String governanceDomainSetGUID, ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a governanceDomainSet. The governance domains are not deleted.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainSetGUID - unique identifier of the metadata element to remove
      requestBody - external source request body
      Returns:
      void 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)

    • findGovernanceDomainSets

      public GovernanceDomainSetsResponse findGovernanceDomainSets(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)
      Retrieve the list of governanceDomainSet metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getGovernanceDomainSetsByName

      public GovernanceDomainSetsResponse getGovernanceDomainSetsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)
      Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      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)

    • getGovernanceDomainSetByGUID

      public GovernanceDomainSetResponse getGovernanceDomainSetByGUID(String serverName, String userId, String governanceDomainSetGUID)
      Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainSetGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element 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)

    • createGovernanceDomain

      public GUIDResponse createGovernanceDomain(String serverName, String userId, ReferenceableRequestBody requestBody)
      Create a new metadata element to represent a governance domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - new properties for this element
      Returns:
      unique identifier of the new Governance Domain 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)

    • updateGovernanceDomain

      public VoidResponse updateGovernanceDomain(String serverName, String userId, String governanceDomainGUID, ReferenceableRequestBody requestBody)
      Update the metadata element representing a Governance Domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainGUID - unique identifier of the metadata element to update
      requestBody - new properties for the metadata element
      Returns:
      void 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)

    • deleteGovernanceDomain

      public VoidResponse deleteGovernanceDomain(String serverName, String userId, String governanceDomainGUID, ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a Governance Domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainGUID - unique identifier of the metadata element to remove
      requestBody - external source request body
      Returns:
      void 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)

    • addDomainToSet

      public VoidResponse addDomainToSet(String serverName, String userId, String governanceDomainSetGUID, String governanceDomainGUID, RelationshipRequestBody requestBody)
      Create a parent-child relationship between a governance domain set and a governance domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainSetGUID - unique identifier of the governance domain set
      governanceDomainGUID - unique identifier of the governance domain
      requestBody - relationship request body
      Returns:
      void 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)

    • removeDomainFromSet

      public VoidResponse removeDomainFromSet(String serverName, String userId, String governanceDomainSetGUID, String governanceDomainGUID, ExternalSourceRequestBody requestBody)
      Remove a parent-child relationship between a governance domain set and a governance domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainSetGUID - unique identifier of the governance domain set
      governanceDomainGUID - unique identifier of the governance domain
      requestBody - relationship request body
      Returns:
      void 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)

    • getGovernanceDomains

      public GovernanceDomainsResponse getGovernanceDomains(String serverName, String userId, int startFrom, int pageSize)
      Retrieve the list of Governance Domain metadata elements defined for the governance program.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • findGovernanceDomains

      public GovernanceDomainsResponse findGovernanceDomains(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)
      Retrieve the list of Governance Domain metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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)

    • getSetsForGovernanceDomain

      public GovernanceDomainSetsResponse getSetsForGovernanceDomain(String serverName, String userId, String governanceDomainGUID, int startFrom, int pageSize)
      Return the list of governance domain sets that a governance domain belong.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainGUID - unique identifier of the governance domain to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of metadata elements describing the sets associated with the requested governanceDomainSet 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)

    • getGovernanceDomainsByName

      public GovernanceDomainsResponse getGovernanceDomainsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)
      Retrieve the list of Governance Domain metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for
      Returns:
      list of matching metadata elements 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)

    • getGovernanceDomainByGUID

      public GovernanceDomainResponse getGovernanceDomainByGUID(String serverName, String userId, String governanceDomainGUID)
      Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      governanceDomainGUID - unique identifier of the requested metadata element
      Returns:
      requested metadata element 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)

    • getGovernanceDomainByIdentifier

      public GovernanceDomainResponse getGovernanceDomainByIdentifier(String serverName, String userId, int domainIdentifier)
      Retrieve the Governance Domain metadata element with the supplied domain identifier.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      domainIdentifier - identifier used to identify the domain
      Returns:
      requested metadata element 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)