Package org.odpi.openmetadata.adminservices.spring

Class ConfigIntegrationDaemonServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigIntegrationDaemonServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}") public class ConfigIntegrationDaemonServicesResource extends Object
ConfigIntegrationServicesResource provides the configuration for setting up the Open Metadata Integration Services (OMISs).

  • Constructor Details

    • ConfigIntegrationDaemonServicesResource

      public ConfigIntegrationDaemonServicesResource()

  • Method Details

    • getIntegrationGroupsConfiguration

      @GetMapping("/integration-groups/configuration") public 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 VoidResponse configureIntegrationGroup(@PathVariable String userId, @PathVariable String serverName, @RequestBody 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 VoidResponse setIntegrationGroupsConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody 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

      @DeleteMapping(path="/integration-groups") public 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 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.

    • getRegisteredIntegrationServices

      @GetMapping("/integration-services") public RegisteredOMAGServicesResponse getRegisteredIntegrationServices(@PathVariable String userId, @PathVariable String serverName)
      Return the list of registered integration services for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      list of integration service descriptions

    • getIntegrationServicesConfiguration

      @GetMapping("/integration-services/configuration") public IntegrationServicesResponse getIntegrationServicesConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the integration services configuration for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the integration services configuration

    • getIntegrationServiceConfiguration

      @GetMapping("/integration-services/{serviceURLMarker}/configuration") public IntegrationServiceConfigResponse getIntegrationServiceConfiguration(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Return the configuration for the named integration service for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      serviceURLMarker - integration service name used in URL
      Returns:
      response containing the integration services configuration

    • configureIntegrationService

      @PostMapping(path="/integration-services/{serviceURLMarker}") public VoidResponse configureIntegrationService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker, @RequestBody IntegrationServiceRequestBody requestBody)
      Enable a single registered integration service. This builds the integration service configuration for the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - string indicating which integration service it is configuring
      requestBody - minimum values to configure an integration service
      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.

    • configureAllIntegrationServices

      @PostMapping(path="/integration-services") public VoidResponse configureAllIntegrationServices(@PathVariable String userId, @PathVariable String serverName, @RequestBody IntegrationServiceRequestBody requestBody)
      Enable all non-deprecated integration services. This builds the integration service 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 service
      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.

    • configureIntegrationService

      @PostMapping(path="/integration-services/configuration") public VoidResponse configureIntegrationService(@PathVariable String userId, @PathVariable String serverName, @RequestBody IntegrationServiceConfig serviceConfig)
      Add configuration for a single integration service to the server's config document.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceConfig - all values to configure an integration service
      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.

    • setIntegrationServicesConfig

      @PostMapping(path="/integration-services/configuration/all") public VoidResponse setIntegrationServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<IntegrationServiceConfig> integrationServicesConfig)
      Set up the configuration for all the open metadata integration services (OMISs). This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      integrationServicesConfig - list of configuration properties for each integration service.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or integrationServicesConfig parameter.

    • clearAllIntegrationServices

      @DeleteMapping(path="/integration-services") public VoidResponse clearAllIntegrationServices(@PathVariable String userId, @PathVariable String serverName)
      Disable the integration services. This removes all configuration for the integration services 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.

    • clearIntegrationService

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

    • getIntegrationDaemonServicesConfiguration

      @GetMapping("/integration-daemon-services") public IntegrationDaemonServicesResponse getIntegrationDaemonServicesConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the configuration of the specialist services for an Integration Daemon OMAG Server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the integration daemon services configuration

    • setIntegrationDaemonServicesConfig

      @PostMapping(path="/integration-daemon-services") public VoidResponse setIntegrationDaemonServicesConfig(@PathVariable String userId, @PathVariable String serverName, @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:
      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

      @DeleteMapping(path="/integration-daemon-services") public VoidResponse clearIntegrationDaemonServicesConfig(@PathVariable String userId, @PathVariable String serverName)
      Remove the configuration of the specialist services 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.