org.waarp.ftp.client

Class WaarpFtpClient

java.lang.Object

org.waarp.ftp.client.WaarpFtpClient

All Implemented Interfaces:

WaarpFtpClientInterface

public class WaarpFtpClient
extends Object
implements WaarpFtpClientInterface

FTP Client using Apache Commons net FTP client (not working using FTPS or FTPSE)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	directory
protected org.apache.commons.net.ftp.FTPClient	ftpClient
protected String	ipAddress
protected static WaarpLogger	logger Internal Logger
protected String	result

Fields inherited from interface org.waarp.ftp.client.WaarpFtpClientInterface

CANNOT_EXECUTE_OPERATION_FEATURE, CANNOT_EXECUTE_OPERATION_SITE, CANNOT_FINALIZE_RETRIEVE_LIKE_OPERATION, CANNOT_FINALIZE_STORE_LIKE_OPERATION, CANNOT_FINALIZE_TRANSFER_OPERATION, CHDIR_IN_ERROR, CONNECTION_IN_ERROR, DISCONNECTION_IN_ERROR, FILE_TYPE_IN_ERROR, LOGIN_IN_ERROR, MKDIR_IN_ERROR, NOOP_ERROR, SET_BINARY_IN_ERROR

Constructor Summary

Constructors

Constructor and Description
WaarpFtpClient(String server, int port, String user, String pwd, String acct, boolean isPassive, int ssl, int controlTimeout, int timeout) WARNING: SSL mode (FTPS and FTPSE) are not working due to a bug in Apache Commons-Net
WaarpFtpClient(String server, int port, String user, String pwd, String acct, boolean isPassive, int ssl, int controlTimeout, int timeout, boolean trace) WARNING: SSL mode (FTPS and FTPSE) are not working due to a bug in Apache Commons-Net

Method Summary

Modifier and Type	Method and Description
boolean	append(InputStream local, String remote) Store File as Append
boolean	append(String local, String remote) Store File as Append
boolean	changeDir(String newDir) Change remote directory
boolean	changeFileType(boolean binaryTransfer) Change the FileType of Transfer (Binary true, ASCII false)
void	changeMode(boolean passive) Change to passive (true) or active (false) mode
void	compressionMode(boolean compression) Change to ZLIB compression (true) or inactive (false) mode.
boolean	connect() Try to connect to the server and goes with the authentication
boolean	deleteFile(String remote)
void	disconnect() Disconnect the Ftp Client
String[]	executeCommand(String params)
String[]	executeSiteCommand(String params)
boolean	featureEnabled(String feature)
String[]	features()
String	getResult()
String[]	listFiles()
String[]	listFiles(String remote)
void	logout() QUIT the control connection
boolean	makeDir(String newDir) Create a new directory
String[]	mlistFiles()
String[]	mlistFiles(String remote)
void	noop() Sends a No Op command
boolean	retrieve(OutputStream local, String remote) Retrieve File
boolean	retrieve(String local, String remote) Retrieve File
void	setActiveDataTransferPortRange(int from, int to)
void	setReportActiveExternalIPAddress(String ipAddress)
boolean	store(InputStream local, String remote) Store File
boolean	store(String local, String remote) Store File
boolean	transferFile(InputStream local, String remote, int getStoreOrAppend) Ask to transfer a file as STORE or APPEND
boolean	transferFile(OutputStream local, String remote) Ask to transfer a file as GET
boolean	transferFile(String local, String remote, int getStoreOrAppend) Ask to transfer a file

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final WaarpLogger logger

Internal Logger

ftpClient

protected final org.apache.commons.net.ftp.FTPClient ftpClient

result

protected String result

directory

protected String directory

ipAddress

protected String ipAddress

Constructor Detail

WaarpFtpClient

public WaarpFtpClient(String server,
                      int port,
                      String user,
                      String pwd,
                      String acct,
                      boolean isPassive,
                      int ssl,
                      int controlTimeout,
                      int timeout)

WARNING: SSL mode (FTPS and FTPSE) are not working due to a bug in Apache Commons-Net

Parameters:

server -

port -

user -

pwd -

acct -

isPassive -

ssl -

timeout -

WaarpFtpClient

public WaarpFtpClient(String server,
                      int port,
                      String user,
                      String pwd,
                      String acct,
                      boolean isPassive,
                      int ssl,
                      int controlTimeout,
                      int timeout,
                      boolean trace)

WARNING: SSL mode (FTPS and FTPSE) are not working due to a bug in Apache Commons-Net

Parameters:

server -

port -

user -

pwd -

acct -

isPassive -

ssl -

timeout -

Method Detail

setReportActiveExternalIPAddress

public void setReportActiveExternalIPAddress(String ipAddress)

Specified by:

setReportActiveExternalIPAddress in interface WaarpFtpClientInterface

Parameters:

ipAddress - the external IP address to report in EPRT/PORT commands in active mode.

setActiveDataTransferPortRange

public void setActiveDataTransferPortRange(int from,
                                           int to)

Specified by:

setActiveDataTransferPortRange in interface WaarpFtpClientInterface

Parameters:

from - the first port to used

to - the last port to used

getResult

public final String getResult()

Specified by:

getResult in interface WaarpFtpClientInterface

Returns:

the result associated with the last command if any error

connect

public final boolean connect()

Description copied from interface: WaarpFtpClientInterface

Try to connect to the server and goes with the authentication

Specified by:

connect in interface WaarpFtpClientInterface

Returns:

True if connected and authenticated, else False

logout

public final void logout()

Description copied from interface: WaarpFtpClientInterface

QUIT the control connection

Specified by:

logout in interface WaarpFtpClientInterface

disconnect

public final void disconnect()

Description copied from interface: WaarpFtpClientInterface

Disconnect the Ftp Client

Specified by:

disconnect in interface WaarpFtpClientInterface

makeDir

public final boolean makeDir(String newDir)

Description copied from interface: WaarpFtpClientInterface

Create a new directory

Specified by:

makeDir in interface WaarpFtpClientInterface

Returns:

True if created

changeDir

public final boolean changeDir(String newDir)

Description copied from interface: WaarpFtpClientInterface

Change remote directory

Specified by:

changeDir in interface WaarpFtpClientInterface

Returns:

True if the change is OK

changeFileType

public final boolean changeFileType(boolean binaryTransfer)

Description copied from interface: WaarpFtpClientInterface

Change the FileType of Transfer (Binary true, ASCII false)

Specified by:

changeFileType in interface WaarpFtpClientInterface

Returns:

True if the change is OK

changeMode

public final void changeMode(boolean passive)

Description copied from interface: WaarpFtpClientInterface

Change to passive (true) or active (false) mode

Specified by:

changeMode in interface WaarpFtpClientInterface

compressionMode

public void compressionMode(boolean compression)

Description copied from interface: WaarpFtpClientInterface

Change to ZLIB compression (true) or inactive (false) mode. Only if supported.

Specified by:

compressionMode in interface WaarpFtpClientInterface

store

public final boolean store(String local,
                           String remote)

Description copied from interface: WaarpFtpClientInterface

Store File

Specified by:

store in interface WaarpFtpClientInterface

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

store

public final boolean store(InputStream local,
                           String remote)

Description copied from interface: WaarpFtpClientInterface

Store File

Specified by:

store in interface WaarpFtpClientInterface

Parameters:

local - local InputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

append

public final boolean append(String local,
                            String remote)

Description copied from interface: WaarpFtpClientInterface

Store File as Append

Specified by:

append in interface WaarpFtpClientInterface

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

append

public final boolean append(InputStream local,
                            String remote)

Description copied from interface: WaarpFtpClientInterface

Store File as Append

Specified by:

append in interface WaarpFtpClientInterface

Parameters:

local - local InputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

retrieve

public final boolean retrieve(String local,
                              String remote)

Description copied from interface: WaarpFtpClientInterface

Retrieve File

Specified by:

retrieve in interface WaarpFtpClientInterface

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

retrieve

public final boolean retrieve(OutputStream local,
                              String remote)

Description copied from interface: WaarpFtpClientInterface

Retrieve File

Specified by:

retrieve in interface WaarpFtpClientInterface

Parameters:

local - local OutputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

transferFile

public final boolean transferFile(String local,
                                  String remote,
                                  int getStoreOrAppend)

Description copied from interface: WaarpFtpClientInterface

Ask to transfer a file

Specified by:

transferFile in interface WaarpFtpClientInterface

Parameters:

local - local filepath (full path)

remote - filename (basename)

getStoreOrAppend - -1 = get, 1 = store, 2 = append

Returns:

True if the file is correctly transferred

transferFile

public final boolean transferFile(InputStream local,
                                  String remote,
                                  int getStoreOrAppend)

Description copied from interface: WaarpFtpClientInterface

Ask to transfer a file as STORE or APPEND

Specified by:

transferFile in interface WaarpFtpClientInterface

Parameters:

local - local outputStream

remote - filename (basename)

getStoreOrAppend - 1 = store, 2 = append

Returns:

True if the file is correctly transferred

transferFile

public final boolean transferFile(OutputStream local,
                                  String remote)

Description copied from interface: WaarpFtpClientInterface

Ask to transfer a file as GET

Specified by:

transferFile in interface WaarpFtpClientInterface

Parameters:

local - local outputStream (or NullStream)

remote - filename (basename)

Returns:

True if the file is correctly transferred

listFiles

public final String[] listFiles(String remote)

Specified by:

listFiles in interface WaarpFtpClientInterface

Parameters:

remote - remote file spec

Returns:

the list of Files as given by FTP

listFiles

public final String[] listFiles()

Specified by:

listFiles in interface WaarpFtpClientInterface

Returns:

the list of Files as given by FTP

mlistFiles

public final String[] mlistFiles(String remote)

Specified by:

mlistFiles in interface WaarpFtpClientInterface

Parameters:

remote - remote file spec

Returns:

the list of Files as given by FTP in MLSD format

mlistFiles

public final String[] mlistFiles()

Specified by:

mlistFiles in interface WaarpFtpClientInterface

Returns:

the list of Files as given by FTP in MLSD format

features

public final String[] features()

Specified by:

features in interface WaarpFtpClientInterface

Returns:

the list of Features as String

featureEnabled

public final boolean featureEnabled(String feature)

Specified by:

featureEnabled in interface WaarpFtpClientInterface

Returns:

True if the given feature is listed

deleteFile

public boolean deleteFile(String remote)

Specified by:

deleteFile in interface WaarpFtpClientInterface

Returns:

True if deleted

executeCommand

public final String[] executeCommand(String params)

Specified by:

executeCommand in interface WaarpFtpClientInterface

Returns:

the string lines result for the command params

executeSiteCommand

public final String[] executeSiteCommand(String params)

Specified by:

executeSiteCommand in interface WaarpFtpClientInterface

Parameters:

params - command without SITE in front

Returns:

the string lines result for the SITE command params

noop

public final void noop()

Description copied from interface: WaarpFtpClientInterface

Sends a No Op command

Specified by:

noop in interface WaarpFtpClientInterface