org.odpi.openmetadata.frameworks.governanceaction

Class WatchdogGovernanceActionService

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService

org.odpi.openmetadata.frameworks.governanceaction.WatchdogGovernanceActionService

All Implemented Interfaces:

AuditLoggingComponent

public abstract class WatchdogGovernanceActionService
extends GovernanceActionService

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.

When the watchdog governance action service is complete, it should call governanceContext.recordCompletionStatus() and then return. The recordCompletionStatus() call will include guards that are used to determine the next step if any.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field and Description
protected WatchdogGovernanceContext	governanceContext

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService

auditLog, governanceServiceName

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

Constructor Summary

Constructors

Constructor and Description
WatchdogGovernanceActionService()

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect 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.
void	setGovernanceContext(WatchdogGovernanceContext governanceContext) Set up details of the the governance action request and access to the metadata store.
void	start() Indicates that the governance action service is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService

handleUnexpectedException, setAuditLog, setGovernanceServiceName, validateContext

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

equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

governanceContext

protected WatchdogGovernanceContext governanceContext

Constructor Detail

WatchdogGovernanceActionService

public WatchdogGovernanceActionService()

Method Detail

setGovernanceContext

public void setGovernanceContext(WatchdogGovernanceContext governanceContext)

Set up details of the the governance action request and access to the metadata store. This method is called before start and should

Parameters:

governanceContext - specialist context for this type of governance action.

start

public void start()
           throws ConnectorCheckedException

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

Overrides:

start in class ConnectorBase

Throws:

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

disconnect

public void disconnect()
                throws ConnectorCheckedException

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

Overrides:

disconnect in class ConnectorBase

Throws:

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