com.nt.udc.ndk.util

Class FtpSession

java.lang.Object

com.nt.udc.ndk.util.FtpSession

All Implemented Interfaces:

FtpSupportIntf

public class FtpSession
extends java.lang.Object
implements FtpSupportIntf

Handles some common methods and variables that are used in a single Ftp session.

Constructor Summary

Constructors

Constructor and Description
FtpSession(LoggerIfc l) Creats an FtpSession object.
FtpSession(java.lang.String host, int port, java.lang.String login, java.lang.String password, LoggerIfc l) Creates an FtpSession object with the given host, login and password.
FtpSession(java.lang.String host, int port, java.lang.String login, java.lang.String password, LoggerIfc l, int timerDelay) Creates an FtpSession object with the given host, login and password and timer delay..
FtpSession(java.lang.String host, java.lang.String login, java.lang.String password, LoggerIfc l) Creates an FtpSession object with the given host, login and password.
FtpSession(java.lang.String host, java.lang.String login, java.lang.String password, LoggerIfc l, int timerDelay)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cd(java.lang.String remotePath) Changes the current working directory.
boolean	delete(java.lang.String fileName) Remove a file from the remote host.
void	disconnect() Disconnects from the remote server
void	enableLocalActiveMode() Enables local active mode for transfers
void	enableLocalPassiveMode() Enables local passive mode for transfers
boolean	get(java.lang.String localFile, java.lang.String remoteFile) Copy the remote file to the local file.
java.lang.String	getHost() Returns the remote host
java.lang.String	getLogin() Returns the login name
java.lang.String	getPassword() Returns the login password
int	getPort()
long	getTimeout() Returns the timeout for FTP operations
java.util.Date	getTimestamp(java.lang.String remoteFile) gets the timestamp of the remote file
java.lang.String[]	listDirectories() lists the directories in the current working directory
java.lang.String[]	listDirectories(java.lang.String remotePath) lists the directories of the remote path
java.lang.String[]	listFiles() Returns the list of files in the current remote directory.
java.lang.String[]	listFiles(java.lang.String remotePath) Returns the list of files in the given remote directory.
FtpItem[]	listItems() Returns the list of files in the current remote directory.
FtpItem[]	listItems(java.lang.String remotePath) Returns the list of files in the given remote directory.
boolean	login() Logs into the remote host, using the internally set ip address, login name and password.
boolean	login(java.lang.String ip, java.lang.String login, java.lang.String password) Logs into the remote host, using the given ip address, login name and password.
boolean	logout() Logs out from the remote server
boolean	put(java.lang.String localFile, java.lang.String remoteFile) Copy the local file to the remote file.
java.lang.String	pwd() Returns the present working directory.
boolean	rename(java.lang.String from, java.lang.String to) renames files on a remote server
void	setAsciiFileType() Sets the transfer file type to ASCII
void	setBinaryFileType() Sets the transfer file type to BINARY
void	setHost(java.lang.String host) Sets the remote host.
void	setLogin(java.lang.String login) Sets the login name.
void	setPassword(java.lang.String pw) Sets the login password
void	setPort(int port)
void	setTimeout(int timeout) Sets the timeout for FTP operations

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpSession

public FtpSession(LoggerIfc l)

Creats an FtpSession object.

Parameters:

logger - event logger

FtpSession

public FtpSession(java.lang.String host,
          java.lang.String login,
          java.lang.String password,
          LoggerIfc l)

Creates an FtpSession object with the given host, login and password.

Parameters:

host - remote host (ip or hostname)

login - login name

password - login password

logger - event logger

FtpSession

public FtpSession(java.lang.String host,
          java.lang.String login,
          java.lang.String password,
          LoggerIfc l,
          int timerDelay)

FtpSession

public FtpSession(java.lang.String host,
          int port,
          java.lang.String login,
          java.lang.String password,
          LoggerIfc l)

Creates an FtpSession object with the given host, login and password.

Parameters:

host - remote host (ip or hostname)

port - Ftp port number, default is 21

login - login name

password - login password

logger - event logger

FtpSession

public FtpSession(java.lang.String host,
          int port,
          java.lang.String login,
          java.lang.String password,
          LoggerIfc l,
          int timerDelay)

Creates an FtpSession object with the given host, login and password and timer delay..

Parameters:

host - remote host (ip or hostname)

port - Ftp port number, default is 21

login - login name

password - login password

l - logger interface of the node

timerDelay - the timeout value for ftp connection,transfer.

Method Detail

setHost

public void setHost(java.lang.String host)

Sets the remote host.

Parameters:

host - remote host, as an ip address or name

setPort

public void setPort(int port)

setLogin

public void setLogin(java.lang.String login)

Sets the login name.

Parameters:

login - login name

setPassword

public void setPassword(java.lang.String pw)

Sets the login password

Parameters:

pw - login password

setBinaryFileType

public void setBinaryFileType()

Sets the transfer file type to BINARY

Specified by:

setBinaryFileType in interface FtpSupportIntf

setAsciiFileType

public void setAsciiFileType()

Sets the transfer file type to ASCII

Specified by:

setAsciiFileType in interface FtpSupportIntf

enableLocalActiveMode

public void enableLocalActiveMode()

Enables local active mode for transfers

enableLocalPassiveMode

public void enableLocalPassiveMode()

Enables local passive mode for transfers

setTimeout

public void setTimeout(int timeout)

Sets the timeout for FTP operations

Parameters:

timeout - - timeout interval in milliseconds

getHost

public java.lang.String getHost()

Returns the remote host

Specified by:

getHost in interface FtpSupportIntf

Returns:

remote host name

getPort

public int getPort()

getLogin

public java.lang.String getLogin()

Returns the login name

Specified by:

getLogin in interface FtpSupportIntf

Returns:

login name

getTimeout

public long getTimeout()

Returns the timeout for FTP operations

Returns:

timeout interval in milliseconds

getPassword

public java.lang.String getPassword()

Returns the login password

Specified by:

getPassword in interface FtpSupportIntf

Returns:

login password

login

public boolean login()
              throws java.io.IOException

Logs into the remote host, using the internally set ip address, login name and password.

Returns:

true, if login is successful. false, otherwise.

Throws:

java.io.IOException

login

public boolean login(java.lang.String ip,
            java.lang.String login,
            java.lang.String password)
              throws java.io.IOException

Logs into the remote host, using the given ip address, login name and password.

Specified by:

login in interface FtpSupportIntf

Parameters:

ip - remote ip address

login - login name

password - login password

Returns:

true, if login is successful. false, otherwise.

Throws:

java.io.IOException

logout

public boolean logout()
               throws java.io.IOException

Logs out from the remote server

Specified by:

logout in interface FtpSupportIntf

Throws:

java.io.IOException

disconnect

public void disconnect()
                throws java.io.IOException

Disconnects from the remote server

Specified by:

disconnect in interface FtpSupportIntf

Throws:

java.io.IOException

get

public boolean get(java.lang.String localFile,
          java.lang.String remoteFile)
            throws java.io.IOException

Copy the remote file to the local file. One must set the appropriate file type before the get; the default is binary mode.

Specified by:

get in interface FtpSupportIntf

Parameters:

localFile - Local file name.

remoteFile - Remote file name.

Returns:

true, if get was successful.

Throws:

java.io.IOException

put

public boolean put(java.lang.String localFile,
          java.lang.String remoteFile)
            throws java.io.IOException

Copy the local file to the remote file. One must set the appropriate file type before the get; the default is binary mode.

Specified by:

put in interface FtpSupportIntf

Parameters:

localFile - Local file name.

remoteFile - Remote file name.

Returns:

true, if get was successful.

Throws:

java.io.IOException

delete

public boolean delete(java.lang.String fileName)
               throws java.io.IOException

Remove a file from the remote host.

Specified by:

delete in interface FtpSupportIntf

Parameters:

fileName - remote file pathname

Returns:

true, if delete was successful

Throws:

java.io.IOException

pwd

public java.lang.String pwd()
                     throws java.io.IOException

Returns the present working directory.

Specified by:

pwd in interface FtpSupportIntf

Returns:

present working directory

Throws:

java.io.IOException

cd

public boolean cd(java.lang.String remotePath)
           throws java.io.IOException

Changes the current working directory.

Specified by:

cd in interface FtpSupportIntf

Parameters:

remotePath - new remote directory

Returns:

present working directory

Throws:

java.io.IOException

listFiles

public java.lang.String[] listFiles(java.lang.String remotePath)
                             throws java.io.IOException

Returns the list of files in the given remote directory.

Specified by:

listFiles in interface FtpSupportIntf

Parameters:

remotePath - remote directory to list

Returns:

list of files (null if no files found)

Throws:

java.io.IOException

listFiles

public java.lang.String[] listFiles()
                             throws java.io.IOException

Returns the list of files in the current remote directory.

Specified by:

listFiles in interface FtpSupportIntf

Returns:

list of files (null if no files found)

Throws:

java.io.IOException

listItems

public FtpItem[] listItems(java.lang.String remotePath)
                    throws java.io.IOException

Returns the list of files in the given remote directory.

Parameters:

remotePath - remote directory to list

Returns:

list of files (null if no files found)

Throws:

java.io.IOException

listItems

public FtpItem[] listItems()
                    throws java.io.IOException

Returns the list of files in the current remote directory.

Returns:

list of files (null if no files found)

Throws:

java.io.IOException

listDirectories

public java.lang.String[] listDirectories()
                                   throws java.io.IOException

lists the directories in the current working directory

Returns:

array of the directory names

Throws:

java.io.IOException

listDirectories

public java.lang.String[] listDirectories(java.lang.String remotePath)
                                   throws java.io.IOException

lists the directories of the remote path

Specified by:

listDirectories in interface FtpSupportIntf

Parameters:

remotePath - remote directory to list

Returns:

array of the directory names

Throws:

java.io.IOException

getTimestamp

public java.util.Date getTimestamp(java.lang.String remoteFile)
                            throws java.io.IOException

gets the timestamp of the remote file

Specified by:

getTimestamp in interface FtpSupportIntf

Parameters:

remoteFile - remote path for which to get timestamp

Returns:

timestamp of the remote path

Throws:

java.io.IOException

rename

public boolean rename(java.lang.String from,
             java.lang.String to)
               throws java.io.IOException

renames files on a remote server

Specified by:

rename in interface FtpSupportIntf

Throws:

java.io.IOException