Class GeneralGovernanceActionService
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.GeneralGovernanceActionService
- All Implemented Interfaces:
AuditLoggingComponent
,SecureConnectorExtension
,VirtualConnectorExtension
,GovernanceActionService
- Direct Known Subclasses:
CatalogServerGovernanceActionConnector
,CocoClinicalTrialBaseService
,CocoClinicalTrialSetUpDataLakeService
,CreateServerGovernanceActionConnector
,DaysOfWeekGovernanceActionConnector
,EvaluateAnnotationsGovernanceActionConnector
,SurveyReportService
,WaitForStewardGovernanceActionConnector
,WriteAuditLogMessageGovernanceActionConnector
GeneralGovernanceActionService 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
ConnectorBase.ProtectedConnection
-
Field Summary
FieldsFields inherited from class org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionServiceConnector
auditLog, embeddedConnectors, governanceServiceName, propertyHelper
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap
-
Constructor Summary
Constructors -
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, initializeEmbeddedConnectors, setAuditLog, setGovernanceServiceName, validateContext
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, 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
-
GeneralGovernanceActionService
public GeneralGovernanceActionService()
-
-
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.
-