- All Implemented Interfaces:
- Direct Known Subclasses:
public abstract class WatchdogGovernanceActionService extends GovernanceActionServiceConnector
The watchdog governance action service is responsible for monitoring changes to the metadata elements and then initiating further governance activity. It can be written as a log running service that is detecting multiple events over time, or it may just be looking for a specific change before completing. To create your own watchdog governance action service, create a new class that extends this class along with another class that extends the GovernanceActionServiceProviderBase class to act as its connector provider. Add a start() method that begins by calling super.start() and then registers a listener to wait for the desired event(s). THe listener is called each time an event occurs. It can use the methods on the governance context to:
- Create a governance action to drive a specific governance action service.
- Initiate a governance action process.
- Create an incident report that will be processed by the incident report governance processes.
Nested Class Summary
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
auditLog, embeddedConnectors, governanceServiceName
Method SummaryModifier and TypeMethodDescription
voidDisconnect is called either because this governance action service called governanceContext.recordCompletionStatus() or the administer requested this governance action service stop running or the hosting server is shutting down.
voidSet up details of the governance action request and access to the metadata store.
start()Indicates that the governance action service is completely configured and can begin processing.
Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
getConnectorComponentDescription, handleUnexpectedException, initializeEmbeddedConnectors, setAuditLog, setGovernanceServiceName, validateContext
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnectConnectors, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, toString
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector
clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp
governanceContextprotected WatchdogGovernanceContext governanceContext
setGovernanceContextpublic void setGovernanceContext
(GovernanceActionContext governanceContext)Set up details of the governance action request and access to the metadata store. This method is called before start and should not be null
startpublic void start() throws ConnectorCheckedExceptionIndicates that the governance action service is completely configured and can begin processing. This is where the watchdog governance action service registers its listener. The watchdog listener will then be called for each event. It can use the context to initiate other governance activity or call governanceContext.recordCompletionStatus() to end. This is a standard method from the Open Connector Framework (OCF) so be sure to call super.start() in your version.
disconnectpublic void disconnect() throws ConnectorCheckedExceptionDisconnect is called either because this governance action service called governanceContext.recordCompletionStatus() or the administer 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.