com.toolsverse.io

Class FtpUtils

Object

com.toolsverse.io.FtpUtils

Direct Known Subclasses:

FtpsUtils

public class FtpUtils
extends Object

The collection of methods which implement FTP protocol using org.apache.commons.net.ftp.

Since:

1.5

Version:

2.0

See Also:

FTPClient

Constructor Summary

Constructors

Constructor and Description
FtpUtils() Instantiates a new FtpUtils.
FtpUtils(String proxyHost, int proxyPort) Instantiates a new FtpUtils with a socket proxy using provided proxy host and port.

Method Summary

Modifier and Type	Method and Description
void	connect(String urlStr, String loginId, String loginPswd, boolean passiveMode) Connects to the FTP server.
void	connect(String urlStr, String loginId, String loginPswd, boolean passiveMode, Properties props) Connects to the FTP server.
boolean	deleteFile(String folder, String filename) Deletes file folder + filename.
void	disconnect() Disconnects from the FTP server.
boolean	done() Executed when IO command is finished.
void	executePostLoginCommand() Execute post login command.
List<FileResource>	getFileList(String folder, String filename, boolean includeFolders, int maxFiles, String orderBy) Gets the list of FileResource objects from the folder + filename.
org.apache.commons.net.ftp.FTPClient	getFTPClient() Gets the FTP client.
boolean	mkDir(String folder) Creates a folder.
boolean	rename(String fromFolder, String toFolder, String filename, String toFilename) Renames file fromFolder + filename to toFolder + toFilename.
InputStream	retrieveFile(String pickupFolder, String filename) Reads a file pickupFolder + filename and returns it as a InputStream.
boolean	retrieveFile(String pickupFolder, String filename, OutputStream out) Writes a file pickupFolder + filename into OutputStream.
boolean	storeFile(String dropOffFolder, String filename, InputStream in) Stores a file on the server using name dropOffFolder + filename and taking input from the given InputStream.

Methods inherited from class Object

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

Constructor Detail

FtpUtils

public FtpUtils()

Instantiates a new FtpUtils.

FtpUtils

public FtpUtils(String proxyHost,
                int proxyPort)

Instantiates a new FtpUtils with a socket proxy using provided proxy host and port.

Parameters:

proxyHost - the socket proxy host

proxyPort - the socket proxy port

Method Detail

getFTPClient

public org.apache.commons.net.ftp.FTPClient getFTPClient()

Gets the FTP client.

Returns:

the FTP client

connect

public void connect(String urlStr,
                    String loginId,
                    String loginPswd,
                    boolean passiveMode)
             throws Exception

Connects to the FTP server.

Parameters:

urlStr - the url

loginId - the login id

loginPswd - the login ppassword

passiveMode - the passive mode flag

Throws:

Exception - in case of any error

connect

public void connect(String urlStr,
                    String loginId,
                    String loginPswd,
                    boolean passiveMode,
                    Properties props)
             throws Exception

Connects to the FTP server.

Parameters:

urlStr - the url

loginId - the login id

loginPswd - the login ppassword

passiveMode - the passive mode flag

props - the properties

Throws:

Exception - in case of any error

executePostLoginCommand

public void executePostLoginCommand()
                             throws Exception

Execute post login command.

Throws:

Exception - the exception

deleteFile

public boolean deleteFile(String folder,
                          String filename)
                   throws Exception

Deletes file folder + filename.

Parameters:

folder - the folder

filename - the filename

Returns:

true, if successful

Throws:

Exception - in case of any error

disconnect

public void disconnect()
                throws Exception

Disconnects from the FTP server.

Throws:

Exception - in case of any error

done

public boolean done()
             throws Exception

Executed when IO command is finished. Internally executes completePendingCommand.

Returns:

true, if successful

Throws:

Exception - in case of any error

getFileList

public List<FileResource> getFileList(String folder,
                                      String filename,
                                      boolean includeFolders,
                                      int maxFiles,
                                      String orderBy)
                               throws Exception

Gets the list of FileResource objects from the folder + filename. filename can be a mask, for example: /usr/test/*.txt. If includeFolders == true recursively includes sub-folders.

Parameters:

folder - the folder

filename - the filename

includeFolders - the include folders flag. If equals to true recursively includes sub-folders

maxFiles - the max files

orderBy - the order by

Returns:

the list of FileResource objects

Throws:

Exception - in case of any error

See Also:

FileResource

mkDir

public boolean mkDir(String folder)
              throws Exception

Creates a folder.

Parameters:

folder - the folder

Returns:

true, if successful

Throws:

Exception - in case of any error

rename

public boolean rename(String fromFolder,
                      String toFolder,
                      String filename,
                      String toFilename)
               throws Exception

Renames file fromFolder + filename to toFolder + toFilename.

Parameters:

fromFolder - the from folder

toFolder - the to folder

filename - the filename

toFilename - the to filename

Returns:

true, if successful

Throws:

Exception - in case of any error

retrieveFile

public InputStream retrieveFile(String pickupFolder,
                                String filename)
                         throws Exception

Reads a file pickupFolder + filename and returns it as a InputStream.

Parameters:

pickupFolder - the pickup folder

filename - the filename

Returns:

the InputStream

Throws:

Exception - in case of any error

retrieveFile

public boolean retrieveFile(String pickupFolder,
                            String filename,
                            OutputStream out)
                     throws Exception

Writes a file pickupFolder + filename into OutputStream.

Parameters:

pickupFolder - the pickup folder

filename - the filename

out - the OutputStream

Returns:

true, if successful

Throws:

Exception - in case of any error

storeFile

public boolean storeFile(String dropOffFolder,
                         String filename,
                         InputStream in)
                  throws Exception

Stores a file on the server using name dropOffFolder + filename and taking input from the given InputStream.

Parameters:

dropOffFolder - the drop off folder

filename - the filename

in - the InputStream

Returns:

true, if successful

Throws:

Exception - in case of any error