Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForIntegrationDaemonServices

java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminForIntegrationDaemonServices
public class OMAGServerAdminForIntegrationDaemonServices extends Object
OMAGServerAdminForIntegrationDaemonServices provides the server-side support for the services that configure the specialized part of the integration daemon.

  • Constructor Details

    • OMAGServerAdminForIntegrationDaemonServices

      public OMAGServerAdminForIntegrationDaemonServices()
      Default constructor

  • Method Details

    • getIntegrationGroupsConfiguration

      public IntegrationGroupsResponse getIntegrationGroupsConfiguration(String userId, String serverName)
      Return the list of integration groups that are configured for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      list of access service configurations

    • configureIntegrationGroup

      public VoidResponse configureIntegrationGroup(String userId, String serverName, IntegrationGroupConfig requestBody)
      Enable a single registered integration group. This builds the integration group 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 integration group
      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.

    • setIntegrationGroupsConfig

      public VoidResponse setIntegrationGroupsConfig(String userId, String serverName, List<IntegrationGroupConfig> integrationGroupsConfig)
      Set up the configuration for all the open metadata integration groups. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      integrationGroupsConfig - list of configuration properties for each integration group.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or integrationGroupsConfig parameter.

    • clearAllIntegrationGroups

      public VoidResponse clearAllIntegrationGroups(String userId, String serverName)
      Disable the integration groups. This removes all configuration for the integration groups 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.

    • clearIntegrationGroup

      public VoidResponse clearIntegrationGroup(String userId, String serverName, String groupId)
      Remove an integration group. This removes all configuration for the integration group.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      groupId - integration group id
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

    • getIntegrationDaemonServicesConfiguration

      public IntegrationDaemonServicesResponse getIntegrationDaemonServicesConfiguration(String userId, String serverName)
      Return the integration daemon services configuration including the list of integration services and integration services that are configured for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      integration daemon services configuration

    • setIntegrationDaemonServicesConfig

      public VoidResponse setIntegrationDaemonServicesConfig(String userId, String serverName, IntegrationDaemonServicesConfig servicesConfig)
      Set up the configuration for an Integration Daemon 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 integration daemon server.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

    • clearIntegrationDaemonServicesConfig

      public VoidResponse clearIntegrationDaemonServicesConfig(String userId, String serverName)
      Remove the configuration for an Integration Daemon 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.