Package org.odpi.openmetadata.frameworks.governanceaction

Class GovernanceActionService

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionService

All Implemented Interfaces:

AuditLoggingComponent

Direct Known Subclasses:

ProvisioningGovernanceActionService, RemediationGovernanceActionService, TriageGovernanceActionService, VerificationGovernanceActionService, WatchdogGovernanceActionService

public abstract class GovernanceActionService
extends ConnectorBase
implements AuditLoggingComponent

GovernanceActionService describes the base class for a specific type of connector that is responsible for preforming specific governance actions on demand. There are five types of governance action service:

• WatchdogGovernanceActionService - monitors for changes to the metadata elements and initiates other governance actions depending on the nature of the change.
• VerificationGovernanceActionService - tests values in the metadata elements to detect errors or to classify the status of the metadata elements.
• TriageGovernanceActionService - manages the choices on how to resolve a situation, often involving a human decision maker.
• RemediationGovernanceActionService - maintains the metadata elements.
• ProvisioningGovernanceActionService - provisions resources in the digital landscape and maintains lineage.

Each type of governance action service is passed a specialize context that provides it with the metadata methods it needs for its specific role. When you build a governance action service, you extend the governance action service class that matches the purpose of your governance action to ensure your code receives a context with the appropriate interface.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected String	governanceServiceName

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

Constructor Summary

Constructors

Constructor	Description
GovernanceActionService()

Method Summary

Modifier and Type	Method	Description
protected void	handleUnexpectedException(String methodName, Throwable error)	Provide a common exception for unexpected errors.
void	setAuditLog(AuditLog auditLog)	Receive an audit log object that can be used to record audit log messages.
void	setGovernanceServiceName(String governanceServiceName)	Set up the governance action service name.
void	validateContext(GovernanceContext governanceContext)	Verify that the context has been set up in the subclass

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

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

Methods inherited from class java.lang.Object

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

Field Detail

governanceServiceName

protected String governanceServiceName

auditLog

protected AuditLog auditLog

Constructor Detail

GovernanceActionService

public GovernanceActionService()

Method Detail

setAuditLog

public void setAuditLog(AuditLog auditLog)

Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.

Specified by:

setAuditLog in interface AuditLoggingComponent

Parameters:

auditLog - audit log object

setGovernanceServiceName

public void setGovernanceServiceName(String governanceServiceName)

Set up the governance action service name. This is used in error messages.

Parameters:

governanceServiceName - name of the service

handleUnexpectedException

protected void handleUnexpectedException(String methodName,
                                         Throwable error)
                                  throws ConnectorCheckedException

Provide a common exception for unexpected errors.

Parameters:

methodName - calling method

error - caught exception

Throws:

GovernanceServiceException - wrapped exception

ConnectorCheckedException

validateContext

public void validateContext(GovernanceContext governanceContext)
                     throws ConnectorCheckedException

Verify that the context has been set up in the subclass

Parameters:

governanceContext - context from the subclass

Throws:

ConnectorCheckedException - error to say that the connector (governance action service) is not able to proceed because it has not been set up correctly.