com.nt.udc.ndk.util

Class AbstractOIFtpPusher

java.lang.Object

java.lang.Thread

com.nt.udc.ndk.util.AbstractOIFtpPusher

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

GenevaOIFtpPusher, OIFtpPusher

public abstract class AbstractOIFtpPusher
extends java.lang.Thread

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	bFailed
static int	DEFAULT_FTP_PORT
static int	DEFAULT_SFTP_PORT
protected int	delay
protected java.lang.String	errMesg
protected java.util.Vector	filesToFTP
protected FtpSupportIntf	ftpClient
protected java.lang.String	ftpDirectory
protected java.lang.String	ftpExtension
protected int	ftpFileType
protected java.io.FilenameFilter	ftpFilter
protected java.lang.String	ftpHost
protected java.lang.String	ftpPasswd
protected int	ftpPort
protected boolean	ftpRunning
protected long	ftpTimeInterval
protected java.lang.String	ftpUser
protected java.lang.String	hostsFile
protected int	interruptDelay
protected java.lang.String	localDirectory
protected LoggerIfc	logger
protected DCNode	oinode
protected boolean	passiveMode
protected boolean	sftpUsed
static java.lang.String	SSH_KNOWN_HOSTS_FILE

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractOIFtpPusher(LoggerIfc lgr, java.lang.String localdir, java.lang.String ftphost, int ftpport, java.lang.String ftpuser, java.lang.String ftppasswd, java.lang.String ftpdir, java.lang.String ftpext, boolean sftpUsed, java.lang.String hostsFile) Construct a new AbsctractOIFtpPusher to be used within an OITransport object.
AbstractOIFtpPusher(LoggerIfc lgr, java.lang.String localdir, java.lang.String ftphost, int ftpport, java.lang.String ftpuser, java.lang.String ftppasswd, java.lang.String ftpdir, java.lang.String ftpext, boolean sftpUsed, java.lang.String hostsFile, int interruptDelay) Construct a new AbsctractOIFtpPusher to be used within an OITransport object.
AbstractOIFtpPusher(LoggerIfc lgr, java.lang.String localdir, java.lang.String ftphost, java.lang.String ftpuser, java.lang.String ftppasswd, java.lang.String ftpdir, java.lang.String ftpext, boolean sftpUsed, java.lang.String hostsFile) Construct a new AbsctractOIFtpPusher to be used within an OITransport object.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doTransfer() transfer the files in this method.
void	enablePassiveMode(boolean passive) Enable (or disable) passive FTP mode.
int	getFileMode() Returns the FTP transfer mode.
java.util.List	getFiles()
java.lang.String	getFtpDirectory() Return the destination directory on the remote FTP host.
java.lang.String	getFtpExtension() Returns the file extension for files that have been transferred.
java.lang.String	getFtpHost() Return the name/IP address of the remote FTP host.
java.lang.String	getFtpLogin() Return the login name for the remote FTP user.
java.lang.String	getFtpPassword() Return the password for the remote FTP user.
int	getFtpPort()
long	getFtpTimeInterval() get ftpTimeInterval and pass to the timer
java.lang.String	getLocalDirectory() Return the local directory containing the files to be transferred.
boolean	isHealthy() This method is used to check if the pusher is fully functional.
void	run() While there are files to transfer, attempt to make the connection to the remote host and transfer all files.
void	setAsciiFileMode() Sets the FTP transfer mode to ascii.
void	setBinaryFileMode() Sets the FTP transfer mode to binary.
void	setFiles(java.util.List fileNames) Add each file in the given list to the list of files to be transferred.
void	setFtpDirectory(java.lang.String dir) Sets the destination directory on the remote FTP host.
void	setFtpExtension(java.lang.String ext) Sets the file extension for files that have been transferred.
void	setFtpHost(java.lang.String host) Sets the name/IP address of the remote FTP host.
void	setFtpLogin(java.lang.String login) Sets the login name for the remote FTP user.
void	setFtpPassword(java.lang.String passwd) Sets the password for the remote FTP user.
void	setFtpPort(int port)
void	setFtpTimeInterval(long interval) set ftpInterval when the pusher object is instantiated in a specific node, the ftpTimeInterval is read in from the config file.
void	setLocalDirectory(java.lang.String dir) Sets the local directory containing the files to be transferred.
void	shutdown() Perform the necessary shutdown tasks.

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

DEFAULT_FTP_PORT

public static final int DEFAULT_FTP_PORT

See Also:

Constant Field Values

DEFAULT_SFTP_PORT

public static final int DEFAULT_SFTP_PORT

See Also:

Constant Field Values

SSH_KNOWN_HOSTS_FILE

public static final java.lang.String SSH_KNOWN_HOSTS_FILE

See Also:

Constant Field Values

ftpRunning

protected boolean ftpRunning

passiveMode

protected boolean passiveMode

delay

protected int delay

ftpFileType

protected int ftpFileType

ftpFilter

protected java.io.FilenameFilter ftpFilter

ftpClient

protected FtpSupportIntf ftpClient

logger

protected LoggerIfc logger

errMesg

protected java.lang.String errMesg

ftpDirectory

protected java.lang.String ftpDirectory

ftpExtension

protected java.lang.String ftpExtension

ftpHost

protected java.lang.String ftpHost

ftpPort

protected int ftpPort

ftpPasswd

protected java.lang.String ftpPasswd

ftpUser

protected java.lang.String ftpUser

localDirectory

protected java.lang.String localDirectory

interruptDelay

protected int interruptDelay

filesToFTP

protected java.util.Vector filesToFTP

ftpTimeInterval

protected long ftpTimeInterval

bFailed

protected boolean bFailed

oinode

protected DCNode oinode

sftpUsed

protected boolean sftpUsed

hostsFile

protected java.lang.String hostsFile

Constructor Detail

AbstractOIFtpPusher

public AbstractOIFtpPusher(LoggerIfc lgr,
                   java.lang.String localdir,
                   java.lang.String ftphost,
                   java.lang.String ftpuser,
                   java.lang.String ftppasswd,
                   java.lang.String ftpdir,
                   java.lang.String ftpext,
                   boolean sftpUsed,
                   java.lang.String hostsFile)
                    throws NodeStartException

Construct a new AbsctractOIFtpPusher to be used within an OITransport object. The file transfers will occur based upon the provided configuration parameters.

Parameters:

lgr - Reference to the log methods of the node

localdir - Local directory containing the files to be transferred

ftphost - Name/IP address of the remote ftp host

ftpuser - Name used to login to the remote host

ftppasswd - Password used to login to the remote host

ftpdir - Remote directory in which to place the files

ftpext - File extension used to tag the local files as having been transferred. If this parameter is null or zero-length, the local files will be deleted rather than renamed.

sftpUsed - If Sftp is used

hostsFile - If Sftp is used, need to specify the hosts file which contains the server finger prints.

Throws:

NodeStartException

AbstractOIFtpPusher

public AbstractOIFtpPusher(LoggerIfc lgr,
                   java.lang.String localdir,
                   java.lang.String ftphost,
                   int ftpport,
                   java.lang.String ftpuser,
                   java.lang.String ftppasswd,
                   java.lang.String ftpdir,
                   java.lang.String ftpext,
                   boolean sftpUsed,
                   java.lang.String hostsFile)
                    throws NodeStartException

Construct a new AbsctractOIFtpPusher to be used within an OITransport object. The file transfers will occur based upon the provided configuration parameters.

Parameters:

lgr - Reference to the log methods of the node

localdir - Local directory containing the files to be transferred

ftphost - Name/IP address of the remote ftp host

ftpport - FTP port number, default is 21

ftpuser - Name used to login to the remote host

ftppasswd - Password used to login to the remote host

ftpdir - Remote directory in which to place the files

ftpext - File extension used to tag the local files as having been transferred. If this parameter is null or zero-length, the local files will be deleted rather than renamed.

sftpUsed - If Sftp is used

hostsFile - If Sftp is used, need to specify the hosts file which contains the server finger prints.

Throws:

NodeStartException

AbstractOIFtpPusher

public AbstractOIFtpPusher(LoggerIfc lgr,
                   java.lang.String localdir,
                   java.lang.String ftphost,
                   int ftpport,
                   java.lang.String ftpuser,
                   java.lang.String ftppasswd,
                   java.lang.String ftpdir,
                   java.lang.String ftpext,
                   boolean sftpUsed,
                   java.lang.String hostsFile,
                   int interruptDelay)
                    throws NodeStartException

Construct a new AbsctractOIFtpPusher to be used within an OITransport object. The file transfers will occur based upon the provided configuration parameters.

Parameters:

lgr - Reference to the log methods of the node

localdir - Local directory containing the files to be transferred

ftphost - Name/IP address of the remote ftp host

ftpport - FTP port number, default is 21

ftpuser - Name used to login to the remote host

ftppasswd - Password used to login to the remote host

ftpdir - Remote directory in which to place the files

ftpext - File extension used to tag the local files as having been transferred. If this parameter is null or zero-length, the local files will be deleted rather than renamed.

sftpUsed - If Sftp is used

hostsFile - If Sftp is used, need to specify the hosts file which contains the server finger prints.

interruptDelay - Timeout value for ftp connection, ftp transfer.

Throws:

NodeStartException

Method Detail

doTransfer

protected abstract void doTransfer()
                            throws java.io.IOException

transfer the files in this method. The client has already logged into the server and cd to the remote directory

Throws:

java.io.IOException

run

public void run()

While there are files to transfer, attempt to make the connection to the remote host and transfer all files. Once the transfer has occurred, disconnect and wait for the next batch of files to transfer.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

enablePassiveMode

public void enablePassiveMode(boolean passive)

Enable (or disable) passive FTP mode.

Parameters:

passive - true, if passive mode is desired.

setBinaryFileMode

public void setBinaryFileMode()

Sets the FTP transfer mode to binary.

setAsciiFileMode

public void setAsciiFileMode()

Sets the FTP transfer mode to ascii.

getFileMode

public int getFileMode()

Returns the FTP transfer mode.

Returns:

Returns an int indicating the transfer mode.

setLocalDirectory

public void setLocalDirectory(java.lang.String dir)

Sets the local directory containing the files to be transferred.

Parameters:

dir - Local directory containing the files to be transferred.

getLocalDirectory

public java.lang.String getLocalDirectory()

Return the local directory containing the files to be transferred.

Returns:

Returns the local directory containing the files to be transferred.

setFtpHost

public void setFtpHost(java.lang.String host)

Sets the name/IP address of the remote FTP host.

Parameters:

host - The remote FTP host.

getFtpHost

public java.lang.String getFtpHost()

Return the name/IP address of the remote FTP host.

Returns:

Returns the name/IP address of the remote FTP host.

setFtpPort

public void setFtpPort(int port)

getFtpPort

public int getFtpPort()

setFtpLogin

public void setFtpLogin(java.lang.String login)

Sets the login name for the remote FTP user.

Parameters:

login - The remote login name.

getFtpLogin

public java.lang.String getFtpLogin()

Return the login name for the remote FTP user.

Returns:

Returns the login name for the remote FTP user.

setFtpPassword

public void setFtpPassword(java.lang.String passwd)

Sets the password for the remote FTP user.

Parameters:

passwd - The password for the remote FTP user.

getFtpPassword

public java.lang.String getFtpPassword()

Return the password for the remote FTP user.

Returns:

Returns the password for the remote FTP user.

setFtpDirectory

public void setFtpDirectory(java.lang.String dir)

Sets the destination directory on the remote FTP host.

Parameters:

dir - The destination directory on the remote FTP host.

getFtpDirectory

public java.lang.String getFtpDirectory()

Return the destination directory on the remote FTP host.

Returns:

Returns the destination directory on the remote FTP host.

setFtpExtension

public void setFtpExtension(java.lang.String ext)

Sets the file extension for files that have been transferred.

Parameters:

ext - The file extension for files that have been transferred.

getFtpExtension

public java.lang.String getFtpExtension()

Returns the file extension for files that have been transferred.

Returns:

Returns the extension for files that have been transferred.

setFiles

public void setFiles(java.util.List fileNames)

Add each file in the given list to the list of files to be transferred.

Parameters:

fileNames - Vector of filenames which are to be transferred.

shutdown

public void shutdown()

Perform the necessary shutdown tasks.

isHealthy

public boolean isHealthy()

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

It includes checks if the local-directory exists and is readable and if the connection to the FTP server can be established.

getFtpTimeInterval

public long getFtpTimeInterval()

get ftpTimeInterval and pass to the timer

setFtpTimeInterval

public void setFtpTimeInterval(long interval)

set ftpInterval when the pusher object is instantiated in a specific node, the ftpTimeInterval is read in from the config file.

getFiles

public java.util.List getFiles()