Package org.odpi.openmetadata.adapters.connectors.pasteur

Class PasteurActionHistoryCleanupConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

org.odpi.openmetadata.adapters.connectors.pasteur.PasteurActionHistoryCleanupConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, IntegrationConnector

public class PasteurActionHistoryCleanupConnector
extends IntegrationConnectorBase

PasteurActionHistoryCleanupConnector keeps the action history of the open metadata ecosystem in check, in recognition of Louis Pasteur (1822-1895), whose work on germ theory and vaccination defeated infectious diseases. Every engine action, governance action process instance, to do and other kind of action stays in the repository after it finishes, so without housekeeping the action history grows without bound.

On each refresh the connector looks, type by type, for the actions of each type listed in its daysToCleanUp configuration property whose activity status is one of its completionStatuses, and deletes those that completed at least the configured number of days ago (see PasteurCleanUpPolicy). It uses the LOOK_FOR_LINEAGE delete method by default: an action with lineage relationships is archived, so it is still available to lineage queries, and the others are soft-deleted. Neither is a purge, so an action removed in error can be restored. The deleteMethod configuration property can name a different delete method. The delete is cascaded, so the elements anchored to an action go with it.

An action anchored to another action whose type has its own entry in daysToCleanUp - typically the engine actions of a governance action process, which are anchored to the process instance - is left for the delete of its anchor to remove. That way a process instance and the engine actions it ran are removed together rather than the engine actions disappearing from under a process instance that is still being kept.

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.integration.connectors.IntegrationConnectorBase

catalogTargetsManager, connectorName, integrationContext, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
PasteurActionHistoryCleanupConnector()

Method Summary

Modifier and Type	Method	Description
void	refresh()	Delete (or, if they have lineage, archive) the finished actions that are old enough.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

disconnect, engage, getConnectorComponentDescription, getNetworkAddress, passEventToCatalogTargets, refreshCatalogTargets, setAuditLog, setConnectorName, setContext

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayValue, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingElement, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Constructor Details

PasteurActionHistoryCleanupConnector

public PasteurActionHistoryCleanupConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the connector is completely configured and can begin processing. The configuration properties are read here.

Specified by:

start in interface IntegrationConnector

Overrides:

start in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

refresh

public void refresh()
             throws ConnectorCheckedException,
UserNotAuthorizedException

Delete (or, if they have lineage, archive) the finished actions that are old enough.

Throws:

ConnectorCheckedException - a problem with the connector. It is not able to refresh the metadata.

UserNotAuthorizedException - the connector was disconnected