Package org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic

Class OpenMetadataTopicConnector

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicConnector
All Implemented Interfaces:
Runnable, org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, OpenMetadataTopic
public abstract class OpenMetadataTopicConnector extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements OpenMetadataTopic, Runnable, org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
OpenMetadataTopicConnector provides the support for the registration of listeners and the distribution of incoming events to the registered listeners. An implementation of the OpenMetadataTopicConnector needs to extend this class to include the interaction with the eventing/messaging layer.
  • For inbound events it should call the protected distributeEvents() method.
  • For outbound events, callers will invoke the sendEvent() method.
  • When the server no longer needs the topic, it will call disconnect().

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    org.odpi.openmetadata.frameworks.connectors.ConnectorBase.ProtectedConnection

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.odpi.openmetadata.frameworks.auditlog.AuditLog
    auditLog
     

    Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMetadataTopicConnector()
    Simple constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<String>
    checkForEvents()
    Deprecated.
    Use checkForIncomingEvents() instead.
    protected List<IncomingEvent>
    checkForIncomingEvents()
    Look to see if there is one of more new events to process.
    void
    disconnect()
    Free up any resources held since the connector is no longer needed.
    org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
    getConnectorComponentDescription()
    Return the component description that is used by this connector in the audit log.
    String
    registerListener(OpenMetadataTopicListener topicListener)
    Register a listener object.
    void
    run()
    This is the method called by the listener thread when it starts.
    void
    setAuditLog(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Receive an audit log object that can be used to record audit log messages.
    void
    start()
    Indicates that the connector is completely configured and can begin processing.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, toString

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

    clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic

    sendEvent

  • Field Details

    • auditLog

      protected org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog

  • Constructor Details

    • OpenMetadataTopicConnector

      public OpenMetadataTopicConnector()
      Simple constructor

  • Method Details

    • setAuditLog

      public void setAuditLog(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
      Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.
      Specified by:
      setAuditLog in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Parameters:
      auditLog - audit log object

    • getConnectorComponentDescription

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDescription getConnectorComponentDescription()
      Return the component description that is used by this connector in the audit log.
      Specified by:
      getConnectorComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Returns:
      id, name, description, wiki page URL.

    • run

      public void run()
      This is the method called by the listener thread when it starts.
      Specified by:
      run in interface Runnable

    • checkForIncomingEvents

      protected List<IncomingEvent> checkForIncomingEvents()
      Look to see if there is one of more new events to process.
      Returns:
      a list of received events or null

    • checkForEvents

      @Deprecated protected List<String> checkForEvents()
      Deprecated.
      Use checkForIncomingEvents() instead.
      Checks for events. Only used if checkForIncomingEvents() has not been overridden.
      Returns:
      list of events

    • registerListener

      public String registerListener(OpenMetadataTopicListener topicListener)
      Register a listener object. This object will be supplied with all the events received on the topic.
      Specified by:
      registerListener in interface OpenMetadataTopic
      Parameters:
      topicListener - object implementing the OMRSTopicListener interface
      Returns:
      topic name

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Indicates that the connector is completely configured and can begin processing.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.

    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Free up any resources held since the connector is no longer needed.
      Overrides:
      disconnect in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.