Package org.odpi.openmetadata.frameworks.governanceaction

Class ProvisioningGovernanceActionService

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.ProvisioningGovernanceActionService
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 ProvisioningGovernanceActionService extends GovernanceActionServiceConnector
The provisioning governance action service is responsible for provisioning real-world resources in the digital landscape and maintaining the Assets and lineage associated with them. To create your own provisioning 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 provisioning logic. You may also wish to add the metadata for the new assets, a process to represent this governance action service's activity that are linked with the source asset(s) using LineageMapping relationships: sourceAsset -LineageMapping- provisioningProcess -LineageMapping- targetAsset This is done using the methods available through the governanceContext which is set up just before your start() method is called. Once the provisioning work is complete, and any lineage metadata is created, your start() method should call governanceContext.recordCompletionStatus() and then return.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProvisioningGovernanceActionService()
     

  • 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

    • ProvisioningGovernanceActionService

      public ProvisioningGovernanceActionService()

  • 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() at the start of your overriding 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.