Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.spring

Class IntegrationDaemonResource

java.lang.Object
org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.spring.IntegrationDaemonResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/integration-daemon/users/{userId}") public class IntegrationDaemonResource extends Object
IntegrationDaemonResource provides the server-side catcher for REST calls using Spring. The integration daemon server routes these requests to the named integration services.

  • Constructor Details

    • IntegrationDaemonResource

      public IntegrationDaemonResource()

  • Method Details

    • getIntegrationDaemonStatus

      @GetMapping(path="/status") public IntegrationDaemonStatusResponse getIntegrationDaemonStatus(@PathVariable String serverName, @PathVariable String userId)
      Return the status of each of the integration services and integration groups running in the integration daemon.
      Parameters:
      serverName - integration daemon name
      userId - calling user
      Returns:
      list of statuses - one for each assigned integration services or integration group InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • getConfigurationProperties

      @GetMapping(path="/integration-connectors/{connectorName}/configuration-properties") public PropertiesResponse getConfigurationProperties(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectorName)
      Retrieve the configuration properties of the named integration connector running in the integration daemon.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      connectorName - name of a specific connector
      Returns:
      properties map or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateConfigurationProperties

      @PostMapping(path="/integration-connectors/configuration-properties") public VoidResponse updateConfigurationProperties(@PathVariable String serverName, @PathVariable String userId, @RequestBody ConnectorConfigPropertiesRequestBody requestBody)
      Update the configuration properties of the integration connectors, or specific integration connector if a connector name is supplied. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      requestBody - name of a specific connector or null for all connectors and the properties to change
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateEndpointNetworkAddress

      @PostMapping(path="/integration-connectors/{connectorName}/endpoint-network-address") public VoidResponse updateEndpointNetworkAddress(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectorName, @RequestBody StringRequestBody requestBody)
      Update the endpoint network address for a specific integration connector. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      connectorName - name of a specific connector
      requestBody - name of a specific connector or null for all connectors and the properties to change
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateConnectorConnection

      @PostMapping(path="/integration-connectors/{connectorName}/connection") public VoidResponse updateConnectorConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectorName, @RequestBody Connection requestBody)
      Update the connection for a specific integration connector. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      connectorName - name of a specific connector
      requestBody - new connection object
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • refreshConnectors

      @PostMapping(path="/integration-connectors/refresh") public VoidResponse refreshConnectors(@PathVariable String serverName, @PathVariable String userId, @RequestBody(required=false) NameRequestBody requestBody)
      Issue a refresh() request on all connectors running in the integration daemon, or a specific connector if the connector name is specified.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      requestBody - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • restartConnectors

      @PostMapping(path="/integration-connectors/restart") public VoidResponse restartConnectors(@PathVariable String serverName, @PathVariable String userId, @RequestBody(required=false) NameRequestBody requestBody)
      Restart all connectors running in the integration daemon, or restart a specific connector if the connector name is specified.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      requestBody - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • refreshService

      @PostMapping(path="/integration-services/{serviceURLMarker}/refresh") public VoidResponse refreshService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String serviceURLMarker, @RequestBody(required=false) NameRequestBody requestBody)
      Process a refresh request. This calls refresh on all connectors within the integration service.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      serviceURLMarker - integration service identifier
      requestBody - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • restartService

      @PostMapping(path="/integration-services/{serviceURLMarker}/restart") public VoidResponse restartService(@PathVariable String serverName, @PathVariable String userId, @PathVariable String serviceURLMarker, @RequestBody(required=false) NameRequestBody requestBody)
      Request that the integration service shutdown and restart its integration connectors.
      Parameters:
      serverName - name of the integration daemon
      userId - identifier of calling user
      serviceURLMarker - unique name of the integration service
      requestBody - name of a specific connector to restart - if null all connectors are restarted.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • getIntegrationServicesSummaries

      @GetMapping(path="/integration-services/summary") public IntegrationServiceSummaryResponse getIntegrationServicesSummaries(@PathVariable String serverName, @PathVariable String userId)
      Return a summary of each of the integration services' status.
      Parameters:
      serverName - integration daemon name
      userId - calling user
      Returns:
      list of statuses - on for each assigned integration services InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • getIntegrationGroupSummary

      @GetMapping(path="/integration-groups/{integrationGroupName}/summary") public IntegrationGroupSummaryResponse getIntegrationGroupSummary(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupName)
      Retrieve the description and status of the requested integration group.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      integrationGroupName - name of integration group of interest
      Returns:
      list of statuses - on for each assigned integration groups or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

    • getIntegrationGroupSummaries

      @GetMapping(path="/integration-groups/summary") public IntegrationGroupSummariesResponse getIntegrationGroupSummaries(@PathVariable String serverName, @PathVariable String userId)
      Return a summary of each of the integration groups running in the integration daemon.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      Returns:
      list of statuses - one for each assigned integration groups InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

    • refreshIntegrationGroupConfig

      @GetMapping(path="/integration-groups/{integrationGroupName}/refresh-config") public VoidResponse refreshIntegrationGroupConfig(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupName)
      Request that the integration group refresh its configuration by calling the metadata access server. Changes to the connector configuration will result in the affected connectors being restarted. This request is useful if the metadata access server has an outage, particularly while the integration daemon is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server
      userId - identifier of calling user
      integrationGroupName - unique name of the integration group
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or IntegrationGroupException there was a problem detected by the integration group.