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

Class PeriodicRefreshNotificationService

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.notifications.PeriodicRefreshNotificationService

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, WatchdogActionService

public class PeriodicRefreshNotificationService
extends WatchdogActionServiceConnector

PeriodicRefreshNotificationService is a Watchdog Governance Action Service that periodically calls the subscribers. It listens for changes to its subscribers and send welcome and cancellation notifications. It is designed to run continuously and so does not set up completion status or guards. This means its Governance Action entity is never completed and this service is restarted each time the hosting engine is restarted.

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

auditLog, connector, embeddedConnectors, objectMapper, propertyHelper, watchdogActionServiceName, watchdogContext

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

connectionBean, connectorInstanceId, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
PeriodicRefreshNotificationService()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Disconnect is called either because this governance action service called governanceContext.recordCompletionStatus() or the administrator requested this governance action service stop running or the hosting server is shutting down.
void	processEvent(OpenMetadataOutTopicEvent event)	This method is called each time a metadata change is received.
void	start()	Indicates that the governance action service is completely configured and can begin processing.

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

getConnectorComponentDescription, getJSONProperties, handleUnexpectedException, setAuditLog, setWatchdogActionServiceName, setWatchdogContext

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

combineConfigurationProperties, disconnectConnectors, equals, 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

Constructor Details

PeriodicRefreshNotificationService

public PeriodicRefreshNotificationService()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the governance 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 - there is a problem within the governance action service.

UserNotAuthorizedException - the connector was disconnected before/during start

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

This method is called each time a metadata change is received. If the element is one of the monitored resources, it notifies the subscribers.

Specified by:

processEvent in class WatchdogActionServiceConnector

Parameters:

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

disconnect

public void disconnect()
                throws ConnectorCheckedException

Disconnect is called either because this governance action service called governanceContext.recordCompletionStatus() or the administrator requested this governance action service stop running or the hosting server is shutting down. If disconnect completes before the governance action service records its completion status then the governance action service is restarted either at the administrator's request or the next time the server starts. If you do not want this governance action service restarted, be sure to record the completion status in disconnect(). The disconnect() method is a standard method from the Open Connector Framework (OCF). If you need to override this method be sure to call super.disconnect() in your version.

Overrides:

disconnect in class WatchdogActionServiceConnector

Throws:

ConnectorCheckedException - there is a problem within the governance action service.