Package org.odpi.openmetadata.frameworkservices.gaf.server

Class GovernanceConfigRESTServices

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.GovernanceConfigRESTServices
public class GovernanceConfigRESTServices extends Object
The GovernanceConfigRESTServices provides the server-side implementation of the configuration services from the Open Governance Framework (ODF). These services configure governance engines and governance services.

  • Constructor Details

    • GovernanceConfigRESTServices

      public GovernanceConfigRESTServices()
      Default constructor

  • Method Details

    • getGovernanceEngineByName

      public GovernanceEngineElementResponse getGovernanceEngineByName(String serverName, String serviceURLMarker, String userId, NameRequestBody requestBody)
      Return the properties from a governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestBody - qualified name or display name (if unique).
      Returns:
      properties from the governance engine definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getRegisteredGovernanceService

      public RegisteredGovernanceServiceResponse getRegisteredGovernanceService(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, String governanceServiceGUID)
      Retrieve a specific governance service registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getRegisteredGovernanceServices

      public RegisteredGovernanceServicesResponse getRegisteredGovernanceServices(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the governance services registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getIntegrationGroupByName

      public IntegrationGroupElementResponse getIntegrationGroupByName(String serverName, String serviceURLMarker, String userId, String name)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationConnectorRegistrations

      public GUIDListResponse getIntegrationConnectorRegistrations(String serverName, String serviceURLMarker, String userId, String integrationConnectorGUID)
      Return the list of integration groups that a specific integration connector is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationConnectorGUID - integration connector to search for.
      Returns:
      list of integration group unique identifiers (guids) or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getRegisteredIntegrationConnector

      public RegisteredIntegrationConnectorResponse getRegisteredIntegrationConnector(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, String integrationConnectorGUID)
      Retrieve a specific integration connector registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      Returns:
      details of the integration connector and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getRegisteredIntegrationConnectors

      public RegisteredIntegrationConnectorsResponse getRegisteredIntegrationConnectors(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the integration connectors registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.