Package org.odpi.openmetadata.engineservices.assetanalysis.server.spring

Class EngineHostServicesResource

java.lang.Object
org.odpi.openmetadata.engineservices.assetanalysis.server.spring.EngineHostServicesResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/engine-host") public class EngineHostServicesResource extends Object
EngineHostServicesResource provides the server-side catcher for REST calls using Spring. The OMAG ServerPlatform routes these requests to the engine host services active in the server.

  • Constructor Details

    • EngineHostServicesResource

      public EngineHostServicesResource()

  • Method Details

    • getGovernanceEngineSummary

      @GetMapping(path="/governance-engines/{governanceEngineName}/summary") public GovernanceEngineSummaryResponse getGovernanceEngineSummary(@PathVariable String serverName, @PathVariable String governanceEngineName, @RequestParam(required=false) String delegatingUserId)
      Retrieve the description and status of the requested governance engine.
      Parameters:
      serverName - engine host server name
      delegatingUserId - external userId making request
      governanceEngineName - name of governance engine of interest
      Returns:
      list of statuses - on for each assigned governance engines or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

    • getGovernanceEngineSummaries

      @GetMapping(path="/governance-engines/summary") public GovernanceEngineSummariesResponse getGovernanceEngineSummaries(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return a summary of each of the governance engines running in the Engine Host.
      Parameters:
      serverName - engine host server name
      delegatingUserId - external userId making request
      Returns:
      list of statuses - on for each assigned governance engines or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

    • refreshConfig

      @GetMapping(path="/governance-engines/{governanceEngineName}/refresh-config") public VoidResponse refreshConfig(@PathVariable String serverName, @PathVariable String governanceEngineName, @RequestParam(required=false) String delegatingUserId)
      Request that the governance engine refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server
      delegatingUserId - external userId making request
      governanceEngineName - unique name 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 GovernanceEngineException there was a problem detected by the governance engine.

    • refreshConfig

      @GetMapping(path="/governance-engines/refresh-config") public VoidResponse refreshConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Request that all governance engines refresh their configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server.
      delegatingUserId - external userId making request
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or GovernanceEngineException there was a problem detected by the governance engine.