- All Implemented Interfaces:
- Direct Known Subclasses:
public abstract class IntegrationConnectorBase extends ConnectorBase implements IntegrationConnector, AuditLoggingComponent, VirtualConnectorExtension
IntegrationConnectorBase is the base class for an integration connector. It manages the storing of the audit log for the connector and provides a default implementation for the abstract engage() method. This method only needs to be overridden by connectors that need to make blocking calls to wait for new metadata.
Nested Class Summary
Field SummaryModifier and TypeFieldDescription
Method SummaryModifier and TypeMethodDescription
voidFree up any resources held since the connector is no longer needed.
engage()This method is for blocking calls to wait for new metadata.Return the component description that is used by this connector in the audit log.
voidSet up the list of connectors that this virtual connector will use to support its interface.
voidReceive an audit log object that can be used to record audit log messages.
voidSet up the connector name for logging.
voidSet up the standard integration context for the connector.
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnectConnectors, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, start, 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
setAuditLogpublic void setAuditLog
(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.
getConnectorComponentDescriptionpublic ComponentDescription getConnectorComponentDescription()Return the component description that is used by this connector in the audit log.
initializeEmbeddedConnectorsSet up the list of connectors that this virtual connector will use to support its interface. The connectors are initialized waiting to start. When start() is called on the virtual connector, it needs to pass start() to each of the embedded connectors. Similarly for disconnect().
setConnectorNamepublic void setConnectorName
(String connectorName)Set up the connector name for logging.
setContextpublic void setContext
(IntegrationContext integrationContext)Set up the standard integration context for the connector.
engagepublic void engage() throws ConnectorCheckedExceptionThis method is for blocking calls to wait for new metadata. It is called from its own thread iff the connector is configured to have its own thread. It is recommended that the implementation returns when each blocking call completes. The integration daemon will pause a second and then call engage() again. This pattern enables the calling thread to detect the shutdown of the integration daemon. This method should be overridden if the connector needs to issue calls that wait for new metadata. If this specific implementation is called a message is logged in the audit log because there is probably a mismatch between the configuration and the connector implementation.
disconnectpublic void disconnect() throws ConnectorCheckedExceptionFree up any resources held since the connector is no longer needed.