Package org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog

Class GenericElementWatchdogGovernanceActionConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.openwatchdog.WatchdogActionServiceConnector

org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog.GenericWatchdogGovernanceActionConnector

org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog.GenericElementWatchdogGovernanceActionConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, WatchdogActionService

public class GenericElementWatchdogGovernanceActionConnector
extends GenericWatchdogGovernanceActionConnector

GenericElementWatchdogGovernanceActionConnector is a Watchdog Action Service that listens for changes to open metadata elements and relationships and kicks off a governance action process for each one. With the process-multiple-events request type it runs continuously and does not set up its completion status. This means its engine action is never completed and this service is restarted each time the hosting engine is restarted. With the process-single-event request type it completes once the first matching event is processed.

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.openwatchdog.WatchdogActionServiceConnector

connector, embeddedConnectors, objectMapper, propertyHelper, watchdogActionServiceName, watchdogContext

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

auditLog, connectionBean, connectorInstanceId, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
GenericElementWatchdogGovernanceActionConnector()

Method Summary

Modifier and Type	Method	Description
void	processEvent(OpenMetadataOutTopicEvent event)	This method is called each time a potentially new asset is received.
void	start()	Indicates that the watchdog action service is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog.GenericWatchdogGovernanceActionConnector

completeMonitoring, diffProperties, getProperty, initiateProcess

Methods inherited from class org.odpi.openmetadata.frameworks.openwatchdog.WatchdogActionServiceConnector

disconnect, getConnectorComponentDescription, getJSONProperties, handleUnexpectedException, setAuditLog, setWatchdogActionServiceName, setWatchdogContext

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

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayValue, 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

Constructor Details

GenericElementWatchdogGovernanceActionConnector

public GenericElementWatchdogGovernanceActionConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the watchdog action service is completely configured and can begin processing. This is a standard method from the Open Connector Framework (OCF) so be sure to call super.start() at the start of your overriding version.

Overrides:

start in class WatchdogActionServiceConnector

Throws:

ConnectorCheckedException - a problem within the watchdog action service.

UserNotAuthorizedException - the connector was disconnected before/during start

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)
                  throws GovernanceServiceException

This method is called each time a potentially new asset is received. It triggers a governance action process to validate and enrich the asset as required. Events are handled one at a time so that, for process-single-event, only one of several events arriving together starts a process.

Specified by:

processEvent in class WatchdogActionServiceConnector

Parameters:

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

Throws:

GovernanceServiceException - reports that the event can not be processed (this is logged but no other action is taken). The listener will continue to be called until the watchdog governance action service declares it is complete or administrator action shuts down the service.