Package org.odpi.openmetadata.frameworks.governanceaction

Class GovernanceActionServiceConnector

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension, GovernanceActionService
Direct Known Subclasses:
GeneralGovernanceActionService, ProvisioningGovernanceActionService, RemediationGovernanceActionService, TriageGovernanceActionService, VerificationGovernanceActionService, WatchdogGovernanceActionService
public abstract class GovernanceActionServiceConnector extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements GovernanceActionService, org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
GovernanceActionServiceConnector describes the base class for a specific type of connector that is responsible for preforming specific governance actions on demand. There are six 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.
  • GeneralGovernanceActionService - combines all of the capability of the specialist services above.
Each type of governance action service is passed a specialized 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. In addition, there is a generic governance action service called GeneralGovernanceActionService that combines all the functions of the five specialist types of governance action service. It is used when if is more efficient to combine the functions into one execution.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GovernanceActionServiceConnector()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disconnect()
    Free up any resources held since the connector is no longer needed.
    org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
    getConnectorComponentDescription()
    Return the component description that is used by this connector in the audit log.
    void
    initializeEmbeddedConnectors(List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors)
    Set up the list of connectors that this virtual connector will use to support its interface.
    void
    setAuditLog(org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Receive an audit log object that can be used to record audit log messages.
    abstract void
    setGovernanceContext(GovernanceActionContext governanceContext)
    Set up details of the governance action request and access to the metadata store.
    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

    equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, start, 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

    • GovernanceActionServiceConnector

      public GovernanceActionServiceConnector()

  • Method Details

    • setAuditLog

      public void setAuditLog(org.odpi.openmetadata.frameworks.auditlog.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 org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Parameters:
      auditLog - audit log object

    • getConnectorComponentDescription

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDescription getConnectorComponentDescription()
      Return the component description that is used by this connector in the audit log.
      Specified by:
      getConnectorComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Returns:
      id, name, description, wiki page URL.

    • initializeEmbeddedConnectors

      public void initializeEmbeddedConnectors(List<org.odpi.openmetadata.frameworks.connectors.Connector> embeddedConnectors)
      Set up the list of connectors that this virtual connector will use to support its interface. The connectors are initialized waiting to start. When start() is called on the virtual connector, it needs to pass start() to each of the embedded connectors. Similarly for disconnect().
      Specified by:
      initializeEmbeddedConnectors in interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
      Parameters:
      embeddedConnectors - list of connectors

    • 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

    • setGovernanceContext

      public abstract 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
      Parameters:
      governanceContext - specialist context for this type of governance action.

    • validateContext

      public void validateContext(GovernanceContext governanceContext) throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Verify that the context has been set up in the subclass
      Parameters:
      governanceContext - context from the subclass
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - error to say that the connector (governance action service) is not able to proceed because it has not been set up correctly.

    • disconnect

      public void disconnect() throws org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Free up any resources held since the connector is no longer needed.
      Overrides:
      disconnect in class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there is a problem within the connector.