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 Summary

    Constructors
    Constructor
    Description
    EngineConfigurationResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceEngine(String serverName, String userId, String typeName, org.odpi.openmetadata.accessservices.governanceengine.rest.NewGovernanceEngineRequestBody requestBody)
    Create a new governance engine definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createGovernanceService(String serverName, String userId, String typeName, org.odpi.openmetadata.accessservices.governanceengine.rest.NewGovernanceServiceRequestBody requestBody)
    Create a governance service definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteGovernanceEngine(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.governanceengine.rest.DeleteRequestBody requestBody)
    Remove the properties of the governance engine.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteGovernanceService(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.governanceengine.rest.DeleteRequestBody requestBody)
    Remove the properties of the governance service.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceEngineElementsResponse
    getAllGovernanceEngines(String serverName, String userId, int startingFrom, int maximumResults)
    Return the list of governance engine definitions that are stored.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceServiceElementsResponse
    getAllGovernanceServices(String serverName, String userId, int startingFrom, int maximumResults)
    Return the list of governance services definitions that are stored.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceEngineElementResponse
    getGovernanceEngineByGUID(String serverName, String userId, String guid)
    Return the properties from a governance engine definition.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceEngineElementResponse
    getGovernanceEngineByName(String serverName, String userId, String name)
    Return the properties from a governance engine definition.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceServiceElementResponse
    getGovernanceServiceByGUID(String serverName, String userId, String guid)
    Return the properties from a governance service definition.
    org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceServiceElementResponse
    getGovernanceServiceByName(String serverName, String userId, String name)
    Return the properties from a governance service definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse
    getGovernanceServiceRegistrations(String serverName, String userId, String guid)
    Return the list of governance engines that a specific governance service is registered with.
    org.odpi.openmetadata.accessservices.governanceengine.rest.RegisteredGovernanceServiceResponse
    getRegisteredGovernanceService(String serverName, String userId, String governanceEngineGUID, String governanceServiceGUID)
    Retrieve a specific governance service registered with a governance engine.
    org.odpi.openmetadata.accessservices.governanceengine.rest.RegisteredGovernanceServicesResponse
    getRegisteredGovernanceServices(String serverName, String userId, String governanceEngineGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the governance services registered with a governance engine.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    registerGovernanceServiceWithEngine(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceServiceRegistrationRequestBody requestBody)
    Register a governance service with a specific governance engine.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unregisterGovernanceServiceFromEngine(String serverName, String userId, String governanceEngineGUID, String governanceServiceGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Unregister a governance service from the governance engine.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceEngine(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.governanceengine.rest.UpdateGovernanceEngineRequestBody requestBody)
    Update the properties of an existing governance engine definition.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateGovernanceService(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.governanceengine.rest.UpdateGovernanceServiceRequestBody requestBody)
    Update the properties of an existing governance service definition.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EngineConfigurationResource

      public EngineConfigurationResource()

  • Method Details

    • createGovernanceEngine

      @PostMapping(path="/governance-engines/new/{typeName}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.GovernanceEngineElementResponse getGovernanceEngineByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the properties from a 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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteGovernanceEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteGovernanceService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse registerGovernanceServiceWithEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.accessservices.governanceengine.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unregisterGovernanceServiceFromEngine(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceEngineGUID, @PathVariable String governanceServiceGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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.