Interface RemoteFS

All Known Subinterfaces:

RemoteFSDelegate

All Known Implementing Classes:

CommonsFtpAdapter, CommonsFtpsAdapter, Ftp4jAdapter, FtpAdapter, RemoteFSBean, SftpAdapter

public interface RemoteFS

Interface defines methods to access a remote filesystem.

Implementations of this interface can use different methods like ftp, sftp, nfs, scp to access the filesystem on a remote system.

The system using the RemoteFS subsystem is responsible for connecting and disconnecting before and after performing one of the actions.

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)
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 mode)	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

Method Details

setPort

void setPort(int port)
      throws RemoteFSException

Set port to use to access remote filesystem

Parameters:

port - port number to access remote filesystem

Throws:

RemoteFSException

getPort

int getPort()
     throws RemoteFSException

Return port number

Returns:

port number

Throws:

RemoteFSException

setForceUTF8

void setForceUTF8(boolean force)
           throws RemoteFSException

Force using UTF8 to remote filesystem

Parameters:

force - Use UTF8 if true

Throws:

RemoteFSException

isForceUTF8

boolean isForceUTF8()
             throws RemoteFSException

Return whether UTF8 is forced

Returns:

true if UTF8 forced

Throws:

RemoteFSException

setPassiveMode

void setPassiveMode(boolean mode)
             throws RemoteFSException

Set access mode to passive

Parameters:

mode - Use passive mode if true

Throws:

RemoteFSException

isPassiveMode

boolean isPassiveMode()
               throws RemoteFSException

Return if passive mode is used

Returns:

true if passive mode

Throws:

RemoteFSException

getDirectory

String getDirectory()
             throws RemoteFSException,
IOException

Get current remote directory

Returns:

Current remote directory

Throws:

RemoteFSException

IOException

setDirectory

void setDirectory(String directory)
           throws RemoteFSException,
IOException

Set remote directory

Parameters:

directory - Change remote directory to this directory

Throws:

RemoteFSException

IOException

toParentDirectory

void toParentDirectory()
                throws RemoteFSException,
IOException

Go to parent directory of current remote directory

Throws:

IOException

RemoteFSException

createDirectory

void createDirectory(String name)
              throws IOException,
RemoteFSException

Create directory on remote filesystem

Parameters:

name - Create directory with this name

Throws:

IOException

RemoteFSException

removeDirectory

void removeDirectory(String name)
              throws IOException,
RemoteFSException

Remove directory from remote filesystem

Parameters:

name - Remove directory with this name

Throws:

IOException

RemoteFSException

connect

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

Connect to remote server using user and password

Parameters:

server - server to connect to

user - user to use for authentication

password - password for authenticating user

Throws:

IOException

RemoteFSException

abortConnect

void abortConnect()
           throws RemoteFSException,
IOException

Abort a connection attempt

Throws:

RemoteFSException

IOException

disconnect

void disconnect()
         throws IOException,
RemoteFSException

Disconnect from remote server

Throws:

IOException

RemoteFSException

isConnected

boolean isConnected()
             throws RemoteFSException

Check if connected to remote system

Returns:

true if connected to remote system

Throws:

RemoteFSException

getFiles

RemoteFile[] getFiles()
               throws IOException,
RemoteFSException

Return all files in current remote directory.

Returns:

Array of RemoteFiles

Throws:

IOException

RemoteFSException

getFiles

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

Return all files in spefified remote directory.

Returns:

Array of RemoteFiles

Throws:

IOException

RemoteFSException - deprecated unsafe with spaces in directories on ftp servers

noop

void noop()
   throws IOException,
RemoteFSException

Throws:

IOException

RemoteFSException

putFile

void putFile(File file)
      throws IOException,
RemoteFSException

Put file to remote system

Parameters:

file - File to copy to remote system

Throws:

IOException

RemoteFSException

putFile

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

Throws:

IOException

RemoteFSException

put

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

Throws:

IOException

RemoteFSException

Since:

8.3

get

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

Throws:

IOException

RemoteFSException

Since:

8.3

getUnmonitored

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

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

Throws:

IOException

RemoteFSException

Since:

8.13

removeFile

void removeFile(String filename)
         throws IOException,
RemoteFSException

Remove file from remote system

Parameters:

filename - File te remove from remote system

Throws:

RemoteFSException

IOException

rename

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

Throws:

RemoteFSException

IOException

See Also:

• setDirectory(java.lang.String)

setProgressMonitor

void setProgressMonitor(RemoteFSProgressMonitor monitor)

Get reports on file currently being transferred

exists

boolean exists(String path)
        throws IOException,
RemoteFSException

Check the existence of a file

Throws:

IOException

RemoteFSException

existsDirectory

boolean existsDirectory(String path)
                 throws IOException,
RemoteFSException

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

Throws:

IOException

RemoteFSException