Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForEngineHostServices

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

  • Constructor Details

    • OMAGServerAdminForEngineHostServices

      public OMAGServerAdminForEngineHostServices()
      Default constructor

  • Method Details

    • addEngine

      public VoidResponse addEngine(String serverName, 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:
      serverName - local server name.
      engine - new 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

      public EngineHostServicesResponse getEngineHostServicesConfiguration(String serverName)
      Return the engine host services configuration including the list of engine services that are configured for this server.
      Parameters:
      serverName - name of server
      Returns:
      engine host services configuration

    • setEngineHostServicesConfig

      public VoidResponse setEngineHostServicesConfig(String serverName, List<EngineConfig> governanceEngines)
      Set up the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      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

      public VoidResponse clearEngineHostServicesConfig(String serverName)
      Remove the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      Returns:
      void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.