Package org.odpi.openmetadata.frameworks.governanceaction

Class RemediationGovernanceActionService

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.RemediationGovernanceActionService
All Implemented Interfaces:
AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService
Direct Known Subclasses:
OriginSeekerGovernanceActionConnector, QualifiedNamePeerDuplicateGovernanceActionConnector, RetentionClassifierGovernanceActionConnector, ZonePublisherGovernanceActionConnector
public abstract class RemediationGovernanceActionService extends GovernanceActionServiceConnector
The remediation governance action service is responsible for correct omissions and errors in open metadata and the associated digital landscape. To create your own remediation 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 correct the metadata elements. This is done using the methods available through the governanceContext which is set up just before your start() method is called. Once the remediation work is complete, your start() method should call governanceContext.recordCompletionStatus() and then return.

  • Field Details

  • Constructor Details

    • RemediationGovernanceActionService

      public RemediationGovernanceActionService()

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

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