Package org.odpi.openmetadata.adminservices.spring

Class ConfigEngineHostServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigEngineHostServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/servers/{serverName}") public class ConfigEngineHostServicesResource extends Object
ConfigEngineServicesResource provides the configuration for setting up the Open Metadata Engine Services (OMESs).

  • Constructor Details

    • ConfigEngineHostServicesResource

      public ConfigEngineHostServicesResource()

  • Method Details

    • addEngine

      @PostMapping("/engine") public VoidResponse addEngine(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody EngineConfig engine)
      Add another governance engine the list of governance engines for an engine host OMAG server.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      engine - definition of a single engine
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.

    • getEngineHostServicesConfiguration

      @GetMapping("/governance-engines") public EngineHostServicesResponse getEngineHostServicesConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the configuration of the specialist services for an Engine Host OMAG Server.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      response containing the engine host services configuration

    • setEngineHostServicesConfig

      @PostMapping(path="/governance-engines") public VoidResponse setEngineHostServicesConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody List<EngineConfig> governanceEngines)
      Set up the configuration of the specialist services for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      governanceEngines - full configuration for the engine host server.
      Returns:
      void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.

    • clearEngineHostServicesConfig

      @DeleteMapping(path="/governance-engines") public VoidResponse clearEngineHostServicesConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Remove the configuration of the specialist services for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      Returns:
      void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.