Package org.odpi.openmetadata.integrationservices.lineage.client

Class LineageIntegrator

java.lang.Object
org.odpi.openmetadata.integrationservices.lineage.client.LineageIntegrator
All Implemented Interfaces:
org.odpi.openmetadata.integrationservices.lineage.api.LineageIntegratorAPI
public class LineageIntegrator extends Object implements org.odpi.openmetadata.integrationservices.lineage.api.LineageIntegratorAPI
LineageIntegrator is the client library for the Lineage Integrator OMIS's REST API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LineageIntegrator(String serverName, String serverPlatformRootURL)
    Create a new client with no authentication embedded in the HTTP request.
    LineageIntegrator(String serverName, String serverPlatformRootURL, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    LineageIntegrator(String serverName, String serverPlatformRootURL, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    LineageIntegrator(String serverName, String serverPlatformRootURL, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • 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.
    void
    publishOpenLineageEvent(String userId, String event)
    Pass an open lineage event to the integration service.
    org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport
    validateConnector(String userId, String connectorProviderClassName)
    Validate the connector and return its connector type.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LineageIntegrator

      public LineageIntegrator(String serverName, String serverPlatformRootURL, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • LineageIntegrator

      public LineageIntegrator(String serverName, String serverPlatformRootURL) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • LineageIntegrator

      public LineageIntegrator(String serverName, String serverPlatformRootURL, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • LineageIntegrator

      public LineageIntegrator(String serverName, String serverPlatformRootURL, String userId, String password) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • validateConnector

      public org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport validateConnector(String userId, String connectorProviderClassName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Validate the connector and return its connector type.
      Specified by:
      validateConnector in interface org.odpi.openmetadata.integrationservices.lineage.api.LineageIntegratorAPI
      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.openmetadata.ffdc.InvalidParameterException - the connector provider class name is not a valid connector fo this service
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem processing the request

    • publishOpenLineageEvent

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

    • publishOpenLineageEvent

      public void publishOpenLineageEvent(String userId, String event) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.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.
      Specified by:
      publishOpenLineageEvent in interface org.odpi.openmetadata.integrationservices.lineage.api.LineageIntegratorAPI
      Parameters:
      userId - calling user
      event - open lineage event to publish.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the caller is not authorized to call the service
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem processing the request