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

Class OMArchiveFilesMonitorForTarget

java.lang.Object

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

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

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

All Implemented Interfaces:

FileDirectoryListenerInterface, FileListenerInterface

public class OMArchiveFilesMonitorForTarget
extends DataFilesMonitorForTarget

Catalog target monitor for cataloguing OMARCHIVE files.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DirectoryToMonitor

allowCatalogDelete, auditLog, canonicalMountPoint, catalogClassifiedFiles, catalogTargetGUID, configurationProperties, connectorName, dataFolderGUID, directoryFile, directoryName, fileSystemName, fileSystemProperties, incidentReportTemplateGUID, incidentReportTemplateQualifiedName, integrationConnector, isListening, localMountPoint, metadataSourceGUID, metadataSourceName, newFileProcessName, propertyHelper, sourceName, templates, toDoTemplateGUID, toDoTemplateQualifiedName, waitForDirectory

Constructor Summary

Constructors

Constructor	Description
OMArchiveFilesMonitorForTarget(String connectorName, String sourceName, String pathName, String catalogTargetGUID, String dataFolderGUID, DeleteMethod deleteMethod, Map<String,String> templates, FileSystemProperties fileSystemProperties, Map<String,Object> configurationProperties, BasicFilesMonitorIntegrationConnectorBase integrationConnector, AuditLog auditLog)	Construct the monitor for a specific catalog target.

Method Summary

Modifier and Type	Method	Description
protected String	addDataFileToCatalog(String typeName, String fileAddress, DataFileProperties properties, DataAssetEncodingProperties encodingProperties, String connectorTypeGUID)	Return the unique identifier of a new metadata element describing the file.
protected String	addDataFileViaTemplate(String assetTypeName, String fileTemplateGUID, ElementProperties replacementProperties, Map<String,String> placeholderProperties)	Return the unique identifier of a new metadata element describing the file created using the supplied template.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DataFilesMonitorForTarget

catalogFile, onDirectoryChange, onDirectoryCreate, onDirectoryDelete, onFileChange, onFileCreate, onFileDelete, refresh

Methods inherited from class org.odpi.openmetadata.adapters.connectors.integration.basicfiles.DirectoryToMonitor

getDataFolderElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OMArchiveFilesMonitorForTarget

public OMArchiveFilesMonitorForTarget(String connectorName,
 String sourceName,
 String pathName,
 String catalogTargetGUID,
 String dataFolderGUID,
 DeleteMethod deleteMethod,
 Map<String,String> templates,
 FileSystemProperties fileSystemProperties,
 Map<String,Object> configurationProperties,
 BasicFilesMonitorIntegrationConnectorBase integrationConnector,
 AuditLog auditLog)

Construct the monitor for a specific catalog target.

Parameters:

connectorName - name of associated connector

sourceName - source of the pathname

pathName - pathname to the directory

catalogTargetGUID - optional catalog target GUID

dataFolderGUID - optional GUID of the data folder element

deleteMethod - should the connector use delete or archive?

templates - names and GUIDs of templates

fileSystemProperties - properties of the file system

configurationProperties - parameters to further modify the behaviour of the connector

integrationConnector - associated connector

auditLog - logging destination

Method Details

addDataFileToCatalog

protected String addDataFileToCatalog(String typeName,
 String fileAddress,
 DataFileProperties properties,
 DataAssetEncodingProperties encodingProperties,
 String connectorTypeGUID)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the unique identifier of a new metadata element describing the file.

Overrides:

addDataFileToCatalog in class DataFilesMonitorForTarget

Parameters:

typeName - subtype name for file

fileAddress - local file path name

properties - basic properties to use

encodingProperties - properties for DataAssetEncoding classification

connectorTypeGUID - unique identifier for the connector type

Returns:

unique identifier (guid)

Throws:

InvalidParameterException - invalid parameter

PropertyServerException - unable to communicate with the repository

UserNotAuthorizedException - access problem for userId

addDataFileViaTemplate

protected String addDataFileViaTemplate(String assetTypeName,
 String fileTemplateGUID,
 ElementProperties replacementProperties,
 Map<String,String> placeholderProperties)
                                 throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the unique identifier of a new metadata element describing the file created using the supplied template.

Overrides:

addDataFileViaTemplate in class DataFilesMonitorForTarget

Parameters:

assetTypeName - type of asset to create

fileTemplateGUID - template to use

replacementProperties - properties from the template to replace

placeholderProperties - values to use to replace placeholders in the template

Returns:

unique identifier (guid)

Throws:

ConnectorCheckedException - connector has been shutdown

InvalidParameterException - invalid parameter

PropertyServerException - unable to communicate with the repository

UserNotAuthorizedException - access problem for userId