com.metasolv.nm.collector.file

Class FileEITransport

java.lang.Object

com.nt.udc.ndk.node.EITransport

com.metasolv.nm.collector.file.FileEITransport

All Implemented Interfaces:

DataProviderIfc, DCTransport, FileDataProviderIfc, java.lang.Runnable

public class FileEITransport
extends EITransport

This class is based on the other FileEITransport class of the same name. The main differences are that the FileEITransport is now responsible for instantiating the FTP objects, and that the data processing layer has been separated into a distinct file handler object instead of being handled in a sub-classed object. The FileEITransport class is responsible for managing the data files on the local server. It will initialize the FTP objects if an FTP-pull approach is being used. It will then poll the configured local directory for new data files and will pass them to the file handler object for processing. Once the file handler has finished processing the file, the transport will either rename or delete it based on the node's configuration. This class will also provide a safety mechanism whereby it will rename files that are not successfully processed after 3 attempts with a ".error" extension. This will ensure that a corrupt file does not hold up the processing of subsequent valid files. This class provides a mechanism to monitor a directory for files to process by either a "SynchronizedDirectory" object or a standard File Object. A SynchronizedDirectory object is used when objects of this class need to be informed when files are available, and the standard File object is used when this class directly monitors the directory.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.FilenameFilter	actFilter
protected static java.lang.String	BINARY_FTP_TRANSER
protected static java.lang.String	DEFAULT_DONE_PREFIX
protected static java.lang.String	DEFAULT_DONE_SUFFIX
protected static int	DEFAULT_POLLING_INTERVAL
protected static java.lang.String	DEFAULT_SUFFIX
protected boolean	deleteLocalFiles
protected static java.lang.String	DONE_MARKER_SUFFIX
protected java.lang.String	doneFilePrefix
protected java.lang.String	doneFileSuffix
protected static java.lang.String	ERROR_SUFFIX
protected java.util.HashMap	errorTracker
protected FileHandlerIfc	fileHandler
protected boolean	fileLevelTransaction
protected java.lang.String	filePatternMode
protected FileEISequenceCheck	fileSeqCheck
protected boolean	fsChecked
protected FtpFileTracker	ftpFileTracker
protected FtpEIManager	ftpManager
protected SMGLock	ioLock
protected boolean	isOrdered
protected java.io.File	localDir
protected java.lang.String	localFilePrefix
protected java.lang.String	localFileRegExp
protected java.lang.String	localFileSuffix
protected LoggerIfc	logger
protected static int	MAX_NUM_RETRIES
protected static java.lang.String	RECOVERY_FILE_SUFFIX
java.io.File	scratchDir
protected SynchronizedDirectory	sd_localDir
protected boolean	useFtp
protected boolean	useSynchronizedDirectory

Fields inherited from class com.nt.udc.ndk.node.EITransport

dataReceiver, fdChecked, filedataReceiver, fileduplicateCheck, fileToProcess, inputCount, lockFile, movedFile, node, pollingInterval, processing, processingData, running

Constructor Summary

Constructors

Constructor and Description
FileEITransport(DCNode node, FileHandlerIfc handler, SMGLock lock, boolean ordered, boolean fdChecked, FileEIDuplicateCheck fileduplicateCheck, boolean fsChecked, FileEISequenceCheck fileSeqCheck)
FileEITransport(DCNode node, FileHandlerIfc handler, SMGLock lock, boolean fdChecked, FileEIDuplicateCheck fileduplicateCheck, boolean fsChecked, FileEISequenceCheck fileSeqCheck)
FileEITransport(DCNode node, FileHandlerIfc handler, SMGLock lock, boolean ordered, FtpFileTracker tracker, boolean fdChecked, FileEIDuplicateCheck fileduplicateCheck, boolean fsChecked, FileEISequenceCheck fileSeqCheck)

Method Summary

Methods

Modifier and Type	Method and Description
DCFieldContainer[]	getBulkData() This method is used by the DataReceiver to fetch a set of DCFieldContainer objects.
DCFieldContainer	getData() This method is used by the DataReceiver to fetch a single
protected java.util.Vector	getFiles()
java.io.File	getLocalDir()
protected void	initConfig()
boolean	isDataAvailable() This method is used by the DataReceiver to ask this provider if data is available.
boolean	isHealthy() This method is used to check the transport's state of health.
boolean	isLessThan(java.lang.String value1, java.lang.String value2)
protected void	processError(java.io.File file)
protected void	processFiles(java.util.Vector filesToProcess)
protected void	processFilesOrdered(java.io.File currentFile)
boolean	recoveryFileExists(java.io.File file)
void	run() This method is used to control processing for fetching data from the EI's source.
void	shutdown() This method is used to provide a means of shutting down the transport in an orderly fashion.
java.lang.String[]	sortFiles(java.lang.String[] filesToProcess)

Methods inherited from class com.nt.udc.ndk.node.EITransport

getDataReceiver, getDubCheckObj, getDupCheckFlag, getFileBulkData, getFileData, getFileDataReceiver, getMovedFileStatus, getNode, getPollingInterval, handleRejectOfFile, incrementIn, incrementIn, isEndOfFile, isFileDataAvailable, isProcessing, isProcessingData, isStartOfFile, openInputFile, rejectFile, setCountsSuspect, setDataReceiver, setFileDataReceiver, setFileToProcess, setMovedFileStatus, setNode, setPollingInterval, setProcessing

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected LoggerIfc logger

fileHandler

protected FileHandlerIfc fileHandler

fileSeqCheck

protected FileEISequenceCheck fileSeqCheck

BINARY_FTP_TRANSER

protected static final java.lang.String BINARY_FTP_TRANSER

See Also:

Constant Field Values

DONE_MARKER_SUFFIX

protected static final java.lang.String DONE_MARKER_SUFFIX

See Also:

Constant Field Values

DEFAULT_POLLING_INTERVAL

protected static final int DEFAULT_POLLING_INTERVAL

See Also:

Constant Field Values

DEFAULT_SUFFIX

protected static final java.lang.String DEFAULT_SUFFIX

See Also:

Constant Field Values

DEFAULT_DONE_PREFIX

protected static final java.lang.String DEFAULT_DONE_PREFIX

See Also:

Constant Field Values

DEFAULT_DONE_SUFFIX

protected static final java.lang.String DEFAULT_DONE_SUFFIX

See Also:

Constant Field Values

MAX_NUM_RETRIES

protected static final int MAX_NUM_RETRIES

See Also:

Constant Field Values

ERROR_SUFFIX

protected static final java.lang.String ERROR_SUFFIX

See Also:

Constant Field Values

deleteLocalFiles

protected boolean deleteLocalFiles

localFilePrefix

protected java.lang.String localFilePrefix

localFileSuffix

protected java.lang.String localFileSuffix

localFileRegExp

protected java.lang.String localFileRegExp

filePatternMode

protected java.lang.String filePatternMode

doneFilePrefix

protected java.lang.String doneFilePrefix

doneFileSuffix

protected java.lang.String doneFileSuffix

useFtp

protected boolean useFtp

useSynchronizedDirectory

protected boolean useSynchronizedDirectory

RECOVERY_FILE_SUFFIX

protected static final java.lang.String RECOVERY_FILE_SUFFIX

See Also:

Constant Field Values

fileLevelTransaction

protected boolean fileLevelTransaction

sd_localDir

protected SynchronizedDirectory sd_localDir

localDir

protected java.io.File localDir

actFilter

protected java.io.FilenameFilter actFilter

ftpManager

protected FtpEIManager ftpManager

errorTracker

protected java.util.HashMap errorTracker

ftpFileTracker

protected FtpFileTracker ftpFileTracker

scratchDir

public java.io.File scratchDir

ioLock

protected SMGLock ioLock

isOrdered

protected boolean isOrdered

fsChecked

protected boolean fsChecked

Constructor Detail

FileEITransport

public FileEITransport(DCNode node,
               FileHandlerIfc handler,
               SMGLock lock,
               boolean fdChecked,
               FileEIDuplicateCheck fileduplicateCheck,
               boolean fsChecked,
               FileEISequenceCheck fileSeqCheck)
                throws NodeStartException

Throws:

NodeStartException

FileEITransport

public FileEITransport(DCNode node,
               FileHandlerIfc handler,
               SMGLock lock,
               boolean ordered,
               boolean fdChecked,
               FileEIDuplicateCheck fileduplicateCheck,
               boolean fsChecked,
               FileEISequenceCheck fileSeqCheck)
                throws NodeStartException

Throws:

NodeStartException

FileEITransport

public FileEITransport(DCNode node,
               FileHandlerIfc handler,
               SMGLock lock,
               boolean ordered,
               FtpFileTracker tracker,
               boolean fdChecked,
               FileEIDuplicateCheck fileduplicateCheck,
               boolean fsChecked,
               FileEISequenceCheck fileSeqCheck)
                throws NodeStartException

Throws:

NodeStartException

Method Detail

initConfig

protected void initConfig()
                   throws NodeStartException

Throws:

NodeStartException

shutdown

public void shutdown()

Description copied from class: EITransport

This method is used to provide a means of shutting down the transport in an orderly fashion.

Specified by:

shutdown in interface DCTransport

Specified by:

shutdown in class EITransport

getData

public DCFieldContainer getData()

Description copied from class: EITransport

This method is used by the DataReceiver to fetch a single

Specified by:

getData in interface DataProviderIfc

Specified by:

getData in class EITransport

Returns:

DCFieldContainer.

getBulkData

public DCFieldContainer[] getBulkData()

Description copied from class: EITransport

This method is used by the DataReceiver to fetch a set of DCFieldContainer objects.

Specified by:

getBulkData in interface DataProviderIfc

Specified by:

getBulkData in class EITransport

Returns:

DCFieldContainer object array, containing the data that is for processing

isDataAvailable

public boolean isDataAvailable()

Description copied from class: EITransport

This method is used by the DataReceiver to ask this provider if data is available.

Specified by:

isDataAvailable in interface DataProviderIfc

Specified by:

isDataAvailable in class EITransport

Returns:

true, if data is available

run

public void run()

Description copied from class: EITransport

This method is used to control processing for fetching data from the EI's source.

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class EITransport

getFiles

protected java.util.Vector getFiles()

processFiles

protected void processFiles(java.util.Vector filesToProcess)

processFilesOrdered

protected void processFilesOrdered(java.io.File currentFile)

processError

protected void processError(java.io.File file)

isHealthy

public boolean isHealthy()

Description copied from class: EITransport

This method is used to check the transport's state of health. By default it returns true. It is to be overridden by subclasses.

Specified by:

isHealthy in interface DCTransport

Overrides:

isHealthy in class EITransport

Returns:

true if the transport is healthy, false otherwise

getLocalDir

public java.io.File getLocalDir()

sortFiles

public java.lang.String[] sortFiles(java.lang.String[] filesToProcess)

isLessThan

public boolean isLessThan(java.lang.String value1,
                 java.lang.String value2)

recoveryFileExists

public boolean recoveryFileExists(java.io.File file)