org.qbroker.net

Class FTPConnector

java.lang.Object

org.qbroker.net.FTPConnector

All Implemented Interfaces:

Connector

Direct Known Subclasses:

FTPMessenger

public class FTPConnector
extends java.lang.Object
implements Connector

FTPConnector connects to an FTP server and provides the following methods for file transfers: ftpGet(), ftpPut() and ftpList().

This is NOT MT-Safe. Therefore, you need to use multiple instances to achieve your MT-Safty goal.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_CWD
static int	ACTION_DEL
static int	ACTION_GET
static int	ACTION_LIST
static int	ACTION_MKD
static int	ACTION_PUT
static int	ACTION_PWD
static int	ACTION_RMD
static int	ACTION_SIZE
static int	ACTION_TIME
static int	FTP_ALL
static int	FTP_DIRECTORY
static int	FTP_FILE
static int	FTP_LINK
static int	FTP_UNKNOWN
protected java.lang.String	uri

Constructor Summary

Constructors

Constructor and Description
FTPConnector(java.util.Map props) Creates new FTPConnector

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	completePendingCommand()
protected void	connect()
java.lang.String	createDirectory(java.lang.String dirname, int retry) It checks the existence of the directory tree on the server and creates the missing ones if necessary.
boolean	ftpCwd(java.lang.String pathname)
boolean	ftpDelete(java.lang.String pathname)
java.lang.String	ftpGet(java.io.File localFile, java.lang.String filename)
java.lang.String	ftpGet(java.io.OutputStream out, java.lang.String filename)
java.lang.String	ftpGet(java.lang.StringBuffer strBuf, java.lang.String filename)
java.lang.String[]	ftpList(java.lang.String dirname, int type) It returns an array of strings for requested files of type.
boolean	ftpMkd(java.lang.String pathname)
boolean	ftpNoOp()
java.lang.String	ftpPut(java.io.File localFile, java.lang.String filename)
java.lang.String	ftpPut(java.io.InputStream in, java.lang.String filename)
java.lang.String	ftpPut(java.lang.String payload, java.lang.String filename)
java.lang.String	ftpPwd()
boolean	ftpRmd(java.lang.String pathname)
org.apache.commons.net.ftp.FTPClient	getFTPClient()
static java.lang.String	getParent(java.lang.String filename) It returns dirname of the filename or null if it is a relative path.
int	getReplyCode()
java.lang.String	getReplyString()
long	getSize(java.lang.String remote) returns the file size or -1 in case of failure
long	getTimestamp(java.lang.String remote) returns the mtime or -1 in case of failure
java.lang.String	getURI()
boolean	isConnected()
static void	main(java.lang.String[] args)
java.lang.String	reconnect() It reconnects and returns null or error message upon failure
java.io.InputStream	retrieveFileStream(java.lang.String remote)
java.io.OutputStream	storeFileStream(java.lang.String remote)

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected java.lang.String uri

FTP_ALL

public static final int FTP_ALL

See Also:

Constant Field Values

FTP_FILE

public static final int FTP_FILE

See Also:

Constant Field Values

FTP_DIRECTORY

public static final int FTP_DIRECTORY

See Also:

Constant Field Values

FTP_LINK

public static final int FTP_LINK

See Also:

Constant Field Values

FTP_UNKNOWN

public static final int FTP_UNKNOWN

See Also:

Constant Field Values

ACTION_PWD

public static final int ACTION_PWD

See Also:

Constant Field Values

ACTION_CWD

public static final int ACTION_CWD

See Also:

Constant Field Values

ACTION_MKD

public static final int ACTION_MKD

See Also:

Constant Field Values

ACTION_RMD

public static final int ACTION_RMD

See Also:

Constant Field Values

ACTION_LIST

public static final int ACTION_LIST

See Also:

Constant Field Values

ACTION_GET

public static final int ACTION_GET

See Also:

Constant Field Values

ACTION_PUT

public static final int ACTION_PUT

See Also:

Constant Field Values

ACTION_DEL

public static final int ACTION_DEL

See Also:

Constant Field Values

ACTION_SIZE

public static final int ACTION_SIZE

See Also:

Constant Field Values

ACTION_TIME

public static final int ACTION_TIME

See Also:

Constant Field Values

Constructor Detail

FTPConnector

public FTPConnector(java.util.Map props)
             throws java.io.IOException

Creates new FTPConnector

Throws:

java.io.IOException

Method Detail

connect

protected void connect()
                throws java.io.IOException

Throws:

java.io.IOException

getURI

public java.lang.String getURI()

Specified by:

getURI in interface Connector

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Connector

reconnect

public java.lang.String reconnect()

It reconnects and returns null or error message upon failure

Specified by:

reconnect in interface Connector

close

public void close()

Specified by:

close in interface Connector

ftpGet

public java.lang.String ftpGet(java.io.File localFile,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpGet

public java.lang.String ftpGet(java.lang.StringBuffer strBuf,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpGet

public java.lang.String ftpGet(java.io.OutputStream out,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpPut

public java.lang.String ftpPut(java.io.File localFile,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpPut

public java.lang.String ftpPut(java.lang.String payload,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpPut

public java.lang.String ftpPut(java.io.InputStream in,
                               java.lang.String filename)
                        throws java.io.IOException

Throws:

java.io.IOException

ftpList

public java.lang.String[] ftpList(java.lang.String dirname,
                                  int type)
                           throws java.io.IOException

It returns an array of strings for requested files of type. In case of failure, it returns null. Due to individual parsing errors, the array may contain null members if type is FTP_ALL. In this case, caller should check each entry for null. For other types, any null member will be skipped. The names in the array do not contain the full path.

Throws:

java.io.IOException

ftpPwd

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

Throws:

java.io.IOException

ftpCwd

public boolean ftpCwd(java.lang.String pathname)
               throws java.io.IOException

Throws:

java.io.IOException

ftpMkd

public boolean ftpMkd(java.lang.String pathname)
               throws java.io.IOException

Throws:

java.io.IOException

ftpRmd

public boolean ftpRmd(java.lang.String pathname)
               throws java.io.IOException

Throws:

java.io.IOException

ftpDelete

public boolean ftpDelete(java.lang.String pathname)
                  throws java.io.IOException

Throws:

java.io.IOException

ftpNoOp

public boolean ftpNoOp()
                throws java.io.IOException

Throws:

java.io.IOException

completePendingCommand

public boolean completePendingCommand()
                               throws java.io.IOException

Throws:

java.io.IOException

getReplyCode

public int getReplyCode()
                 throws java.io.IOException

Throws:

java.io.IOException

getReplyString

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

Throws:

java.io.IOException

createDirectory

public java.lang.String createDirectory(java.lang.String dirname,
                                        int retry)
                                 throws java.io.IOException

It checks the existence of the directory tree on the server and creates the missing ones if necessary. It returns null if successful or the failed directory name otherwise. It requires the absolute path for dirname.

Throws:

java.io.IOException

getParent

public static java.lang.String getParent(java.lang.String filename)

It returns dirname of the filename or null if it is a relative path.

getFTPClient

public org.apache.commons.net.ftp.FTPClient getFTPClient()

retrieveFileStream

public java.io.InputStream retrieveFileStream(java.lang.String remote)
                                       throws java.io.IOException

Throws:

java.io.IOException

storeFileStream

public java.io.OutputStream storeFileStream(java.lang.String remote)
                                     throws java.io.IOException

Throws:

java.io.IOException

getSize

public long getSize(java.lang.String remote)
             throws java.io.IOException

returns the file size or -1 in case of failure

Throws:

java.io.IOException

getTimestamp

public long getTimestamp(java.lang.String remote)
                  throws java.io.IOException

returns the mtime or -1 in case of failure

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)