com.hfg.util.io

Class FTPRemoteFileLister

java.lang.Object

com.hfg.util.io.AbstractRemoteFileLister<FTPRemoteFile>

com.hfg.util.io.FTPRemoteFileLister

All Implemented Interfaces:

RemoteFileLister

public class FTPRemoteFileLister
extends AbstractRemoteFileLister<FTPRemoteFile>

Delineates FTP files matching the specified path. If behind a firewall that requires the use of proxies, you will need to set socksProxyHost and socksProxyPort (Jakarta's commons-net which is used for FTP uses sockets). See http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html for proxy details.

This class depends on Jakarta's commons-net library (which depends on jakarta-oro).

Constructor Summary

Constructors

Constructor and Description
FTPRemoteFileLister()
FTPRemoteFileLister(String inFilePath)
FTPRemoteFileLister(String inFilePath, List<RemoteFileFilter> inFilterList)

Method Summary

Modifier and Type	Method and Description
void	clearRemoteFileList()
org.apache.commons.net.ftp.FTPClient	getFTPClient()
String	getProtocol()
String	getProxyHost()
String	getProxyPassword()
Integer	getProxyPort()
String	getProxyUser()
protected List<FTPRemoteFile>	getUnfilteredRemoteFileListImpl()
void	logout()
void	setFilePath(String inFilePath)
FTPRemoteFileLister	setProxyHost(String inValue)
FTPRemoteFileLister	setProxyPassword(String inValue)
FTPRemoteFileLister	setProxyPort(int inValue)
FTPRemoteFileLister	setProxyUser(String inValue)

Methods inherited from class com.hfg.util.io.AbstractRemoteFileLister

addFilter, getFilePath, getFilteredRemoteFileList, getFilteredRemoteFileList, getFilterList, getReturnOnlyMostRecentFile, getUnfilteredRemoteFileList, setCredentials, setFilterList, setReturnOnlyMostRecentFile

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPRemoteFileLister

public FTPRemoteFileLister()

FTPRemoteFileLister

public FTPRemoteFileLister(String inFilePath)

FTPRemoteFileLister

public FTPRemoteFileLister(String inFilePath,
                           List<RemoteFileFilter> inFilterList)

Method Detail

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface RemoteFileLister

Specified by:

getProtocol in class AbstractRemoteFileLister<FTPRemoteFile>

setFilePath

public void setFilePath(String inFilePath)

Specified by:

setFilePath in interface RemoteFileLister

Overrides:

setFilePath in class AbstractRemoteFileLister<FTPRemoteFile>

getFTPClient

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

clearRemoteFileList

public void clearRemoteFileList()

Specified by:

clearRemoteFileList in class AbstractRemoteFileLister<FTPRemoteFile>

logout

public void logout()
            throws IOException

Throws:

IOException

setProxyHost

public FTPRemoteFileLister setProxyHost(String inValue)

getProxyHost

public String getProxyHost()

setProxyPort

public FTPRemoteFileLister setProxyPort(int inValue)

getProxyPort

public Integer getProxyPort()

setProxyUser

public FTPRemoteFileLister setProxyUser(String inValue)

getProxyUser

public String getProxyUser()

setProxyPassword

public FTPRemoteFileLister setProxyPassword(String inValue)

getProxyPassword

public String getProxyPassword()

getUnfilteredRemoteFileListImpl

protected List<FTPRemoteFile> getUnfilteredRemoteFileListImpl()

Specified by:

getUnfilteredRemoteFileListImpl in class AbstractRemoteFileLister<FTPRemoteFile>