Package org.odpi.openmetadata.adminservices.spring

Class ConfigEngineHostServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigEngineHostServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/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

    • getConfiguredEngineServices

      @GetMapping("/engine-services") public RegisteredOMAGServicesResponse getConfiguredEngineServices(@PathVariable String userId, @PathVariable String serverName)
      Return the list of registered engine services for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      list of engine service descriptions

    • getEngineServiceConfiguration

      @GetMapping("/engine-services/{serviceURLMarker}/configuration") public EngineServiceConfigResponse getEngineServiceConfiguration(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Return the configuration for the named engine service for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      serviceURLMarker - engine service name used in URL
      Returns:
      response containing the engine services configuration

    • setEngineDefinitionsClientConfig

      @PostMapping("/engine-definitions/client-config") public VoidResponse setEngineDefinitionsClientConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody OMAGServerClientConfig clientConfig)
      Set up the name and platform URL root for the metadata server running the Governance Engine OMAS that provides the governance engine definitions used by the engine services.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      clientConfig - URL root and server name for the metadata server.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • setEngineList

      @PostMapping("/engine-list") public VoidResponse setEngineList(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<EngineConfig> engines)
      Set up the list of governance engines that will use the metadata from the same metadata access server as the engine host uses for retrieving the engine configuration.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      engines - list of engines supported by the server
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • addEngine

      @PostMapping("/engine") public VoidResponse addEngine(@PathVariable String userId, @PathVariable String serverName, @RequestBody EngineConfig engine)
      Add another engine to the list of governance engines that will use the metadata from the same metadata access server as the engine host uses for retrieving the engine configuration.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      engine - definition of a single engine
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • configureEngineService

      @PostMapping(path="/engine-services/{serviceURLMarker}") public VoidResponse configureEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker, @RequestBody EngineServiceRequestBody requestBody)
      Enable a single registered engine service. This builds the engine service configuration for the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - string indicating which engine service it is configuring
      requestBody - minimum values to configure an engine service
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

    • configureAllEngineServices

      @PostMapping(path="/engine-services") public VoidResponse configureAllEngineServices(@PathVariable String userId, @PathVariable String serverName, @RequestBody EngineServiceRequestBody requestBody)
      Enable all non-deprecated, registered engine service. This builds the engine service configuration for the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - minimum values to configure an engine service
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

    • configureEngineService

      @PostMapping(path="/engine-services/configuration") public VoidResponse configureEngineService(@PathVariable String userId, @PathVariable String serverName, @RequestBody EngineServiceConfig serviceConfig)
      Add configuration for a single engine service to the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceConfig - all values to configure an engine service
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

    • setEngineServicesConfig

      @PostMapping(path="/engine-services/configuration/all") public VoidResponse setEngineServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<EngineServiceConfig> engineServicesConfig)
      Set up the configuration for all the open metadata engine services (OMESs). This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      engineServicesConfig - list of configuration properties for each engine service.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or engineServicesConfig parameter.

    • clearEngineDefinitionsClientConfig

      @DeleteMapping(path="/engine-definitions/client-config") public VoidResponse clearEngineDefinitionsClientConfig(@PathVariable String userId, @PathVariable String serverName)
      Remove the configuration for the Governance Engine OMAS Engine client configuration in a single call. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • clearEngineList

      @DeleteMapping(path="/engine-list") public VoidResponse clearEngineList(@PathVariable String userId, @PathVariable String serverName)
      Remove the configuration for the engine list in a single call. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • clearAllEngineServices

      @DeleteMapping(path="/engine-services") public VoidResponse clearAllEngineServices(@PathVariable String userId, @PathVariable String serverName)
      Disable the engine services. This removes all configuration for the engine services in the engine host.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or OMAGConfigurationErrorException unusual state in the admin server.

    • clearEngineService

      @DeleteMapping(path="/engine-services/{serviceURLMarker}") public VoidResponse clearEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Remove an engine service. This removes all configuration for the engine service. Other configured engine services are untouched.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - engine service name used in URL
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

    • getEngineHostServicesConfiguration

      @GetMapping({"/engine-host-services/configuration","/engine-host-services"}) public EngineHostServicesResponse getEngineHostServicesConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the configuration of the specialist services for an Engine Host OMAG Server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the engine host services configuration

    • setEngineHostServicesConfig

      @PostMapping(path="/engine-host-services") public VoidResponse setEngineHostServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody EngineHostServicesConfig servicesConfig)
      Set up the configuration of the specialist services for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      servicesConfig - full configuration for the engine host server.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • clearEngineHostServicesConfig

      @DeleteMapping(path="/engine-host-services") public VoidResponse clearEngineHostServicesConfig(@PathVariable String userId, @PathVariable String serverName)
      Remove the configuration of the specialist services for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.