Package org.odpi.openmetadata.adapters.connectors.integration.basicfiles

Class OMArchiveFilesMonitorIntegrationProvider

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider

org.odpi.openmetadata.adapters.connectors.integration.basicfiles.OMArchiveFilesMonitorIntegrationProvider

All Implemented Interfaces:

AuditLoggingComponent

public class OMArchiveFilesMonitorIntegrationProvider
extends IntegrationConnectorProvider

OMArchiveFilesMonitorIntegrationProvider is the OCF connector provider for the Open Metadata Archive Files Monitor Integration Connector. This is one of the basic files integration connectors.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_CATALOG_DELETE_CONFIGURATION_PROPERTY	An optional boolean flag to indicate whether the connector should delete the catalog entry for files that have been deleted (true) or just archive them (false - the default).
static final String	CATALOG_ALL_FILES_CONFIGURATION_PROPERTY	An optional boolean flag to indicate that all files should be catalogued, whether they are classified or not.
static final String	CATALOG_TARGET_NAME	The name of the catalog target that contains the directory to monitor.
static final String	DIRECTORY_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY	The optional qualified name of a data asset used for cataloguing directories (folders).
static final String	FILE_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY	The optional qualified name of a data asset used for cataloguing files.
static final String	INCIDENT_REPORT_TEMPLATE_CONFIGURATION_PROPERTY	An optional qualified name of a template Incident Report entity that is created if there is confusion identifying the correct reference data for a file being catalogued.
static final String	TO_DO_TEMPLATE_CONFIGURATION_PROPERTY	An optional qualified name of a template To Do entity that is created if there is confusion identifying the correct reference data for a file being catalogued.
static final String	WAIT_FOR_DIRECTORY_CONFIGURATION_PROPERTY	An optional flag that instructs the connector to wait for the monitoring directory to be created if it does not exist rather than throwing an exception to force the integration connector into failed state.

Fields inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider

catalogTargets, supportedAssetTypeName

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

auditLog, connectorInterfaces, connectorTypeBean

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

supportedConfigurationProperties, supportedTechnologyTypes, supportedTemplateTypes

Constructor Summary

Constructors

Constructor	Description
OMArchiveFilesMonitorIntegrationProvider()	Constructor used to initialize the ConnectorProviderBase with the Java class name of the specific store implementation.

Method Summary

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

getCatalogTargets, getRefreshTimeInterval, getUsesBlockingCalls, setRefreshTimeInterval, setUsesBlockingCalls

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

equals, getClassForConnector, getConnector, getConnector, getConnectorClassName, getConnectorComponentDescription, getConnectorType, getConnectorTypeProperties, getNewConnectorGUID, hashCode, setAuditLog, setConnectorClassName, setConnectorComponentDescription, setConnectorTypeProperties, toString

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

getSupportedConfigurationProperties, getSupportedTechnologyTypes, getSupportedTemplateTypes

Methods inherited from class java.lang.Object

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

Field Details

FILE_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY

public static final String FILE_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY

The optional qualified name of a data asset used for cataloguing files. If this is null, no template is used.

See Also:

• Constant Field Values

DIRECTORY_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY

public static final String DIRECTORY_TEMPLATE_QUALIFIED_NAME_CONFIGURATION_PROPERTY

The optional qualified name of a data asset used for cataloguing directories (folders). If it is null, no template is used.

See Also:

• Constant Field Values

ALLOW_CATALOG_DELETE_CONFIGURATION_PROPERTY

public static final String ALLOW_CATALOG_DELETE_CONFIGURATION_PROPERTY

An optional boolean flag to indicate whether the connector should delete the catalog entry for files that have been deleted (true) or just archive them (false - the default).

See Also:

• Constant Field Values

CATALOG_ALL_FILES_CONFIGURATION_PROPERTY

public static final String CATALOG_ALL_FILES_CONFIGURATION_PROPERTY

An optional boolean flag to indicate that all files should be catalogued, whether they are classified or not.

See Also:

• Constant Field Values

TO_DO_TEMPLATE_CONFIGURATION_PROPERTY

public static final String TO_DO_TEMPLATE_CONFIGURATION_PROPERTY

An optional qualified name of a template To Do entity that is created if there is confusion identifying the correct reference data for a file being catalogued.

See Also:

• Constant Field Values

INCIDENT_REPORT_TEMPLATE_CONFIGURATION_PROPERTY

public static final String INCIDENT_REPORT_TEMPLATE_CONFIGURATION_PROPERTY

An optional qualified name of a template Incident Report entity that is created if there is confusion identifying the correct reference data for a file being catalogued.

See Also:

• Constant Field Values

WAIT_FOR_DIRECTORY_CONFIGURATION_PROPERTY

public static final String WAIT_FOR_DIRECTORY_CONFIGURATION_PROPERTY

An optional flag that instructs the connector to wait for the monitoring directory to be created if it does not exist rather than throwing an exception to force the integration connector into failed state. It can be set to any value - just defining the property causes the connector to wait.

See Also:

• Constant Field Values

CATALOG_TARGET_NAME

public static final String CATALOG_TARGET_NAME

The name of the catalog target that contains the directory to monitor.

See Also:

• Constant Field Values

Constructor Details

OMArchiveFilesMonitorIntegrationProvider

public OMArchiveFilesMonitorIntegrationProvider()

Constructor used to initialize the ConnectorProviderBase with the Java class name of the specific store implementation.