Package org.odpi.openmetadata.integrationservices.lineage.contextmanager

Class LineageIntegratorContextManager

java.lang.Object
org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager
org.odpi.openmetadata.integrationservices.lineage.contextmanager.LineageIntegratorContextManager
All Implemented Interfaces:
org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageListenerManager
public class LineageIntegratorContextManager extends org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager implements org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageListenerManager
LineageIntegratorContextManager provides the bridge between the integration daemon services and the specific implementation of an integration service.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LineageIntegratorContextManager()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createClients(int maxPageSize)
    Suggestion for subclass to create client(s) to partner OMAS.
    void
    initializeContextManager(String partnerOMASServerName, String partnerOMASPlatformRootURL, String userId, String password, Map<String,Object> serviceOptions, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Initialize server properties for the context manager.
    void
    publishOpenLineageRunEvent(String rawEvent)
    Pass the incoming openLineage event to all connectors that are listening.
    void
    publishOpenLineageRunEvent(org.odpi.openmetadata.integrationservices.lineage.properties.OpenLineageRunEvent event)
    Pass the incoming openLineage event to all connectors that are listening.
    void
    registerListener(org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageEventListener listener)
    The listener is implemented by the integration connector.
    org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
    setContext(String connectorId, String connectorName, String connectorUserId, org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnector integrationConnector, String integrationConnectorGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.PermittedSynchronization permittedSynchronization, boolean generateIntegrationReport, String metadataSourceQualifiedName)
    Set up the context in the supplied connector.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LineageIntegratorContextManager

      public LineageIntegratorContextManager()
      Default constructor

  • Method Details

    • initializeContextManager

      public void initializeContextManager(String partnerOMASServerName, String partnerOMASPlatformRootURL, String userId, String password, Map<String,Object> serviceOptions, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Initialize server properties for the context manager.
      Overrides:
      initializeContextManager in class org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager
      Parameters:
      partnerOMASServerName - name of the server to connect to
      partnerOMASPlatformRootURL - 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
      serviceOptions - options from the integration service's configuration
      maxPageSize - maximum number of results that can be returned on a single REST call
      auditLog - logging destination

    • createClients

      public void createClients(int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Suggestion for subclass to create client(s) to partner OMAS.
      Overrides:
      createClients in class org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager
      Parameters:
      maxPageSize - maximum value allowed for page size
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the subclass is not able to create one of its clients

    • setContext

      public org.odpi.openmetadata.frameworks.integration.context.IntegrationContext setContext(String connectorId, String connectorName, String connectorUserId, org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnector integrationConnector, String integrationConnectorGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.PermittedSynchronization permittedSynchronization, boolean generateIntegrationReport, String metadataSourceQualifiedName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Set up the context in the supplied connector. This is called between initialize() and start() on the connector.
      Overrides:
      setContext in class org.odpi.openmetadata.frameworks.integration.contextmanager.IntegrationContextManager
      Parameters:
      connectorId - unique identifier of the connector (used to configure the event listener)
      connectorName - name of connector from config
      connectorUserId - userId for the connector
      integrationConnector - connector created from connection integration service configuration
      integrationConnectorGUID - unique identifier of the integration connector entity (only set if working with integration groups)
      permittedSynchronization - controls the direction(s) that metadata is allowed to flow
      generateIntegrationReport - should the connector generate an integration reports?
      metadataSourceQualifiedName - unique name of the software server capability that represents the metadata source.
      Returns:
      the new integration context
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the connector is not of the correct type
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • registerListener

      public void registerListener(org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageEventListener listener)
      The listener is implemented by the integration connector. Once it is registered with the context, its processOpenLineageRunEvent() method is called each time an open lineage event is published to the Lineage Integrator OMIS.
      Specified by:
      registerListener in interface org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageListenerManager
      Parameters:
      listener - listener to call

    • publishOpenLineageRunEvent

      public void publishOpenLineageRunEvent(String rawEvent)
      Pass the incoming openLineage event to all connectors that are listening.
      Specified by:
      publishOpenLineageRunEvent in interface org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageListenerManager
      Parameters:
      rawEvent - JSON payload containing the open lineage event

    • publishOpenLineageRunEvent

      public void publishOpenLineageRunEvent(org.odpi.openmetadata.integrationservices.lineage.properties.OpenLineageRunEvent event)
      Pass the incoming openLineage event to all connectors that are listening.
      Specified by:
      publishOpenLineageRunEvent in interface org.odpi.openmetadata.integrationservices.lineage.connector.OpenLineageListenerManager
      Parameters:
      event - JSON payload containing the open lineage event