Package com.compomics.util.io.ftp

Class FTP

java.lang.Object
com.compomics.util.io.ftp.FTP
public class FTP extends Object
This class was modified from a source found on the net (java.sun.com, search in developer section on 'FtpProtocolException PORT').
Author:
Lennart Martens + someone on the net...

  • Field Details

    • FTP_PORT

      public static final int FTP_PORT
      FTP port to use for connection.
      See Also:

    • FILE_GET

      public static int FILE_GET
      Pre-defined state.

    • FILE_PUT

      public static int FILE_PUT
      Pre-defined state.

    • command

      public String command
      The last command issued.

    • welcomeMsg

      public String welcomeMsg
      Welcome message from the server, if any.

    • serverResponse

      protected Vector serverResponse
      Array of strings (usually 1 entry) for the last reply from the server.

    • controlSocket

      protected Socket controlSocket
      Socket for communicating commands with the server.

    • serverOutput

      public PrintWriter serverOutput
      Stream for printing to the server.

    • serverInput

      public InputStream serverInput
      Buffered stream for reading replies from server.

    • strFileNameAndPath

      protected String strFileNameAndPath
      String to hold the file we are up/downloading

    • m_strSource

      protected String m_strSource

    • m_strDestination

      protected String m_strDestination

  • Constructor Details

    • FTP

      public FTP()
      Empty default constructor

    • FTP

      public FTP(String host) throws IOException
      Constructor for an FTP client connected to host host. Note that this constructor automatically makes the connection.
      Parameters:
      host - String with the hostname (or IP) to connect to.
      Throws:
      IOException - whenever a connection could not be made.

    • FTP

      public FTP(String host, int port) throws IOException
      Constructor for an FTP client connected to host host and port port. Note that this constructor automatically makes the connection.
      Parameters:
      host - String with the hostname (or IP) to connect to.
      port - int with the portnumber for the host FTP server.
      Throws:
      IOException - whenever a connection could not be made.

  • Method Details

    • setFilename

      public void setFilename(String strFile)
      This method sets the name of the file to up- or download.
      Parameters:
      strFile - String with the filename.

    • setSourceFile

      public void setSourceFile(String strSourceFile)
      This method allows to set the source for the file that is to be transferred.
      Parameters:
      strSourceFile - String with the sourec for the file to be transferred.

    • setDestinationFile

      public void setDestinationFile(String strDestinationFile)
      This method allows the specification of the destinationfile.
      Parameters:
      strDestinationFile - String with the destination file.

    • getSourceFile

      public String getSourceFile()
      This method reports on the sourcefile currently used in transfer.
      Returns:
      String with the source file.

    • getDestinationFile

      public String getDestinationFile()
      This method reports on the destinationfile currently used in transfer.
      Returns:
      String with the destination file.

    • serverIsOpen

      public boolean serverIsOpen()
      Return server connection status
      Returns:
      boolean 'true' when connected, 'false' otherwise.

    • setPassive

      public void setPassive(boolean mode)
      Set Passive mode Transfers. This is particularly useful when attempting to FTP via passive mode.
      Parameters:
      mode - boolean to indicate whether passive mode should be used.

    • readServerResponse

      public int readServerResponse() throws IOException
      This method allows the caller to capture the server response.
      Returns:
      int with the server's response.
      Throws:
      IOException - if an IOException occurs

    • sendServer

      public void sendServer(String cmd)
      Sends command cmd to the server.
      Parameters:
      cmd - String with the command to send.

    • getResponseString

      public String getResponseString()
      Returns all server response strings. It also clears the server-response buffer!
      Returns:
      String with all the server response strings.

    • getResponseStringNoReset

      public String getResponseStringNoReset()
      This method allows the caller to read the response strings from the server, without resetting the internal buffer (and thus not clearing the messages read by this messages).
      Returns:
      String with the server responses.

    • closeServer

      public void closeServer() throws IOException
      Issue the QUIT command to the FTP server and close the connection.
      Throws:
      IOException - if an IOException occurs

    • issueCommand

      protected int issueCommand(String cmd) throws IOException
      This method allows the caller to issue a command to the server.
      Parameters:
      cmd - String with the command to issue.
      Returns:
      int with the server reply status.
      Throws:
      IOException - when the connection with the server failed.

    • issueCommandCheck

      protected void issueCommandCheck(String cmd) throws IOException
      This method will issue the specified command and throw an exception whenever the reply is not equal to success! It basically converts an FTP error code into an FtpProtocolException.
      Parameters:
      cmd - String with the command to issue (and verify the response for)
      Throws:
      IOException - when the connection failed OR FtpProtocolException when the command was not understood by the server.

    • readReply

      protected int readReply() throws IOException
      This method attempts to read a reply from the FTP server.
      Returns:
      int with the reply from the server.
      Throws:
      IOException - whenever the reply could not be read.

    • openDataConnection

      protected Socket openDataConnection(String cmd) throws IOException
      This method will set up the networking for client-server data transfer and it will send the specified command to the server. This is typically used only for true file transfer.
      Parameters:
      cmd - String with the command to issue.
      Returns:
      Socket with the data connection socket.
      Throws:
      IOException - whenever communications could not be established.

    • openServer

      public void openServer(String host) throws IOException, UnknownHostException
      open a FTP connection to host host.
      Parameters:
      host - String with the hostname (or IP) to connect to.
      Throws:
      IOException - whenever connection could not be established.
      UnknownHostException - when the hostname cannot be resolved.

    • openServer

      public void openServer(String host, int port) throws IOException, UnknownHostException
      Open an FTP connection to host host on port port. This method can be used whenever the default FTP port (21) does not apply.
      Parameters:
      host - String with the hostname (or IP) of the FTP server.
      port - int with the portnumber the FTP server is listening on.
      Throws:
      IOException - whenever connection could not be established.
      UnknownHostException - when the hostname cannot be resolved.

    • login

      public void login(String user, String password) throws IOException
      Login user to a host with username user and password password.
      Parameters:
      user - String with the username to use.
      password - String with the password to use (passwords are sent in plain text in FTP!)
      Throws:
      IOException - if an IOException occurs

    • login

      public void login(String user) throws IOException
      Login user to a host with username user and no password such as HP server which uses the form "<username>/<password>,user.<group>.
      Parameters:
      user - String with the username (and possibly coded information such as password).
      Throws:
      IOException - if an IOException occurs

    • getAscii

      public BufferedReader getAscii(String filename) throws IOException
      GET a file from the FTP server in Ascii mode.
      Parameters:
      filename - String with the filename to get from the server.
      Returns:
      BufferedReader to the file on the server.
      Throws:
      IOException - whenever the file could not be read.

    • getBinary

      public BufferedInputStream getBinary(String filename) throws IOException
      GET a file from the FTP server in Binary mode.
      Parameters:
      filename - String with the filename to get from the server.
      Returns:
      BufferedInputStream to the file on the server.
      Throws:
      IOException - whenever the file could not be read.

    • putAscii

      public BufferedWriter putAscii(String filename) throws IOException
      PUT a file on the FTP server in Ascii mode.
      Parameters:
      filename - String with the filename to put on the server.
      Returns:
      BufferedWriter writer for completing the file on the server.
      Throws:
      IOException - whenever the file could not be sent.

    • putBinary

      public BufferedOutputStream putBinary(String filename) throws IOException
      PUT a file to the FTP server in Binary mode
      Parameters:
      filename - String with the filename to put on the server.
      Returns:
      BufferedOutputStream outputstream for completing the file on the server.
      Throws:
      IOException - whenever the file could not be sent.

    • appendAscii

      public BufferedWriter appendAscii(String filename) throws IOException
      APPEND (with create) to a file to the FTP server in Ascii mode.
      Parameters:
      filename - String with the name of the file to append to.
      Returns:
      BufferedWriter with the stream for appending to.
      Throws:
      IOException - whenever the writer fails.

    • appendBinary

      public BufferedOutputStream appendBinary(String filename) throws IOException
      APPEND (with create) to a file to the FTP server in Binary mode.
      Parameters:
      filename - String with the name of the file to append to.
      Returns:
      BufferedOutputStream with the stream for appending to.
      Throws:
      IOException - whenever the writer fails.

    • nlist

      public BufferedReader nlist() throws IOException
      NLIST files on a remote FTP server
      Returns:
      BufferedReader to read the listing from.
      Throws:
      IOException - whenever the listing failed.

    • list

      public BufferedReader list() throws IOException
      LIST files on a remote FTP server.
      Returns:
      BufferedReader to read the listing from.
      Throws:
      IOException - whenever the listing failed.

    • ls

      public BufferedReader ls() throws IOException
      Folder-list files on a remote FTP server.
      Returns:
      BufferedReader to read the listing from.
      Throws:
      IOException - whenever the listing failed.

    • dir

      public BufferedReader dir() throws IOException
      Folder-list files on a remote FTP server.
      Returns:
      BufferedReader to read the listing from.
      Throws:
      IOException - whenever the listing failed.

    • cd

      public void cd(String remoteDirectory) throws IOException
      CD to a specific directory on a remote FTP server.
      Parameters:
      remoteDirectory - String with the directory to CD to.
      Throws:
      IOException - whenever the CD failed.

    • cwd

      public void cwd(String remoteDirectory) throws IOException
      Change working directory to a specific directory on a remote FTP server.
      Parameters:
      remoteDirectory - String with the directory to CWD to.
      Throws:
      IOException - whenever the CWD failed.

    • rename

      public void rename(String oldFile, String newFile) throws IOException
      Rename a file on the remote server.
      Parameters:
      oldFile - String with the original filename for the file to rename.
      newFile - String with the filename to rename the file to.
      Throws:
      IOException - when the renaming failed.

    • site

      public void site(String params) throws IOException
      Site Command
      Parameters:
      params - String with the parameters for the SITE command.
      Throws:
      IOException - when the SITE command failed.

    • binary

      public void binary() throws IOException
      Set transfer type to 'I' (binary transfer).
      Throws:
      IOException - when the binary mode could not be set up.

    • ascii

      public void ascii() throws IOException
      Set transfer type to 'A' (ascii transfer).
      Throws:
      IOException - when the ASCII mode could not be set up.

    • abort

      public void abort() throws IOException
      Send Abort command.
      Throws:
      IOException - when the cancellation could not be executed.

    • cdup

      public void cdup() throws IOException
      Go up one directory on remote system.
      Throws:
      IOException - when the CDUP failed.

    • mkdir

      public void mkdir(String aDir) throws IOException
      Create a directory on the remote system
      Parameters:
      aDir - String with the name for the directory to be created.
      Throws:
      IOException - when the directory could not be created.

    • rmdir

      public void rmdir(String aDir) throws IOException
      Delete the specified directory from the ftp server file system.
      Parameters:
      aDir - String with the directory to delete.
      Throws:
      IOException - when the deletion did not succeed.

    • delete

      public void delete(String aFile) throws IOException
      Delete the specified file from the ftp server file system.
      Parameters:
      aFile - String with the filename for the file to delete.
      Throws:
      IOException - when the deletion did not succeed.

    • pwd

      public void pwd() throws IOException
      Get the name of the present working directory on the ftp server file system.
      Throws:
      IOException - whenever the server did not report on the pwd.

    • syst

      public void syst() throws IOException
      Retrieve the system type from the remote server.
      Throws:
      IOException - whenever the system type could not be determined.

    • SetFileMode

      public void SetFileMode(int nMode)
      This method sets the file transfer mode.
      Parameters:
      nMode - int with the mode (either FILE_GET for retrieval, or any other int for sending a file).