com.metasolv.nm.collector.file

Class FtpEIThread

java.lang.Object

java.lang.Thread

com.metasolv.nm.collector.file.FtpEIThread

All Implemented Interfaces:

java.lang.Runnable

public class FtpEIThread
extends java.lang.Thread

This class is based on the FtpEITransport class. The main differences are the use of the FtpSupportInf interface in order to support both regular FTP and SFTP, and the use of a file tracking object. The FtpEIThread class is responsible for managing the FTP connection to a single FTP server. It uses the FtpSupportIntf interface so that it can instantiate different types of FTP objects, which allows it to support regular and passive FTP via the FtpSession class, and SFTP via the SftpSession class. It will poll the remote FTP server for new files based on the configuration settings, and retrieve new files as they are identified. It will also keep track of the files that it has retrieved via the FtpFileTracker object, which will be used to ensure that the same files are not retrieved on subsequent polls. After retrieving a file, it will rename, delete, or leave the remote file unchanged based on the configuration settings.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deleteRemoteFiles
protected FtpFileTracker	ftpFileTracker
protected FtpSupportIntf	ftpSession
protected static java.lang.String	HOSTS_FILE
protected int	interruptTimeDelay
protected SMGLock	ioLock
protected java.lang.String	ipAddress
protected java.lang.String	localSuffix
protected LoggerIfc	logger
protected static int	MAX_RETRIES
protected static int	MILLISECS_PER_MINUTE
protected DCNode	node
protected boolean	overwriteExisting
protected java.lang.String	password
protected static java.lang.String	PATH_SEPARATOR
protected static java.lang.String	REMOTE_SUFFIX
protected java.util.regex.Pattern	remoteFilePattern
protected java.lang.String	remotePath
protected java.lang.String	remoteRegExp
protected boolean	renameRemoteFiles
protected static int	RETRY_DELAY
protected boolean	running
protected SynchronizedDirectory	sd The SynchronizedDirectory ensures that files won't be processed prematurely.
protected static int	SFTP_PORT
protected int	sleepTime
protected boolean	usePassiveFTP
protected java.lang.String	username
protected static java.lang.String	WILDCARD

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FtpEIThread(java.lang.String ftpType, java.lang.String remoteHost, java.lang.String login, java.lang.String pass, java.lang.String remoteFileDir, java.lang.String mode, java.lang.String prefix, java.lang.String suffix, java.lang.String regExp, java.lang.String localSuffix, int delayTime, boolean binary, boolean deleteFlag, boolean renameFlag, SynchronizedDirectory dir, DCNode node, FtpFileTracker tracker)
FtpEIThread(java.lang.String ftpType, java.lang.String remoteHost, java.lang.String login, java.lang.String pass, java.lang.String remoteFileDir, java.lang.String mode, java.lang.String prefix, java.lang.String suffix, java.lang.String regExp, java.lang.String localSuffix, int delayTime, boolean binary, boolean deleteFlag, boolean renameFlag, SynchronizedDirectory dir, DCNode node, FtpFileTracker tracker, int interruptDelay) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	connectAndGetFiles() This method creates the connection, retrieves the files and notifies the consumer of the files via the SynchronizedDirectory object.
java.lang.String	getIPAddress()
protected java.lang.String	getLocalName(java.lang.String prefix, java.lang.String filename) Generates a unique local file name.
java.lang.String	getLocalSuffix()
java.lang.String	getPassword()
java.lang.String	getRemotePath()
java.lang.String	getRemoteRegExp()
int	getSleepTime()
SynchronizedDirectory	getSynchronizedDirectory()
java.lang.String	getUsername()
boolean	isHealthy() This method is used to check if the transport is fully functional.
protected java.util.ArrayList	listFiles(java.lang.String path, java.util.regex.Pattern pattern) List all the files with the specified suffix that are in the specified directory on the FTP server.
protected boolean	retrieveSingleFile(java.lang.String remote) This method will retrieve a single file from the remote FTP server.
void	run() Continuously polls for new files to retrieve until it's time to shut down.
void	setASCIIMode()
void	setBinaryMode()
void	setIOLock(SMGLock lock)
void	setLocalSuffix(java.lang.String suffix)
void	setOverwriteExisting(boolean flag)
void	setRemotePath(java.lang.String path)
void	setSleepTime(int time)
void	setSynchronizedDirectory(SynchronizedDirectory dir)
void	shutdown()
protected void	sleep(int sleepSecs)

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

MILLISECS_PER_MINUTE

protected static final int MILLISECS_PER_MINUTE

See Also:

Constant Field Values

WILDCARD

protected static final java.lang.String WILDCARD

See Also:

Constant Field Values

PATH_SEPARATOR

protected static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

REMOTE_SUFFIX

protected static final java.lang.String REMOTE_SUFFIX

See Also:

Constant Field Values

HOSTS_FILE

protected static final java.lang.String HOSTS_FILE

See Also:

Constant Field Values

SFTP_PORT

protected static final int SFTP_PORT

See Also:

Constant Field Values

ipAddress

protected java.lang.String ipAddress

username

protected java.lang.String username

password

protected java.lang.String password

ftpSession

protected FtpSupportIntf ftpSession

remotePath

protected java.lang.String remotePath

remoteRegExp

protected java.lang.String remoteRegExp

remoteFilePattern

protected java.util.regex.Pattern remoteFilePattern

localSuffix

protected java.lang.String localSuffix

logger

protected LoggerIfc logger

running

protected boolean running

deleteRemoteFiles

protected boolean deleteRemoteFiles

renameRemoteFiles

protected boolean renameRemoteFiles

usePassiveFTP

protected boolean usePassiveFTP

overwriteExisting

protected boolean overwriteExisting

sleepTime

protected int sleepTime

RETRY_DELAY

protected static final int RETRY_DELAY

See Also:

Constant Field Values

MAX_RETRIES

protected static final int MAX_RETRIES

See Also:

Constant Field Values

node

protected DCNode node

ftpFileTracker

protected FtpFileTracker ftpFileTracker

sd

protected SynchronizedDirectory sd

The SynchronizedDirectory ensures that files won't be processed prematurely.

interruptTimeDelay

protected int interruptTimeDelay

ioLock

protected SMGLock ioLock

Constructor Detail

FtpEIThread

public FtpEIThread(java.lang.String ftpType,
           java.lang.String remoteHost,
           java.lang.String login,
           java.lang.String pass,
           java.lang.String remoteFileDir,
           java.lang.String mode,
           java.lang.String prefix,
           java.lang.String suffix,
           java.lang.String regExp,
           java.lang.String localSuffix,
           int delayTime,
           boolean binary,
           boolean deleteFlag,
           boolean renameFlag,
           SynchronizedDirectory dir,
           DCNode node,
           FtpFileTracker tracker,
           int interruptDelay)

Constructor

Parameters:

ftpType - The type of FTP to use

remoteHost - The IP address of the FTP server

login - The username to use for logging in

pass - The password for the given username

remoteFileDir - The remote directory to retrieve from the FTP server

mode - The remote file filter pattern mode

prefix - The remote file prefix

suffix - The remote file suffix

regExp - The regular expression for remote file

localSuffix - Specifies the local suffix for the retrieved files

delayTime - The number of milliseconds to wait between successive retrievals

binary - Determines if files should be retrieved in binary mode (false = ASCII mode)

deleteFlag - Determines whether to delete the remote files after processing

renameFlag - Determines whether to rename the remote files after processing

dir - The local directory into which files will be placed

node - The EI Node that is using this FTP object

FtpEIThread

public FtpEIThread(java.lang.String ftpType,
           java.lang.String remoteHost,
           java.lang.String login,
           java.lang.String pass,
           java.lang.String remoteFileDir,
           java.lang.String mode,
           java.lang.String prefix,
           java.lang.String suffix,
           java.lang.String regExp,
           java.lang.String localSuffix,
           int delayTime,
           boolean binary,
           boolean deleteFlag,
           boolean renameFlag,
           SynchronizedDirectory dir,
           DCNode node,
           FtpFileTracker tracker)

Method Detail

run

public void run()

Continuously polls for new files to retrieve until it's time to shut down.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

connectAndGetFiles

protected boolean connectAndGetFiles()

This method creates the connection, retrieves the files and notifies the consumer of the files via the SynchronizedDirectory object.

Returns:

true, if successful - false, if not

sleep

protected void sleep(int sleepSecs)
              throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

shutdown

public void shutdown()

listFiles

protected java.util.ArrayList listFiles(java.lang.String path,
                            java.util.regex.Pattern pattern)
                                 throws java.io.IOException

List all the files with the specified suffix that are in the specified directory on the FTP server.

Parameters:

path - Remote file directory

pattern - Remote file pattern to retrieve

Returns:

ArrayList containing a list of the files to retrieve

Throws:

java.io.IOException

retrieveSingleFile

protected boolean retrieveSingleFile(java.lang.String remote)

This method will retrieve a single file from the remote FTP server.

Parameters:

remote - Specifies the name of the remote file (incl path)

Returns:

true-if successful

getLocalName

protected java.lang.String getLocalName(java.lang.String prefix,
                            java.lang.String filename)

Generates a unique local file name.

isHealthy

public boolean isHealthy()

This method is used to check if the transport is fully functional.

setOverwriteExisting

public void setOverwriteExisting(boolean flag)

setBinaryMode

public void setBinaryMode()

setASCIIMode

public void setASCIIMode()

setRemotePath

public void setRemotePath(java.lang.String path)

getRemotePath

public java.lang.String getRemotePath()

setLocalSuffix

public void setLocalSuffix(java.lang.String suffix)

getLocalSuffix

public java.lang.String getLocalSuffix()

getRemoteRegExp

public java.lang.String getRemoteRegExp()

setSleepTime

public void setSleepTime(int time)

getSleepTime

public int getSleepTime()

setSynchronizedDirectory

public void setSynchronizedDirectory(SynchronizedDirectory dir)

getSynchronizedDirectory

public SynchronizedDirectory getSynchronizedDirectory()

getUsername

public java.lang.String getUsername()
                             throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

getPassword

public java.lang.String getPassword()
                             throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

getIPAddress

public java.lang.String getIPAddress()
                              throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

setIOLock

public void setIOLock(SMGLock lock)