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

Class GovernanceConfigurationResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.spring.GovernanceConfigurationResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/{serviceURLMarker}/governance-configuration-service/users/{userId}") public class GovernanceConfigurationResource extends Object
EngineConfigurationResource provides the Spring wrapper for the Governance Engine Configuration Services

  • Constructor Details

    • GovernanceConfigurationResource

      public GovernanceConfigurationResource()

  • Method Details

    • getGovernanceEngineByName

      @PostMapping(path="/governance-engines/by-name") public GovernanceEngineElementResponse getGovernanceEngineByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NameRequestBody name)
      Return the properties from the named 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.
      name - 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

      @GetMapping(path="/governance-engines/{governanceEngineGUID}/governance-services/{governanceServiceGUID}") public RegisteredGovernanceServiceResponse getRegisteredGovernanceService(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineGUID, @PathVariable 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

      @GetMapping(path="/governance-engines/{governanceEngineGUID}/governance-services") public RegisteredGovernanceServicesResponse getRegisteredGovernanceServices(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String governanceEngineGUID, @RequestParam int startingFrom, @RequestParam 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

      @GetMapping(path="/integration-groups/by-name/{name}") public IntegrationGroupElementResponse getIntegrationGroupByName(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable 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

      @GetMapping(path="/integration-connectors/{guid}/registrations") public GUIDListResponse getIntegrationConnectorRegistrations(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String guid)
      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.
      guid - 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

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}") public RegisteredIntegrationConnectorResponse getRegisteredIntegrationConnector(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable 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

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors") public RegisteredIntegrationConnectorsResponse getRegisteredIntegrationConnectors(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationGroupGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the details 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.