Package org.odpi.openmetadata.adapters.connectors.jacquard

Class JacquardIntegrationConnector

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

org.odpi.openmetadata.adapters.connectors.jacquard.JacquardIntegrationConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, CatalogTargetFactory, IntegrationConnector

public class JacquardIntegrationConnector
extends DynamicIntegrationConnectorBase

OpenMetadataProductsHarvesterConnector converts metadata from the open metadata ecosystem into useful digital products. The first phase (in the start() method) is to create all the contextual metadata that surrounds the product catalog. The remaining phases happen in the refresh() method. It first surveys open metadata looking for metadata that could be a product. (For example, a valid value set). It creates an entry in the product catalog for that product and registers the tabular data set asset for the product as a catalog target.

Once the possible products are in place, it processes the catalog targets. For each, the appropriate metadata is scanned for changes. These changes are recorded in the asset's GovernanceMeasurement classification. This triggers the notification watchdog to send the new data to the subscribers via the provisioning pipelines.

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

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
JacquardIntegrationConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Free up any resources held since the connector is no longer needed.
RequestedCatalogTarget	getNewRequestedCatalogTargetSkeleton(CatalogTarget retrievedCatalogTarget, CatalogTargetContext catalogTargetContext, Connector connectorToTarget)	Create a new catalog target processor (typically inherits from CatalogTargetProcessorBase).
void	refresh()	First make sure that all possible tabular data sets have been harvested.
void	start()	Indicates that the connector is completely configured and can begin processing.

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

processEvent

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

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

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

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, 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

JacquardIntegrationConnector

public JacquardIntegrationConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the connector is completely configured and can begin processing. It sets up the contextual metadata used to fill out the product catalog. This includes the solution blueprint that covers the components involved in managing the open metadata product catalog. Then there is the product catalog itself with its internal folders, glossary and data dictionary. The glossary is then populated with glossary terms, and the data dictionary is populated with data fields. The guids for these elements are managed in instance variables to allow the products to link to them.

Specified by:

start in interface IntegrationConnector

Overrides:

start in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

refresh

public void refresh()
             throws ConnectorCheckedException,
UserNotAuthorizedException

First make sure that all possible tabular data sets have been harvested. These are set up as catalog targets. Then process each catalog target. It will record details of any changes to the catalog target's data.

Specified by:

refresh in interface IntegrationConnector

Overrides:

refresh in class DynamicIntegrationConnectorBase

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 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 CatalogTargetFactory

Specified by:

getNewRequestedCatalogTargetSkeleton in class DynamicIntegrationConnectorBase

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.

disconnect

public void disconnect()
                throws ConnectorCheckedException

Free up any resources held since the connector is no longer needed.

Specified by:

disconnect in interface IntegrationConnector

Overrides:

disconnect in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.