Package org.odpi.openmetadata.frameworks.governanceaction

Class GovernanceActionServiceConnector

  • All Implemented Interfaces:
    AuditLoggingComponent, VirtualConnectorExtension
    Direct Known Subclasses:
    GovernanceActionService, ProvisioningGovernanceActionService, RemediationGovernanceActionService, TriageGovernanceActionService, VerificationGovernanceActionService, WatchdogGovernanceActionService
    public abstract class GovernanceActionServiceConnector
extends ConnectorBase
implements AuditLoggingComponent, VirtualConnectorExtension
    GovernanceActionServiceConnector 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. In addition there is a generic governance action service called GovernanceActionService 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.

    • Field Detail

      • governanceServiceName

        protected String governanceServiceName

      • embeddedConnectors

        protected List<Connector> embeddedConnectors

    • Constructor Detail

      • GovernanceActionServiceConnector

        public GovernanceActionServiceConnector()

    • 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

      • initializeEmbeddedConnectors

        public void initializeEmbeddedConnectors​(List<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 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 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.