com.hfg.util.io

Class FTPRemoteFile

java.lang.Object

com.hfg.util.io.AbstractRemoteFile

com.hfg.util.io.FTPRemoteFile

All Implemented Interfaces:

RemoteFile

public class FTPRemoteFile
extends AbstractRemoteFile

Implementation of RemoteFile for FTP files

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

Constructor Summary

Constructors

Constructor and Description
FTPRemoteFile(org.apache.commons.net.ftp.FTPClient inFTP, String inFTPServer, String inParentDirPath, org.apache.commons.net.ftp.FTPFile inFTPFile)

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream() Note that the FTP connection is closed when the returned InputStream is closed.
String	getName()
String	getPath()
String	getRequestedPath() The requested path may differ from getPath() if the requested path was a symbolic link.
long	getSize()
Calendar	getTimestamp()
String	getURL()
void	setFileTransferMode(int inValue) Use FTP.ASCII_FILE_TYPE or FTP.BINARY_FILE_TYPE (default).
FTPRemoteFile	setRequestedPath(String inValue)
long	writeToStream(OutputStream stream)

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

copyLocallyPreservingPath, toString, writeToLocalDir, writeToLocalFile

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPRemoteFile

public FTPRemoteFile(org.apache.commons.net.ftp.FTPClient inFTP,
                     String inFTPServer,
                     String inParentDirPath,
                     org.apache.commons.net.ftp.FTPFile inFTPFile)

Method Detail

getName

public String getName()

setRequestedPath

public FTPRemoteFile setRequestedPath(String inValue)

getRequestedPath

public String getRequestedPath()

Description copied from interface: RemoteFile

The requested path may differ from getPath() if the requested path was a symbolic link.

Returns:

The (unwildcarded) path as it was originally requested.

getPath

public String getPath()

getURL

public String getURL()

getSize

public long getSize()

getTimestamp

public Calendar getTimestamp()

setFileTransferMode

public void setFileTransferMode(int inValue)

Use FTP.ASCII_FILE_TYPE or FTP.BINARY_FILE_TYPE (default).

getInputStream

public InputStream getInputStream()
                           throws IOException

Note that the FTP connection is closed when the returned InputStream is closed.

Throws:

IOException

writeToStream

public long writeToStream(OutputStream stream)
                   throws IOException

Specified by:

writeToStream in interface RemoteFile

Overrides:

writeToStream in class AbstractRemoteFile

Throws:

IOException