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 Summary

    Constructors
    Constructor
    Description
    ConfigIntegrationDaemonServicesResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAllIntegrationGroups(String userId, String serverName)
    Disable the integration groups.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAllIntegrationServices(String userId, String serverName)
    Disable the integration services.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearIntegrationDaemonServicesConfig(String userId, String serverName)
    Remove the configuration of the specialist services for an Integration Daemon OMAG Server in a single call.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearIntegrationGroup(String userId, String serverName, String groupQualifiedName)
    Remove an integration group.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearIntegrationService(String userId, String serverName, String serviceURLMarker)
    Remove an integration service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureAllIntegrationServices(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.IntegrationServiceRequestBody requestBody)
    Enable all non-deprecated integration services.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureIntegrationGroup(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.IntegrationGroupConfig groupConfig)
    Add configuration for a single integration group to the server's config document.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureIntegrationService(String userId, String serverName, String serviceURLMarker, org.odpi.openmetadata.adminservices.rest.IntegrationServiceRequestBody requestBody)
    Enable a single registered integration service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureIntegrationService(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.IntegrationServiceConfig serviceConfig)
    Add configuration for a single integration service to the server's config document.
    org.odpi.openmetadata.adminservices.rest.IntegrationDaemonServicesResponse
    getIntegrationDaemonServicesConfiguration(String userId, String serverName)
    Return the configuration of the specialist services for an Integration Daemon OMAG Server.
    org.odpi.openmetadata.adminservices.rest.IntegrationGroupsResponse
    getIntegrationGroupsConfiguration(String userId, String serverName)
    Return the integration groups configuration for this server.
    org.odpi.openmetadata.adminservices.rest.IntegrationServiceConfigResponse
    getIntegrationServiceConfiguration(String userId, String serverName, String serviceURLMarker)
    Return the configuration for the named integration service for this server.
    org.odpi.openmetadata.adminservices.rest.IntegrationServicesResponse
    getIntegrationServicesConfiguration(String userId, String serverName)
    Return the integration services configuration for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getRegisteredIntegrationServices(String userId, String serverName)
    Return the list of registered integration services for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setIntegrationDaemonServicesConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.IntegrationDaemonServicesConfig servicesConfig)
    Set up the configuration of the specialist services for an Integration Daemon OMAG Server in a single call.
    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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setIntegrationServicesConfig(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.IntegrationServiceConfig> integrationServicesConfig)
    Set up the configuration for all the open metadata integration services (OMISs).

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ConfigIntegrationDaemonServicesResource

      public ConfigIntegrationDaemonServicesResource()

  • 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.

    • getRegisteredIntegrationServices

      @GetMapping("/integration-services") public org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker, @RequestBody org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureAllIntegrationServices(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationService(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setIntegrationServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setIntegrationDaemonServicesConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.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.