Package org.odpi.openmetadata.adapters.connectors.nannyconnectors.harvestsurveys

Class HarvestSurveysConnector

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.adapters.connectors.nannyconnectors.harvestsurveys.HarvestSurveysConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, CatalogTargetEventProcessor, CatalogTargetIntegrator, IntegrationConnector, OpenMetadataEventListener

public class HarvestSurveysConnector
extends IntegrationConnectorBase
implements CatalogTargetIntegrator, OpenMetadataEventListener, CatalogTargetEventProcessor

HarvestSurveysConnector extracts relevant metadata from the open metadata ecosystem into the Observations database. 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 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
HarvestSurveysConnector()

Method Summary

Modifier and Type	Method	Description
RequestedCatalogTarget	getNewRequestedCatalogTargetSkeleton(CatalogTarget retrievedCatalogTarget, CatalogTargetContext catalogTargetContext, Connector connectorToTarget)	Create a new catalog target processor (typically inherits from CatalogTargetProcessorBase).
void	integrateCatalogTarget(RequestedCatalogTarget requestedCatalogTarget)	Perform the required integration logic for the assigned catalog target.
void	passEventToCatalogTarget(RequestedCatalogTarget requestedCatalogTarget, OpenMetadataOutTopicEvent event)	Perform the required integration logic for the assigned catalog target.
void	processEvent(OpenMetadataOutTopicEvent event)	Process an event that was published by the Asset Manager OMAS.
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, registerCatalogTargetChangeListener, 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

Constructor Details

HarvestSurveysConnector

public HarvestSurveysConnector()

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 interface IntegrationConnector

Throws:

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

integrateCatalogTarget

public void integrateCatalogTarget(RequestedCatalogTarget requestedCatalogTarget)
                            throws ConnectorCheckedException

Perform the required integration logic for the assigned catalog target.

Specified by:

integrateCatalogTarget in interface CatalogTargetIntegrator

Parameters:

requestedCatalogTarget - the catalog target

Throws:

ConnectorCheckedException - there is an unrecoverable error and the connector should stop processing.

getNewRequestedCatalogTargetSkeleton

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

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

Specified by:

getNewRequestedCatalogTargetSkeleton in interface CatalogTargetIntegrator

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 - problem setting up target

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

Process an event that was published by the Asset Manager OMAS. Only process new surveys

Specified by:

processEvent in interface OpenMetadataEventListener

Parameters:

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

passEventToCatalogTarget

public void passEventToCatalogTarget(RequestedCatalogTarget requestedCatalogTarget,
 OpenMetadataOutTopicEvent event)

Perform the required integration logic for the assigned catalog target.

Specified by:

passEventToCatalogTarget in interface CatalogTargetEventProcessor

Parameters:

requestedCatalogTarget - the catalog target

event - event to process