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

Class CatalogTargetProcessorBase

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.properties.CatalogTargetProperties

org.odpi.openmetadata.frameworks.governanceaction.properties.CatalogTarget

org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

org.odpi.openmetadata.frameworks.integration.connectors.CatalogTargetProcessorBase

Direct Known Subclasses:

AuditLogDestinationCatalogTargetProcessor, HarvestOpenMetadataCatalogTargetProcessor, HarvestSurveysCatalogTargetProcessor, KafkaTopicSourceCatalogTargetProcessor, OpenLineageEventReceiverCatalogTargetProcessor

public abstract class CatalogTargetProcessorBase
extends RequestedCatalogTarget

Provides the base class for connector code that processes a single catalog target. When converting an integration connector implementation that does not support catalog targets to one that does, move the core working code into a subclass of this class and implement CatalogTargetIntegrator (and optionally CatalogTargetChangeListener if you need notifications. Ensure you override the getNewRequestedCatalogTargetSkeleton method in CatalogTargetIntegrator to return a new instance of your CatalogTargetProcessorBase class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AuditLog	auditLog
protected final String	connectorName
protected final PropertyHelper	propertyHelper

Constructor Summary

Constructors

Constructor	Description
CatalogTargetProcessorBase(CatalogTarget template, Connector connectorToTarget, String connectorName, AuditLog auditLog)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
protected Date	getDateConfigurationProperty(String propertyName, Map<String,Object> configurationProperties)	Retrieve a configuration property that is a string formatted date or null if not set.
protected String	getStringConfigurationProperty(String propertyName, Map<String,Object> configurationProperties)	Retrieve a configuration property that is a string or null if not set.
abstract 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.properties.RequestedCatalogTarget

equals, getCatalogTargetConnector, hashCode, setCatalogTargetConnector, toString

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.CatalogTarget

getCatalogTargetElement, getRelationshipGUID, getRelationshipVersions, setCatalogTargetElement, setRelationshipGUID, setRelationshipVersions

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.CatalogTargetProperties

getCatalogTargetName, getConfigurationProperties, getConnectionName, getDeleteMethod, getMetadataSourceQualifiedName, getPermittedSynchronization, getTemplateProperties, setCatalogTargetName, setConfigurationProperties, setConnectionName, setDeleteMethod, setMetadataSourceQualifiedName, setPermittedSynchronization, setTemplateProperties

Methods inherited from class java.lang.Object

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

Field Details

connectorName

protected final String connectorName

auditLog

protected final AuditLog auditLog

propertyHelper

protected final PropertyHelper propertyHelper

Constructor Details

CatalogTargetProcessorBase

public CatalogTargetProcessorBase(CatalogTarget template,
 Connector connectorToTarget,
 String connectorName,
 AuditLog auditLog)

Copy/clone constructor

Parameters:

template - object to copy

connectorToTarget - connector to access the target resource

connectorName - name of this integration connector

auditLog - logging destination

Method Details

refresh

public abstract void refresh()
                      throws ConnectorCheckedException

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.

Throws:

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

getStringConfigurationProperty

protected String getStringConfigurationProperty(String propertyName,
 Map<String,Object> configurationProperties)

Retrieve a configuration property that is a string or null if not set.

Parameters:

propertyName - name of property

configurationProperties - configuration properties

Returns:

string value of property or null if not supplied

getDateConfigurationProperty

protected Date getDateConfigurationProperty(String propertyName,
 Map<String,Object> configurationProperties)
                                     throws InvalidParameterException

Retrieve a configuration property that is a string formatted date or null if not set.

Parameters:

propertyName - name of property

configurationProperties - configuration properties

Returns:

string value of property or null if not supplied

Throws:

InvalidParameterException