Package org.odpi.openmetadata.adminservices.spring

Class ConfigEngineServicesResource

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigEngineServicesResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAllEngineServices(String userId, String serverName)
    Disable the engine services.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEngineDefinitionsClientConfig(String userId, String serverName)
    Remove the configuration for the Governance Engine OMAS Engine client configuration in a single call.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEngineHostServicesConfig(String userId, String serverName)
    Remove the configuration for an Engine Host OMAG Server in a single call.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEngineService(String userId, String serverName, String serviceURLMarker)
    Remove an engine service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureEngineService(String userId, String serverName, String serviceURLMarker, org.odpi.openmetadata.adminservices.rest.EngineServiceRequestBody requestBody)
    Enable a single registered engine service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureEngineService(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig serviceConfig)
    Add configuration for a single engine service to the server's config document.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getConfiguredEngineServices(String userId, String serverName)
    Return the list of registered engine services for this server.
    org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse
    getEngineHostServicesConfiguration(String userId, String serverName)
    Return the configuration for the complete engine host services in this server.
    org.odpi.openmetadata.adminservices.rest.EngineServiceConfigResponse
    getEngineServiceConfiguration(String userId, String serverName, String serviceURLMarker)
    Return the configuration for the named engine service for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setEngineDefinitionsClientConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setEngineHostServicesConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.EngineHostServicesConfig servicesConfig)
    Set up the configuration for an Engine Host OMAG Server in a single call.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setEngineServicesConfig(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig> engineServicesConfig)
    Set up the configuration for all the open metadata engine services (OMISs).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigEngineServicesResource

      public ConfigEngineServicesResource()

  • Method Details

    • getConfiguredEngineServices

      @GetMapping("/engine-services") public org.odpi.openmetadata.commonservices.ffdc.rest.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

    • getEngineHostServicesConfiguration

      @GetMapping("/engine-host-services/configuration") public org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse getEngineHostServicesConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the configuration for the complete engine host services in this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the engine host services configuration

    • getEngineServiceConfiguration

      @GetMapping("/engine-services/{serviceURLMarker}/configuration") public org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setEngineDefinitionsClientConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.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.

    • configureEngineService

      @PostMapping(path="/engine-services/{serviceURLMarker}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker, @RequestBody org.odpi.openmetadata.adminservices.rest.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.

    • configureEngineService

      @PostMapping(path="/engine-services/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureEngineService(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setEngineServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.adminservices.configuration.properties.EngineServiceConfig> engineServicesConfig)
      Set up the configuration for all the open metadata engine services (OMISs). 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.

    • setEngineHostServicesConfig

      @PostMapping(path="/engine-host-services") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setEngineHostServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.EngineHostServicesConfig servicesConfig)
      Set up the configuration 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEngineHostServicesConfig(@PathVariable String userId, @PathVariable String serverName)
      Remove the configuration 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.

    • clearEngineDefinitionsClientConfig

      @DeleteMapping(path="/engine-definitions/client-config") public org.odpi.openmetadata.commonservices.ffdc.rest.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.

    • clearAllEngineServices

      @DeleteMapping(path="/engine-services") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAllEngineServices(@PathVariable String userId, @PathVariable String serverName)
      Disable the engine services. This removes all configuration for the engine services nad hence the engine daemon.
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Remove an engine service. This removes all configuration for the engine service.
      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.