org.qbroker.net

Class SFTPConnector

java.lang.Object

org.qbroker.net.SFTPConnector

All Implemented Interfaces:

Connector

Direct Known Subclasses:

SFTPMessenger

public class SFTPConnector
extends java.lang.Object
implements Connector

SFTPConnector connects to a SSH server and provides the following methods for file transfers: sftpGet(), sftpPut() and sftpList().

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
SFTPConnector(java.util.Map props) Creates new SFTPConnector

Method Summary

Modifier and Type	Method and Description
void	close()
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.
com.jcraft.jsch.ChannelSftp	getChannelSftp()
protected static java.lang.String	getParent(java.lang.String filename) It returns dirname of the filename or null if it is a relative path.
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 in millis 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)
boolean	sftpCwd(java.lang.String pathname)
boolean	sftpDelete(java.lang.String pathname)
java.lang.String	sftpGet(java.io.File localFile, java.lang.String filename)
java.lang.String	sftpGet(java.io.OutputStream out, java.lang.String filename)
java.lang.String	sftpGet(java.lang.StringBuffer strBuf, java.lang.String filename)
java.lang.String[]	sftpList(java.lang.String dirname, int type) It returns an array of strings for requested files of type.
boolean	sftpMkd(java.lang.String pathname)
java.lang.String	sftpPut(java.io.File localFile, java.lang.String filename)
java.lang.String	sftpPut(java.io.InputStream in, java.lang.String filename)
java.lang.String	sftpPut(java.lang.String payload, java.lang.String filename)
java.lang.String	sftpPwd()
boolean	sftpRmd(java.lang.String pathname)
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

SFTPConnector

public SFTPConnector(java.util.Map props)
              throws com.jcraft.jsch.JSchException

Creates new SFTPConnector

Throws:

com.jcraft.jsch.JSchException

Method Detail

connect

protected void connect()
                throws com.jcraft.jsch.JSchException

Throws:

com.jcraft.jsch.JSchException

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

sftpGet

public java.lang.String sftpGet(java.io.File localFile,
                                java.lang.String filename)

sftpGet

public java.lang.String sftpGet(java.lang.StringBuffer strBuf,
                                java.lang.String filename)

sftpGet

public java.lang.String sftpGet(java.io.OutputStream out,
                                java.lang.String filename)

sftpPut

public java.lang.String sftpPut(java.io.File localFile,
                                java.lang.String filename)

sftpPut

public java.lang.String sftpPut(java.lang.String payload,
                                java.lang.String filename)

sftpPut

public java.lang.String sftpPut(java.io.InputStream in,
                                java.lang.String filename)

sftpList

public java.lang.String[] sftpList(java.lang.String dirname,
                                   int type)
                            throws com.jcraft.jsch.SftpException

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:

com.jcraft.jsch.SftpException

createDirectory

public java.lang.String createDirectory(java.lang.String dirname,
                                        int retry)
                                 throws com.jcraft.jsch.SftpException

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:

com.jcraft.jsch.SftpException

getParent

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

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

getChannelSftp

public com.jcraft.jsch.ChannelSftp getChannelSftp()

retrieveFileStream

public java.io.InputStream retrieveFileStream(java.lang.String remote)
                                       throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

storeFileStream

public java.io.OutputStream storeFileStream(java.lang.String remote)
                                     throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

sftpDelete

public boolean sftpDelete(java.lang.String pathname)
                   throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

sftpPwd

public java.lang.String sftpPwd()
                         throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

sftpCwd

public boolean sftpCwd(java.lang.String pathname)
                throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

sftpMkd

public boolean sftpMkd(java.lang.String pathname)
                throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

sftpRmd

public boolean sftpRmd(java.lang.String pathname)
                throws com.jcraft.jsch.SftpException

Throws:

com.jcraft.jsch.SftpException

getSize

public long getSize(java.lang.String remote)
             throws com.jcraft.jsch.SftpException

returns the file size or -1 in case of failure

Throws:

com.jcraft.jsch.SftpException

getTimestamp

public long getTimestamp(java.lang.String remote)
                  throws com.jcraft.jsch.SftpException

returns the mtime in millis or -1 in case of failure

Throws:

com.jcraft.jsch.SftpException

main

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