Package org.odpi.openmetadata.integrationservices.lineage.api

Interface LineageIntegratorAPI

public interface LineageIntegratorAPI
LineageIntegratorAPI is the interface to call the services provides by the Lineage Integrator OMIS running in an integration daemon.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    publishOpenLineageEvent(String userId, io.openlineage.client.OpenLineage.RunEvent event)
    Pass an open lineage event to the integration service.
    org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport
    validateConnector(String userId, String connectorProviderClassName)
    Validate that a connector is suitable to run in the Lineage Integrator OMIS.

  • Method Details

    • validateConnector

      org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport validateConnector(String userId, String connectorProviderClassName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Validate that a connector is suitable to run in the Lineage Integrator OMIS. It validates that it implements the correct interfaces and returns the connector type for the connector.
      Parameters:
      userId - calling user
      connectorProviderClassName - name of a specific connector or null for all connectors
      Returns:
      connector report for this connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector provider class name is not a valid connector fo this service
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem processing the request

    • publishOpenLineageEvent

      void publishOpenLineageEvent(String userId, io.openlineage.client.OpenLineage.RunEvent event) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      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:
      userId - calling user
      event - open lineage event to publish.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to call the service
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem processing the request