Package org.odpi.openmetadata.accessservices.governanceengine.server.spring

Class EngineConfigurationResource

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

  • Constructor Details

    • EngineConfigurationResource

      public EngineConfigurationResource()

  • Method Details

    • createGovernanceEngine

      @PostMapping(path="/governance-engines/new/{typeName}") public GUIDResponse createGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody NewGovernanceEngineRequestBody requestBody)
      Create a new governance engine definition.
      Parameters:
      serverName - name of the service to route the request to
      userId - identifier of calling user
      typeName - type of governance engine
      requestBody - containing: qualifiedName - unique name for the governance engine; displayName - display name for messages and user interfaces; description - description of the types of governance services that wil be associated with this governance engine.
      Returns:
      unique identifier (guid) of 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.

    • getGovernanceEngineByGUID

      @GetMapping(path="/governance-engines/{guid}") public GovernanceEngineElementResponse getGovernanceEngineByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the properties from a governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance engine definition.
      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.

    • getGovernanceEngineByName

      @GetMapping(path="/governance-engines/by-name/{name}") public GovernanceEngineElementResponse getGovernanceEngineByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the properties from the named governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      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.

    • getAllGovernanceEngines

      @GetMapping(path="/governance-engines") public GovernanceEngineElementsResponse getAllGovernanceEngines(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of governance engine definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance engine definitions 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.

    • updateGovernanceEngine

      @PostMapping(path="/governance-engines/{guid}/update") public VoidResponse updateGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody UpdateGovernanceEngineRequestBody requestBody)
      Update the properties of an existing governance engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the new properties of the governance engine.
      Returns:
      void 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.

    • deleteGovernanceEngine

      @PostMapping(path="/governance-engines/{guid}/delete") public VoidResponse deleteGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the governance engine. Both the guid and the qualified name is supplied to validate that the correct governance engine is being deleted.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the unique name for the governance engine.
      Returns:
      void 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.

    • createGovernanceService

      @PostMapping(path="/governance-services/new/{typeName}") public GUIDResponse createGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody NewGovernanceServiceRequestBody requestBody)
      Create a governance service definition. The same governance service can be associated with multiple governance engines.
      Parameters:
      serverName - name of the service to route the request to
      userId - identifier of calling user
      typeName - type of governance service
      requestBody - containing: qualifiedName - unique name for the governance service; displayName - display name for the governance service; description - description of the analysis provided by the governance service; connection - connection to instantiate the governance service implementation.
      Returns:
      unique identifier of the governance service 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.

    • getGovernanceServiceByGUID

      @GetMapping(path="/governance-services/{guid}") public GovernanceServiceElementResponse getGovernanceServiceByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance service definition.
      Returns:
      properties of the governance service 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.

    • getGovernanceServiceByName

      @GetMapping(path="/governance-services/by-name/{name}") public GovernanceServiceElementResponse getGovernanceServiceByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      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.

    • getAllGovernanceServices

      @GetMapping(path="/governance-services") public GovernanceServiceElementsResponse getAllGovernanceServices(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of governance services definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance service definitions 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.

    • getGovernanceServiceRegistrations

      @GetMapping(path="/governance-services/{guid}/registrations") public GUIDListResponse getGovernanceServiceRegistrations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the list of governance engines that a specific governance service is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - governance service to search for.
      Returns:
      list of governance engine 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 governance engine definition.

    • updateGovernanceService

      @PostMapping(path="/governance-services/{guid}/update") public VoidResponse updateGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody UpdateGovernanceServiceRequestBody requestBody)
      Update the properties of an existing governance service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the new parameters for the governance service.
      Returns:
      void 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.

    • deleteGovernanceService

      @PostMapping(path="/governance-services/{guid}/delete") public VoidResponse deleteGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the governance service. Both the guid and the qualified name is supplied to validate that the correct governance service is being deleted. The governance service is also unregistered from its governance engines.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the unique name for the governance service.
      Returns:
      void 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.

    • registerGovernanceServiceWithEngine

      @PostMapping(path="/governance-engines/{guid}/governance-services") public VoidResponse registerGovernanceServiceWithEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody GovernanceServiceRegistrationRequestBody requestBody)
      Register a governance service with a specific governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the governance engine.
      requestBody - containing: guid - unique identifier of the governance service; governanceRequestTypes - list of asset governance types that this governance service is able to process.
      Returns:
      void 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 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.
      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 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.
      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.

    • unregisterGovernanceServiceFromEngine

      @PostMapping(path="/governance-engines/{governanceEngineGUID}/governance-services/{governanceServiceGUID}/delete") public VoidResponse unregisterGovernanceServiceFromEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceEngineGUID, @PathVariable String governanceServiceGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unregister a governance service from the governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      requestBody - null request body.
      Returns:
      void 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.