Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForEngineHostServices

java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminForEngineHostServices
public class OMAGServerAdminForEngineHostServices extends Object
OMAGServerAdminForEngineServices provides the server-side support for the services that add engine services configuration to an OMAG Server.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OMAGServerAdminForEngineHostServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addEngine(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.EngineConfig engine)
    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.
    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
    clearEngineList(String userId, String serverName)
    Remove the configuration for the governance engines 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
    configureAllEngineServices(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.EngineServiceRequestBody requestBody)
    Enable all non-deprecated engine services.
    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 engine services that are configured for this server.
    org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse
    getEngineHostServicesConfiguration(String userId, String serverName)
    Return the engine host services configuration including the list of engine services that are configured for this server.
    org.odpi.openmetadata.adminservices.rest.EngineServiceConfigResponse
    getEngineServiceConfiguration(String userId, String serverName, String serviceURLMarker)
    Return the configuration for the requested engine service that is configured 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
    setEngineList(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.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.
    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 (OMESs).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OMAGServerAdminForEngineHostServices

      public OMAGServerAdminForEngineHostServices()
      Default constructor

  • Method Details

    • setEngineDefinitionsClientConfig

      public 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.
      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.

    • clearEngineDefinitionsClientConfig

      public 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. 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.

    • setEngineList

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setEngineList(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.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
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addEngine(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.EngineConfig engine)
      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.
      engine - new 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.

    • clearEngineList

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEngineList(String userId, String serverName)
      Remove the configuration for the governance engines 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.

    • getEngineServiceConfiguration

      public org.odpi.openmetadata.adminservices.rest.EngineServiceConfigResponse getEngineServiceConfiguration(String userId, String serverName, String serviceURLMarker)
      Return the configuration for the requested engine service that is configured for this server.
      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 or serviceURLMarker parameter.

    • getConfiguredEngineServices

      public org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse getConfiguredEngineServices(String userId, String serverName)
      Return the list of engine services that are configured for this server. If you want to see the configuration for these services, use the getEngineHostServicesConfiguration.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      list of engine service descriptions

    • configureEngineService

      public 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. 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 - engine service name used in URL
      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

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureAllEngineServices(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.EngineServiceRequestBody requestBody)
      Enable all non-deprecated engine services. 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

      public 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.
      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

      public 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 (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.

    • clearAllEngineServices

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAllEngineServices(String userId, String serverName)
      Disable the engine services. This removes all configuration for the engine services and disables the enterprise repository services.
      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.

    • clearEngineService

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEngineService(String userId, String serverName, 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.

    • getEngineHostServicesConfiguration

      public org.odpi.openmetadata.adminservices.rest.EngineHostServicesResponse getEngineHostServicesConfiguration(String userId, String serverName)
      Return the engine host services configuration including the list of engine services that are configured for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      engine host services configuration

    • setEngineHostServicesConfig

      public 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. 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

      public 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. 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.