Class VerificationGovernanceActionService
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.VerificationGovernanceActionService
- All Implemented Interfaces:
AuditLoggingComponent
,SecureConnectorExtension
,VirtualConnectorExtension
,GovernanceActionService
- Direct Known Subclasses:
VerifyAssetGovernanceActionConnector
The verification governance action service is responsible for testing the values in the metadata elements and
relationships and setting up guards to guide the next step of processing.
To create your own verification 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 retrieve the metadata elements
and make an assessment. The requestSourceElements describe the situation that the governance action service is assessing
and the actionTargetElements describe the elements that should/could be acted upon.
Once the assessment is complete, your start() method should call
governanceContext.recordCompletionStatus() and then return. The recordCompletionStatus() call will include guards that are used to determine
the next step.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
ConnectorBase.ProtectedConnection
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
auditLog, governanceServiceName, propertyHelper
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.protected String
getProperty
(String propertyName, String defaultValue) Retrieve the property value from the values passed to this governance action service.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
getArrayRequestParameter, getBooleanRequestParameter, getConnectorComponentDescription, getIntRequestParameter, getLongRequestParameter, getStringRequestParameter, handleUnexpectedException, setAuditLog, setGovernanceServiceName, validateContext
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector
clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp
-
Field Details
-
governanceContext
-
-
Constructor Details
-
VerificationGovernanceActionService
public VerificationGovernanceActionService()
-
-
Method Details
-
setGovernanceContext
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 classGovernanceActionServiceConnector
- Parameters:
governanceContext
- specialist context for this type of governance action.
-
getProperty
Retrieve the property value from the values passed to this governance action service.- Parameters:
propertyName
- name of the propertydefaultValue
- default value- Returns:
- property value
-
start
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 classConnectorBase
- Throws:
ConnectorCheckedException
- there is a problem within the governance action service.
-
disconnect
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 classGovernanceActionServiceConnector
- Throws:
ConnectorCheckedException
- there is a problem within the governance action service.
-