Package org.odpi.openmetadata.frameworks.integration.connectors

Class DynamicIntegrationConnectorBase

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

org.odpi.openmetadata.frameworks.integration.connectors.DynamicIntegrationConnectorBase

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, CatalogTargetFactory, IntegrationConnector

Direct Known Subclasses:

DistributeAuditEventsFromKafkaConnector, HarvestOpenMetadataConnector, HarvestSurveysConnector, JDBCIntegrationConnector, KafkaTopicIntegrationConnector, OpenLineageEventReceiverIntegrationConnector, OpenMetadataProductsHarvesterConnector, OSSUnityCatalogInsideCatalogSyncConnector, OSSUnityCatalogServerSyncConnector, PostgresServerIntegrationConnector

public abstract class DynamicIntegrationConnectorBase
extends IntegrationConnectorBase
implements CatalogTargetFactory

DynamicIntegrationConnectorBase supports the common methods for a connector that works with catalog targets. The open metadata ecosystem is the home copy so its values will be pushed to the database. The database design matches the beans returned by theOpen Metadata Store.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	lastRefreshCompleteTime

Fields inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

auditLog, catalogTargetsManager, connectorName, integrationContext, propertyHelper

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

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
DynamicIntegrationConnectorBase()

Method Summary

Modifier and Type	Method	Description
abstract RequestedCatalogTarget	getNewRequestedCatalogTargetSkeleton(CatalogTarget retrievedCatalogTarget, CatalogTargetContext catalogTargetContext, Connector connectorToTarget)	Create a new catalog target processor (typically inherits from CatalogTargetProcessorBase).
void	processEvent(OpenMetadataOutTopicEvent event)	Process an event that was published by the OMF Services.
void	refresh()	Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

disconnect, engage, getConnectorComponentDescription, getNetworkAddress, passEventToCatalogTargets, refreshCatalogTargets, setAuditLog, setConnectorName, setContext, start

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

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Field Details

lastRefreshCompleteTime

protected Date lastRefreshCompleteTime

Constructor Details

DynamicIntegrationConnectorBase

public DynamicIntegrationConnectorBase()

Method Details

refresh

public void refresh()
             throws ConnectorCheckedException,
UserNotAuthorizedException

Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories. Refresh is called when the integration connector first starts and then at intervals defined in the connector's configuration as well as any external REST API calls to explicitly refresh the connector.

Specified by:

refresh in interface IntegrationConnector

Throws:

ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.

UserNotAuthorizedException - the connector has been disconnected

getNewRequestedCatalogTargetSkeleton

public abstract RequestedCatalogTarget getNewRequestedCatalogTargetSkeleton(CatalogTarget retrievedCatalogTarget,
 CatalogTargetContext catalogTargetContext,
 Connector connectorToTarget)
                                                                     throws ConnectorCheckedException,
UserNotAuthorizedException

Create a new catalog target processor (typically inherits from CatalogTargetProcessorBase).

Specified by:

getNewRequestedCatalogTargetSkeleton in interface CatalogTargetFactory

Parameters:

retrievedCatalogTarget - details of the open metadata elements describing the catalog target

catalogTargetContext - specialized context for this catalog target

connectorToTarget - connector to access the target resource

Returns:

new processor based on the catalog target information

Throws:

ConnectorCheckedException - there is a problem with setting up the catalog target.

UserNotAuthorizedException - the connector has been disconnected

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

Process an event that was published by the OMF Services.

Parameters:

event - event object - call getEventType to find out what type of event.