org.waarp.ftp.client

Interface WaarpFtpClientInterface

All Known Implementing Classes:

WaarpFtp4jClient, WaarpFtpClient

public interface WaarpFtpClientInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANNOT_EXECUTE_OPERATION_FEATURE
static String	CANNOT_EXECUTE_OPERATION_SITE
static String	CANNOT_FINALIZE_RETRIEVE_LIKE_OPERATION
static String	CANNOT_FINALIZE_STORE_LIKE_OPERATION
static String	CANNOT_FINALIZE_TRANSFER_OPERATION
static String	CHDIR_IN_ERROR
static String	CONNECTION_IN_ERROR
static String	DISCONNECTION_IN_ERROR
static String	FILE_TYPE_IN_ERROR
static String	LOGIN_IN_ERROR
static String	MKDIR_IN_ERROR
static String	NOOP_ERROR
static String	SET_BINARY_IN_ERROR

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

Field Detail

CANNOT_EXECUTE_OPERATION_SITE

static final String CANNOT_EXECUTE_OPERATION_SITE

See Also:

Constant Field Values

CANNOT_EXECUTE_OPERATION_FEATURE

static final String CANNOT_EXECUTE_OPERATION_FEATURE

See Also:

Constant Field Values

CANNOT_FINALIZE_TRANSFER_OPERATION

static final String CANNOT_FINALIZE_TRANSFER_OPERATION

See Also:

Constant Field Values

CHDIR_IN_ERROR

static final String CHDIR_IN_ERROR

See Also:

Constant Field Values

MKDIR_IN_ERROR

static final String MKDIR_IN_ERROR

See Also:

Constant Field Values

DISCONNECTION_IN_ERROR

static final String DISCONNECTION_IN_ERROR

See Also:

Constant Field Values

LOGIN_IN_ERROR

static final String LOGIN_IN_ERROR

See Also:

Constant Field Values

CONNECTION_IN_ERROR

static final String CONNECTION_IN_ERROR

See Also:

Constant Field Values

SET_BINARY_IN_ERROR

static final String SET_BINARY_IN_ERROR

See Also:

Constant Field Values

CANNOT_FINALIZE_STORE_LIKE_OPERATION

static final String CANNOT_FINALIZE_STORE_LIKE_OPERATION

See Also:

Constant Field Values

CANNOT_FINALIZE_RETRIEVE_LIKE_OPERATION

static final String CANNOT_FINALIZE_RETRIEVE_LIKE_OPERATION

See Also:

Constant Field Values

FILE_TYPE_IN_ERROR

static final String FILE_TYPE_IN_ERROR

See Also:

Constant Field Values

NOOP_ERROR

static final String NOOP_ERROR

See Also:

Constant Field Values

Method Detail

setReportActiveExternalIPAddress

void setReportActiveExternalIPAddress(String ipAddress)

Parameters:

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

setActiveDataTransferPortRange

void setActiveDataTransferPortRange(int from,
                                    int to)

Parameters:

from - the first port to used

to - the last port to used

getResult

String getResult()

Returns:

the result associated with the last command if any error

connect

boolean connect()

Try to connect to the server and goes with the authentication

Returns:

True if connected and authenticated, else False

logout

void logout()

QUIT the control connection

disconnect

void disconnect()

Disconnect the Ftp Client

makeDir

boolean makeDir(String newDir)

Create a new directory

Parameters:

newDir -

Returns:

True if created

changeDir

boolean changeDir(String newDir)

Change remote directory

Parameters:

newDir -

Returns:

True if the change is OK

changeFileType

boolean changeFileType(boolean binaryTransfer)

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

Parameters:

binaryTransfer -

Returns:

True if the change is OK

changeMode

void changeMode(boolean passive)

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

Parameters:

passive -

compressionMode

void compressionMode(boolean compression)

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

Parameters:

compression -

store

boolean store(String local,
              String remote)

Store File

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

store

boolean store(InputStream local,
              String remote)

Store File

Parameters:

local - local InputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

append

boolean append(String local,
               String remote)

Store File as Append

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

append

boolean append(InputStream local,
               String remote)

Store File as Append

Parameters:

local - local InputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

retrieve

boolean retrieve(String local,
                 String remote)

Retrieve File

Parameters:

local - local filepath (full path)

remote - filename (basename)

Returns:

True if the file is correctly transferred

retrieve

boolean retrieve(OutputStream local,
                 String remote)

Retrieve File

Parameters:

local - local OutputStream

remote - filename (basename)

Returns:

True if the file is correctly transferred

transferFile

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

Ask to transfer a file

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

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

Ask to transfer a file as STORE or APPEND

Parameters:

local - local outputStream

remote - filename (basename)

getStoreOrAppend - 1 = store, 2 = append

Returns:

True if the file is correctly transferred

transferFile

boolean transferFile(OutputStream local,
                     String remote)

Ask to transfer a file as GET

Parameters:

local - local outputStream (or NullStream)

remote - filename (basename)

Returns:

True if the file is correctly transferred

listFiles

String[] listFiles(String remote)

Parameters:

remote - remote file spec

Returns:

the list of Files as given by FTP

listFiles

String[] listFiles()

Returns:

the list of Files as given by FTP

mlistFiles

String[] mlistFiles(String remote)

Parameters:

remote - remote file spec

Returns:

the list of Files as given by FTP in MLSD format

mlistFiles

String[] mlistFiles()

Returns:

the list of Files as given by FTP in MLSD format

features

String[] features()

Returns:

the list of Features as String

featureEnabled

boolean featureEnabled(String feature)

Parameters:

feature -

Returns:

True if the given feature is listed

deleteFile

boolean deleteFile(String remote)

Parameters:

remote -

Returns:

True if deleted

executeCommand

String[] executeCommand(String params)

Parameters:

params -

Returns:

the string lines result for the command params

executeSiteCommand

String[] executeSiteCommand(String params)

Parameters:

params - command without SITE in front

Returns:

the string lines result for the SITE command params

noop

void noop()

Sends a No Op command