Class CommonsFtpAdapter

java.lang.Object

net.jalbum.remotefs.commons.ftp.CommonsFtpAdapter

All Implemented Interfaces:

RemoteFS

Direct Known Subclasses:

CommonsFtpsAdapter

public class CommonsFtpAdapter
extends Object
implements RemoteFS

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	forceUTF8
protected RemoteFSProgressMonitor	monitor
protected boolean	passive
protected int	port

Constructor Summary

Constructors

Modifier	Constructor	Description
	CommonsFtpAdapter()
protected	CommonsFtpAdapter(org.apache.commons.net.ftp.FTPClient client)

Method Summary

Modifier and Type	Method	Description
void	abortConnect()	Abort a connection attempt
void	connect(String server, String user, String password)	Connect to remote server using user and password
void	createDirectory(String name)	Create directory on remote filesystem
void	disconnect()	Disconnect from remote server
boolean	exists(String path)	Check the existence of a file
boolean	existsDirectory(String path)	Check the existence of a directory (the ftp protocol can't determine existence of both files and directories in one call)
void	get(String path, OutputStream out)
protected org.apache.commons.net.ftp.FTPClient	getClient()
String	getDirectory()	Get current remote directory
RemoteFile[]	getFiles()	Return all files in current remote directory.
RemoteFile[]	getFiles(String dir)	Return all files in spefified remote directory.
int	getPort()	Return port number
void	getUnmonitored(String path, OutputStream out)	Allows us to get :filetree on CrushFTP (avoids stat call)
boolean	isConnected()	Check if connected to remote system
boolean	isForceUTF8()	Return whether UTF8 is forced
boolean	isPassiveMode()	Return if passive mode is used
void	noop()
void	put(InputStream in, String path)
void	putFile(File file)	Put file to remote system
void	putFile(File file, String path)
void	removeDirectory(String name)	Remove directory from remote filesystem
void	removeFile(String filename)	Remove file from remote system
void	rename(String from, String to)
void	setDirectory(String directory)	Set remote directory
void	setForceUTF8(boolean force)	Force using UTF8 to remote filesystem
void	setPassiveMode(boolean passive)	Set access mode to passive
void	setPort(int port)	Set port to use to access remote filesystem
void	setProgressMonitor(RemoteFSProgressMonitor monitor)	Get reports on file currently being transferred
void	toParentDirectory()	Go to parent directory of current remote directory

Methods inherited from class java.lang.Object

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

Field Details

port

protected int port

forceUTF8

protected boolean forceUTF8

passive

protected boolean passive

monitor

protected RemoteFSProgressMonitor monitor

Constructor Details

CommonsFtpAdapter

public CommonsFtpAdapter()

CommonsFtpAdapter

protected CommonsFtpAdapter(org.apache.commons.net.ftp.FTPClient client)

Method Details

getClient

protected org.apache.commons.net.ftp.FTPClient getClient()

setPort

public void setPort(int port)
             throws RemoteFSException

Description copied from interface: RemoteFS

Set port to use to access remote filesystem

Specified by:

setPort in interface RemoteFS

Parameters:

port - port number to access remote filesystem

Throws:

RemoteFSException

getPort

public int getPort()
            throws RemoteFSException

Description copied from interface: RemoteFS

Return port number

Specified by:

getPort in interface RemoteFS

Returns:

port number

Throws:

RemoteFSException

setForceUTF8

public void setForceUTF8(boolean force)
                  throws RemoteFSException

Description copied from interface: RemoteFS

Force using UTF8 to remote filesystem

Specified by:

setForceUTF8 in interface RemoteFS

Parameters:

force - Use UTF8 if true

Throws:

RemoteFSException

isForceUTF8

public boolean isForceUTF8()
                    throws RemoteFSException

Description copied from interface: RemoteFS

Return whether UTF8 is forced

Specified by:

isForceUTF8 in interface RemoteFS

Returns:

true if UTF8 forced

Throws:

RemoteFSException

setPassiveMode

public void setPassiveMode(boolean passive)
                    throws RemoteFSException

Description copied from interface: RemoteFS

Set access mode to passive

Specified by:

setPassiveMode in interface RemoteFS

Parameters:

passive - Use passive mode if true

Throws:

RemoteFSException

isPassiveMode

public boolean isPassiveMode()
                      throws RemoteFSException

Description copied from interface: RemoteFS

Return if passive mode is used

Specified by:

isPassiveMode in interface RemoteFS

Returns:

true if passive mode

Throws:

RemoteFSException

getDirectory

public String getDirectory()
                    throws RemoteFSException,
IOException

Description copied from interface: RemoteFS

Get current remote directory

Specified by:

getDirectory in interface RemoteFS

Returns:

Current remote directory

Throws:

RemoteFSException

IOException

setDirectory

public void setDirectory(String directory)
                  throws RemoteFSException,
IOException

Description copied from interface: RemoteFS

Set remote directory

Specified by:

setDirectory in interface RemoteFS

Parameters:

directory - Change remote directory to this directory

Throws:

RemoteFSException

IOException

toParentDirectory

public void toParentDirectory()
                       throws RemoteFSException,
IOException

Description copied from interface: RemoteFS

Go to parent directory of current remote directory

Specified by:

toParentDirectory in interface RemoteFS

Throws:

RemoteFSException

IOException

createDirectory

public void createDirectory(String name)
                     throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Create directory on remote filesystem

Specified by:

createDirectory in interface RemoteFS

Parameters:

name - Create directory with this name

Throws:

IOException

RemoteFSException

removeDirectory

public void removeDirectory(String name)
                     throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Remove directory from remote filesystem

Specified by:

removeDirectory in interface RemoteFS

Parameters:

name - Remove directory with this name

Throws:

IOException

RemoteFSException

connect

public void connect(String server,
 String user,
 String password)
             throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Connect to remote server using user and password

Specified by:

connect in interface RemoteFS

Parameters:

server - server to connect to

user - user to use for authentication

password - password for authenticating user

Throws:

IOException

RemoteFSException

abortConnect

public void abortConnect()
                  throws RemoteFSException,
IOException

Description copied from interface: RemoteFS

Abort a connection attempt

Specified by:

abortConnect in interface RemoteFS

Throws:

RemoteFSException

IOException

disconnect

public void disconnect()
                throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Disconnect from remote server

Specified by:

disconnect in interface RemoteFS

Throws:

IOException

RemoteFSException

isConnected

public boolean isConnected()
                    throws RemoteFSException

Description copied from interface: RemoteFS

Check if connected to remote system

Specified by:

isConnected in interface RemoteFS

Returns:

true if connected to remote system

Throws:

RemoteFSException

getFiles

public RemoteFile[] getFiles()
                      throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Return all files in current remote directory.

Specified by:

getFiles in interface RemoteFS

Returns:

Array of RemoteFiles

Throws:

IOException

RemoteFSException

getFiles

public RemoteFile[] getFiles(String dir)
                      throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Return all files in spefified remote directory.

Specified by:

getFiles in interface RemoteFS

Returns:

Array of RemoteFiles

Throws:

IOException

RemoteFSException - deprecated unsafe with spaces in directories on ftp servers

noop

public void noop()
          throws IOException,
RemoteFSException

Specified by:

noop in interface RemoteFS

Throws:

IOException

RemoteFSException

putFile

public void putFile(File file)
             throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Put file to remote system

Specified by:

putFile in interface RemoteFS

Parameters:

file - File to copy to remote system

Throws:

IOException

RemoteFSException

putFile

public void putFile(File file,
 String path)
             throws IOException,
RemoteFSException

Specified by:

putFile in interface RemoteFS

Throws:

IOException

RemoteFSException

put

public void put(InputStream in,
 String path)
         throws IOException,
RemoteFSException

Specified by:

put in interface RemoteFS

Throws:

IOException

RemoteFSException

get

public void get(String path,
 OutputStream out)
         throws IOException,
RemoteFSException

Specified by:

get in interface RemoteFS

Throws:

IOException

RemoteFSException

getUnmonitored

public void getUnmonitored(String path,
 OutputStream out)
                    throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Allows us to get :filetree on CrushFTP (avoids stat call)

Specified by:

getUnmonitored in interface RemoteFS

Throws:

IOException

RemoteFSException

removeFile

public void removeFile(String filename)
                throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Remove file from remote system

Specified by:

removeFile in interface RemoteFS

Parameters:

filename - File te remove from remote system

Throws:

IOException

RemoteFSException

rename

public void rename(String from,
 String to)
            throws IOException,
RemoteFSException

Specified by:

rename in interface RemoteFS

Throws:

IOException

RemoteFSException

See Also:

• RemoteFS.setDirectory(java.lang.String)

setProgressMonitor

public void setProgressMonitor(RemoteFSProgressMonitor monitor)

Description copied from interface: RemoteFS

Get reports on file currently being transferred

Specified by:

setProgressMonitor in interface RemoteFS

exists

public boolean exists(String path)
               throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Check the existence of a file

Specified by:

exists in interface RemoteFS

Throws:

IOException

RemoteFSException

existsDirectory

public boolean existsDirectory(String path)
                        throws IOException,
RemoteFSException

Description copied from interface: RemoteFS

Check the existence of a directory (the ftp protocol can't determine existence of both files and directories in one call)

Specified by:

existsDirectory in interface RemoteFS

Throws:

IOException

RemoteFSException