Package org.odpi.openmetadata.frameworks.opengovernance

Class GeneralGovernanceActionService

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.opengovernance.GovernanceActionServiceConnector
org.odpi.openmetadata.frameworks.opengovernance.GeneralGovernanceActionService
All Implemented Interfaces:
AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService
Direct Known Subclasses:
CancelSubscriptionGovernanceActionConnector, CatalogTargetAssetGovernanceActionConnector, CocoClinicalTrialBaseService, CreateAssetGovernanceActionConnector, CreateSubscriptionGovernanceActionConnector, DaysOfWeekGovernanceActionConnector, DeleteAssetGovernanceActionConnector, EvaluateAnnotationsGovernanceActionConnector, GenericWatchdogGovernanceActionConnector, MoveCopyFileGovernanceActionConnector, OriginSeekerGovernanceActionConnector, ProvisionUnityCatalogGovernanceActionConnector, QualifiedNamePeerDuplicateGovernanceActionConnector, RetentionClassifierGovernanceActionConnector, SurveyReportService, VerifyAssetGovernanceActionConnector, WaitForStewardGovernanceActionConnector, WriteAuditLogMessageGovernanceActionConnector, ZonePublisherGovernanceActionConnector
public abstract class GeneralGovernanceActionService extends GovernanceActionServiceConnector
GovernanceActionService describes the base class for a governance action service connector that is responsible for preforming specific governance actions on demand. There are five types of actions that s governance action service performs:
  • Watchdog - monitors for changes to the metadata elements and initiates other governance actions depending on the nature of the change.
  • Verification - tests values in the metadata elements to detect errors or to classify the status of the metadata elements.
  • Triage - manages the choices on how to resolve a situation, often involving a human decision maker.
  • Remediation - maintains the metadata elements.
  • Provisioning - provisions resources in the digital landscape and maintains lineage.
Each type of action is supported through the governance context that provides it with the metadata methods it needs for its specific role. When you build a governance action service, you extend this governance action service class and access services through the context.

  • Field Details

  • Constructor Details

    • GeneralGovernanceActionService

      public GeneralGovernanceActionService()

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

    • getProperty

      protected String getProperty(String propertyName, String defaultValue)
      Retrieve the property value from the values passed to this governance action service.
      Parameters:
      propertyName - name of the property
      defaultValue - default value
      Returns:
      property value

    • 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() in your version.
      Overrides:
      start in class ConnectorBase
      Throws:
      ConnectorCheckedException - there is a problem within the governance action service.
      UserNotAuthorizedException - the connector was disconnected before/during start

    • 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 GovernanceActionServiceConnector
      Throws:
      ConnectorCheckedException - there is a problem within the governance action service.