Package org.odpi.openmetadata.adminservices.spring

Class ConfigIntegrationGroupsResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigIntegrationGroupsResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}") public class ConfigIntegrationGroupsResource extends Object
ConfigIntegrationGroupsResource provides the configuration for setting up a list of integration groups for an integration daemon.

  • Constructor Details

    • ConfigIntegrationGroupsResource

      public ConfigIntegrationGroupsResource()

  • Method Details

    • getIntegrationGroupsConfiguration

      @GetMapping("/integration-groups/configuration") public org.odpi.openmetadata.adminservices.rest.IntegrationGroupsResponse getIntegrationGroupsConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the integration groups configuration for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the integration groups configuration

    • configureIntegrationGroup

      @PostMapping(path="/integration-groups/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationGroup(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.IntegrationGroupConfig groupConfig)
      Add configuration for a single integration group to the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      groupConfig - all 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

      @PostMapping(path="/integration-groups/configuration/all") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setIntegrationGroupsConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.adminservices.configuration.properties.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

      @DeleteMapping(path="/integration-groups") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAllIntegrationGroups(@PathVariable String userId, @PathVariable String serverName)
      Disable the integration groups. This removes all configuration for the integration groups from the integration 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.

    • clearIntegrationGroup

      @DeleteMapping(path="/integration-groups/{groupQualifiedName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearIntegrationGroup(@PathVariable String userId, @PathVariable String serverName, @PathVariable String groupQualifiedName)
      Remove an integration group. This removes all configuration for the integration group.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      groupQualifiedName - integration group name used in URL
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.