Package org.odpi.openmetadata.adapters.connectors.baudot

Class BaudotSubscriptionManagementConnector

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.baudot.BaudotSubscriptionManagementConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, CatalogTargetFactory, IntegrationConnector, OpenMetadataEventListener

public class BaudotSubscriptionManagementConnector
extends DynamicIntegrationConnectorBase
implements OpenMetadataEventListener

BaudotSubscriptionManagementConnector is the Baudot Open Metadata Digital Product Subscription Manager: a dynamic integration connector that notifies the subscribers of digital products. Each notification type it is to look after is given to it as a catalog target - Jacquard does this for every notification type it creates for a product - and a BaudotNotificationTypeProcessor is created for each.

There are two distinct parts to the processing, and they are driven differently.

• Welcome, one-time and periodic notifications are sent when the integration daemon refreshes this connector, which happens on the configured interval and whenever a refresh is requested through the integration daemon's REST API. The daemon's schedule is therefore the only clock here; this connector keeps no timers of its own.
• Notifications about changes to a notification type's monitored resources are sent as the change events arrive on the metadata access server's out topic. The refresh keeps a cache of which notification types monitor which resources; the event listener consults it.

This connector was previously a watchdog governance action service that slept between refreshes on a schedule of its own. Moving it to the integration daemon puts the refresh interval in configuration, and lets an operator - or a test - bring a refresh forward on demand.

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

catalogTargetsManager, connectorName, integrationContext, propertyHelper

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

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
BaudotSubscriptionManagementConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Shutdown the connector.
RequestedCatalogTarget	getNewRequestedCatalogTargetSkeleton(CatalogTarget retrievedCatalogTarget, CatalogTargetContext catalogTargetContext, Connector connectorToTarget)	Create a processor for a newly discovered catalog target - a notification type.
void	processEvent(OpenMetadataOutTopicEvent event)	This method is called each time a metadata change is received.
void	refresh()	Refresh every notification type this connector has been given, then say what is being looked after.
void	start()	Indicates that the connector is completely configured and can begin processing.

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, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingElement, 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

BaudotSubscriptionManagementConnector

public BaudotSubscriptionManagementConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the connector is completely configured and can begin processing.

Specified by:

start in interface IntegrationConnector

Overrides:

start in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

refresh

public void refresh()
             throws ConnectorCheckedException,
UserNotAuthorizedException

Refresh every notification type this connector has been given, then say what is being looked after. The per-notification-type work is in BaudotNotificationTypeProcessor.refresh().

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 was disconnected before/during the refresh

getNewRequestedCatalogTargetSkeleton

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

Create a processor for a newly discovered catalog target - a notification type.

Specified by:

getNewRequestedCatalogTargetSkeleton in interface CatalogTargetFactory

Specified by:

getNewRequestedCatalogTargetSkeleton in class DynamicIntegrationConnectorBase

Parameters:

retrievedCatalogTarget - details of the catalog target

catalogTargetContext - context for the catalog target

connectorToTarget - connector to the target - null, a notification type is not an asset

Returns:

the processor

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

This method is called each time a metadata change is received. Its job is the notifications that are driven by change rather than by the refresh cycle: a change to a monitored resource tells the resource's notification types' subscribers, and a change to the set of monitored resources - or of notification types - keeps the cache the first case depends on current.

Specified by:

processEvent in interface OpenMetadataEventListener

Overrides:

processEvent in class DynamicIntegrationConnectorBase

Parameters:

event - event containing details of a change to an open metadata element.

disconnect

public void disconnect()
                throws ConnectorCheckedException

Shutdown the connector.

Specified by:

disconnect in interface IntegrationConnector

Overrides:

disconnect in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - something failed in the super class