Package org.odpi.openmetadata.adminservices.spring

Class ConfigIntegrationDaemonServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigIntegrationDaemonServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/servers/{serverName}") public class ConfigIntegrationDaemonServicesResource extends Object
ConfigIntegrationServicesResource provides the configuration for setting up the dynamic integration groups.

  • Constructor Details

    • ConfigIntegrationDaemonServicesResource

      public ConfigIntegrationDaemonServicesResource()

  • Method Details

    • getIntegrationGroupsConfiguration

      @GetMapping("/integration-groups/configuration") public IntegrationGroupsResponse getIntegrationGroupsConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the integration groups configuration for this server.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      response containing the integration groups configuration

    • configureIntegrationGroup

      @PostMapping(path="/integration-groups/configuration") public VoidResponse configureIntegrationGroup(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody IntegrationGroupConfig groupConfig)
      Add configuration for a single integration group to the server's config document.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      groupConfig - all values to configure an integration group
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • setIntegrationGroupsConfig

      @PostMapping(path="/integration-groups/configuration/all") public VoidResponse setIntegrationGroupsConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody List<IntegrationGroupConfig> integrationGroupsConfig)
      Set up the configuration for all the open metadata integration groups. This overrides the current values.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      integrationGroupsConfig - list of configuration properties for each integration group.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or integrationGroupsConfig parameter.

    • clearAllIntegrationGroups

      @DeleteMapping(path="/integration-groups") public VoidResponse clearAllIntegrationGroups(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Disable the integration groups. This removes all configuration for the integration groups from the integration daemon.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter or OMAGConfigurationErrorException unusual state in the admin server.

    • clearIntegrationGroup

      @DeleteMapping(path="/integration-groups/{groupQualifiedName}") public VoidResponse clearIntegrationGroup(@PathVariable String serverName, @PathVariable String groupQualifiedName, @RequestParam(required=false) String delegatingUserId)
      Remove an integration group. This removes all configuration for the integration group.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      groupQualifiedName - integration group name used in URL
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • getIntegrationDaemonServicesConfiguration

      @GetMapping("/integration-daemon-services") public IntegrationDaemonServicesResponse getIntegrationDaemonServicesConfiguration(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the configuration of the specialist services for an Integration Daemon OMAG Server.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      response containing the integration daemon services configuration

    • setIntegrationDaemonServicesConfig

      @PostMapping(path="/integration-daemon-services") public VoidResponse setIntegrationDaemonServicesConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId, @RequestBody IntegrationDaemonServicesConfig servicesConfig)
      Set up the configuration of the specialist services for an Integration Daemon OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      servicesConfig - full configuration for the integration daemon server.
      Returns:
      void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.

    • clearIntegrationDaemonServicesConfig

      @DeleteMapping(path="/integration-daemon-services") public VoidResponse clearIntegrationDaemonServicesConfig(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Remove the configuration of the specialist services for an Integration Daemon OMAG Server in a single call. This overrides the current values.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      Returns:
      void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.