com.nt.udc.ndk.util

Interface FtpSupportIntf

All Known Implementing Classes:

FtpSession, SftpSession

public interface FtpSupportIntf

Use this interface in classes that you would like to support, or contain support for, FTP.

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 FTP server
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
java.util.Date	getTimestamp(java.lang.String remotePath) Returns the timestamp of the given remote path.
java.lang.String[]	listDirectories(java.lang.String remotePath) Returns the list of directories in the given remote directory.
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.
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 of the remote FTP 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)
void	setAsciiFileType() Sets the transfer file type to ASCII
void	setBinaryFileType() Sets the transfer file type to BINARY

Method Detail

login

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.

Parameters:

ip - remote ip address

login - login name

password - login password

Returns:

true, if login is successful. false, otherwise.

Throws:

java.io.IOException

logout

boolean logout()
               throws java.io.IOException

Logs out of the remote FTP server

Throws:

java.io.IOException

disconnect

void disconnect()
                throws java.io.IOException

Disconnects from the remote FTP server

Throws:

java.io.IOException

setBinaryFileType

void setBinaryFileType()

Sets the transfer file type to BINARY

setAsciiFileType

void setAsciiFileType()

Sets the transfer file type to ASCII

get

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.

Parameters:

localFile - Local file name.

remoteFile - Remote file name.

Returns:

true, if get was successful.

Throws:

java.io.IOException

put

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.

Parameters:

localFile - Local file name.

remoteFile - Remote file name.

Returns:

true, if get was successful.

Throws:

java.io.IOException

delete

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

Remove a file from the remote host.

Parameters:

fileName - remote file pathname

Returns:

true, if delete was successful

Throws:

java.io.IOException

pwd

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

Returns the present working directory.

Returns:

present working directory

Throws:

java.io.IOException

cd

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

Changes the current working directory.

Parameters:

remotePath - new remote directory

Returns:

present working directory

Throws:

java.io.IOException

listFiles

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

Returns the list of files in the current remote directory.

Returns:

list of files

Throws:

java.io.IOException

listFiles

java.lang.String[] listFiles(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

Throws:

java.io.IOException

listDirectories

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

Returns the list of directories in the given remote directory.

Parameters:

remotePath - remote directory to list

Returns:

list of directories

Throws:

java.io.IOException

getTimestamp

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

Returns the timestamp of the given remote path.

Parameters:

remotePath - remote path for which to get timestamp

Returns:

timestamp of the remote path

Throws:

java.io.IOException

rename

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

Throws:

java.io.IOException

getPassword

java.lang.String getPassword()

Returns the login password

Returns:

login password

getHost

java.lang.String getHost()

Returns the remote host

Returns:

remote host name

getLogin

java.lang.String getLogin()

Returns the login name

Returns:

login name