Package org.odpi.openmetadata.frameworks.governanceaction

Class TriageGovernanceActionService

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
org.odpi.openmetadata.frameworks.governanceaction.TriageGovernanceActionService
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, GovernanceActionService
public abstract class TriageGovernanceActionService extends GovernanceActionServiceConnector
The triage governance action service is responsible for determining which of the possible courses of action to take for a specific situation. It may involve a human decision maker. To create your own triage 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 includes the logic to either make the decision or initiate action to request a third party make the decision. This is done either by calling a third party technology or using the methods available through the governanceContext which is set up just before your start() method is called. The requestSourceElements describe the situation that the governance action service is assessing and the actionTargetElements describe the elements that should/could be acted upon. Once the set up is complete, or the decision is made, your start() method should call governanceContext.recordCompletionStatus() and then return. The recordCompletionStatus() call will include guards that are used to determine the next step. This may be to enact the decision or monitor for the completion of the task pushed to an external decision maker. It is through these guards that either the triage decision is communicated, or another governance action service is initiated to take the next step.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TriageGovernanceActionService()
     

  • Method Summary

    Modifier and Type
    Method
    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(GovernanceActionContext governanceContext)
    Set up details of 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.GovernanceActionServiceConnector

    getConnectorComponentDescription, initializeEmbeddedConnectors, setAuditLog, setGovernanceServiceName, validateContext

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

    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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TriageGovernanceActionService

      public TriageGovernanceActionService()

  • Method Details

    • setGovernanceContext

      public 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
      Specified by:
      setGovernanceContext in class GovernanceActionServiceConnector
      Parameters:
      governanceContext - specialist context for this type of governance action.

    • start

      public void start() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      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() in your version.
      Overrides:
      start in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the governance action service.

    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.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 GovernanceActionServiceConnector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the governance action service.