htsjdk.samtools.util.ftp
Class FTPClient

java.lang.Object
  htsjdk.samtools.util.ftp.FTPClient

public class FTPClient
extends java.lang.Object

Field Summary

static int

READ_TIMEOUT

Constructor Summary

FTPClient()

Method Summary

FTPReply	binary()
void	closeDataStream()
FTPReply	connect(java.lang.String host) Connects to the given FTP host on the default port.
void	disconnect() Disconnects from the host to which we are currently connected.
FTPReply	executeCommand(java.lang.String command) Executes the given FTP command on our current connection, returning the three digit response code from the server.
java.io.InputStream	getDataStream()
FTPReply	getReply()
FTPReply	login(java.lang.String username, java.lang.String password) Wrapper for the commands user [username] and pass [password].
FTPReply	pasv()
FTPReply	quit()
FTPReply	retr(java.lang.String file)
void	setRestPosition(long position)
FTPReply	size(java.lang.String file) Return the size of the remote file

Methods inherited from class java.lang.Object

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

Field Detail

READ_TIMEOUT

public static int READ_TIMEOUT

Constructor Detail

FTPClient

public FTPClient()

Method Detail

connect

public FTPReply connect(java.lang.String host)
                 throws java.io.IOException

Connects to the given FTP host on the default port.

Throws:

java.io.IOException

executeCommand

public FTPReply executeCommand(java.lang.String command)
                        throws java.io.IOException

Executes the given FTP command on our current connection, returning the three digit response code from the server. This method only works for commands that do not require an additional data port.

Throws:

java.io.IOException

login

public FTPReply login(java.lang.String username,
                      java.lang.String password)
               throws java.io.IOException

Wrapper for the commands user [username] and pass [password].

Throws:

java.io.IOException

quit

public FTPReply quit()
              throws java.io.IOException

Throws:

java.io.IOException

binary

public FTPReply binary()
                throws java.io.IOException

Throws:

java.io.IOException

pasv

public FTPReply pasv()
              throws java.io.IOException

Throws:

java.io.IOException

setRestPosition

public void setRestPosition(long position)

retr

public FTPReply retr(java.lang.String file)
              throws java.io.IOException

Throws:

java.io.IOException

getReply

public FTPReply getReply()
                  throws java.io.IOException

Throws:

java.io.IOException

size

public FTPReply size(java.lang.String file)
              throws java.io.IOException

Return the size of the remote file

Parameters:

file -

Returns:

Throws:

java.io.IOException

getDataStream

public java.io.InputStream getDataStream()
                                  throws java.io.IOException

Throws:

java.io.IOException

closeDataStream

public void closeDataStream()
                     throws java.io.IOException

Throws:

java.io.IOException

disconnect

public void disconnect()

Disconnects from the host to which we are currently connected.