Package org.odpi.openmetadata.adapters.connectors.apachekafka.integration

Class KafkaTopicCatalogTargetProcessor

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.connectors.CatalogTargetProperties

org.odpi.openmetadata.frameworks.opengovernance.properties.CatalogTarget

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

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

org.odpi.openmetadata.adapters.connectors.apachekafka.integration.KafkaTopicCatalogTargetProcessor

public class KafkaTopicCatalogTargetProcessor
extends CatalogTargetProcessorBase

KafkaTopicIntegrationConnector catalogues active topics in a kafka broker.

Field Summary

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

auditLog, connectorName, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

connectorToTarget, integrationContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	refresh()	Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.
void	refreshEventBroker(String targetRootURL, String templateGUID, String templateQualifiedName)	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.CatalogTargetProcessorBase

getDateConfigurationProperty, getStringConfigurationProperty

Methods inherited from class org.odpi.openmetadata.frameworks.integration.properties.RequestedCatalogTarget

equals, getConnectorToTarget, getIntegrationContext, hashCode, toString

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

getCatalogTargetElement, getRelationshipGUID, getRelationshipVersions, setCatalogTargetElement, setRelationshipGUID, setRelationshipVersions

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.connectors.CatalogTargetProperties

getCatalogTargetName, getConfigurationProperties, getConnectionName, getDeleteMethod, getMetadataSourceQualifiedName, getPermittedSynchronization, getTemplates, setCatalogTargetName, setConfigurationProperties, setConnectionName, setDeleteMethod, setMetadataSourceQualifiedName, setPermittedSynchronization, setTemplates

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties

getExtendedProperties, getTypeName, setExtendedProperties, setTypeName

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

getEffectiveFrom, getEffectiveTo, setEffectiveFrom, setEffectiveTo

Methods inherited from class java.lang.Object

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

Constructor Details

KafkaTopicCatalogTargetProcessor

public KafkaTopicCatalogTargetProcessor(CatalogTarget template,
 CatalogTargetContext catalogTargetContext,
 Connector connectorToTarget,
 String connectorName,
 AuditLog auditLog)
                                 throws ConnectorCheckedException,
UserNotAuthorizedException

Copy/clone constructor

Parameters:

template - object to copy

catalogTargetContext - specialized context for this catalog target

connectorToTarget - connector to access the target resource

connectorName - name of this integration connector

auditLog - logging destination

Throws:

ConnectorCheckedException - problem connecting to topic

UserNotAuthorizedException - the connector was disconnected before/during start

Method Details

refresh

public 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.

Specified by:

refresh in class CatalogTargetProcessorBase

Throws:

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

refreshEventBroker

public void refreshEventBroker(String targetRootURL,
 String templateGUID,
 String templateQualifiedName)
                        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. This method performs two sweeps. It first retrieves the topics from the event broker (Kafka) and validates that are in the catalog - adding or updating them if necessary. The second sweep is to ensure that all the topics catalogued actually exist in the event broker.

Parameters:

targetRootURL - URL to the Kafka Broker

templateGUID - optional template to use when creating new topics

templateQualifiedName - qualifiedName for template - only set if templateGUID is set

Throws:

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