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

Class IntegrationDaemonRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.governanceservers.integrationdaemonservices.server.IntegrationDaemonRESTServices
public class IntegrationDaemonRESTServices extends TokenController
IntegrationDaemonRESTServices provides the external service implementation for an integration service and integration group. The IntegrationDaemonRESTServices locates the correct integration service/group instance within the correct integration daemon instance and delegates the request.

  • Constructor Details

    • IntegrationDaemonRESTServices

      public IntegrationDaemonRESTServices()

  • Method Details

    • validateConnector

      public ConnectorReportResponse validateConnector(String serverName, String delegatingUserId, String connectorProviderClassName)
      Validate the connector and return its connector type.
      Parameters:
      serverName - integration daemon server name
      connectorProviderClassName - name of a specific connector or null for all connectors
      delegatingUserId - external userId making request
      Returns:
      connector report or InvalidParameterException the connector provider class name is not a valid connector fo this service UserNotAuthorizedException user not authorized to issue this request PropertyServerException there was a problem detected by the integration service

    • publishOpenLineageEvent

      public VoidResponse publishOpenLineageEvent(String serverName, String delegatingUserId, String event)
      Pass an open lineage event to the integration service. It will pass it on to the integration connectors that have registered a listener for open lineage events.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      event - open lineage event to publish.

    • getConfigurationProperties

      public PropertiesResponse getConfigurationProperties(String serverName, String delegatingUserId, String connectorName)
      Retrieve the configuration properties of the named connector.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      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

      public VoidResponse updateConfigurationProperties(String serverName, String delegatingUserId, ConnectorConfigPropertiesRequestBody requestBody)
      Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      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

      public VoidResponse updateEndpointNetworkAddress(String serverName, String delegatingUserId, String connectorName, StringRequestBody requestBody)
      Update the endpoint network address for a specific integration connector.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      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

      public VoidResponse updateConnectorConnection(String serverName, String delegatingUserId, String connectorName, Connection requestBody)
      Update the connection for a specific integration connector.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      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

      public VoidResponse refreshConnectors(String serverName, String delegatingUserId, NameRequestBody requestBody)
      Request that the integration daemon refresh all the connectors in all the integration services and groups
      Parameters:
      serverName - name of the integration daemon
      delegatingUserId - external userId making request
      requestBody - null request body
      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.

    • restartConnectors

      public VoidResponse restartConnectors(String serverName, String delegatingUserId, NameRequestBody requestBody)
      Request that the integration daemon restart all the connectors in all the integration services and groups
      Parameters:
      serverName - name of the integration daemon
      delegatingUserId - external userId making request
      requestBody - null request body
      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.

    • getIntegrationDaemonStatus

      public IntegrationDaemonStatusResponse getIntegrationDaemonStatus(String serverName, String delegatingUserId)
      Return a summary of each of the integration services' and integration groups' status.
      Parameters:
      serverName - integration daemon name
      delegatingUserId - external userId making request
      Returns:
      list of statuses - on for each assigned integration services or 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.

    • refreshIntegrationGroupConfig

      public VoidResponse refreshIntegrationGroupConfig(String serverName, String delegatingUserId, String integrationGroupName)
      Request that the integration group refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server.
      delegatingUserId - external userId making request
      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.

    • getIntegrationGroupSummary

      public IntegrationGroupSummaryResponse getIntegrationGroupSummary(String serverName, String delegatingUserId, String integrationGroupName)
      Return a summary of the requested engine's status.
      Parameters:
      serverName - name of the server tied to the request
      delegatingUserId - external userId making request
      integrationGroupName - qualifiedName of the requested integration group
      Returns:
      list of integration group summaries or InvalidParameterException no available instance for the requested server UserNotAuthorizedException user does not have access to the requested server PropertyServerException the service name is not known - indicating a logic error

    • getIntegrationGroupSummaries

      public IntegrationGroupSummariesResponse getIntegrationGroupSummaries(String serverName, String delegatingUserId)
      Return a summary of each of the integration groups' status for all running engine services.
      Parameters:
      serverName - integration daemon server name
      delegatingUserId - external userId making request
      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