Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForIntegrationGroups

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

  • Constructor Details

    • OMAGServerAdminForIntegrationGroups

      public OMAGServerAdminForIntegrationGroups()
      Default constructor

  • Method Details

    • getIntegrationGroupsConfiguration

      public org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationGroup(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setIntegrationGroupsConfig(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.IntegrationGroupConfig> integrationGroupsConfig)
      Set up the configuration for all the open metadata integration groups (OMISs). 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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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.