com.hfg.util.io

Interface RemoteFile

All Known Implementing Classes:

AbstractRemoteFile, FileSystemRemoteFile, FTPRemoteFile, HTTPRemoteFile

public interface RemoteFile

Interface for remote files

Method Summary

Modifier and Type	Method and Description
boolean	copyLocallyPreservingPath(File inLocalRootDir) Copies the remote file to the specified local root dir plus the file's remote path.
InputStream	getInputStream()
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()
boolean	writeToLocalDir(File inLocalDir) Copies the remote file to the specified local directory.
boolean	writeToLocalFile(File inLocalFile) Copies the remote file to the specified local file.
long	writeToStream(OutputStream stream)

Method Detail

getName

String getName()

getPath

String getPath()

getRequestedPath

String getRequestedPath()

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

Returns:

The (unwildcarded) path as it was originally requested.

getURL

String getURL()

getSize

long getSize()

getTimestamp

Calendar getTimestamp()

getInputStream

InputStream getInputStream()
                    throws IOException

Throws:

IOException

writeToStream

long writeToStream(OutputStream stream)
            throws IOException

Throws:

IOException

writeToLocalDir

boolean writeToLocalDir(File inLocalDir)
                 throws IOException

Copies the remote file to the specified local directory. If a local file exists and is up-to-date (same size and an equivalent or newer last modified time), no transfer is done.

Returns:

Whether or not the file was actually transferred.

Throws:

IOException

writeToLocalFile

boolean writeToLocalFile(File inLocalFile)
                  throws IOException

Copies the remote file to the specified local file. If the local file exists and is up-to-date (same size and an equivalent or newer last modified time), no transfer is done.

Returns:

Whether or not the file was actually transferred.

Throws:

IOException

copyLocallyPreservingPath

boolean copyLocallyPreservingPath(File inLocalRootDir)
                           throws IOException

Copies the remote file to the specified local root dir plus the file's remote path. If the local file exists and is up-to-date (same size and an equivalent or newer last modified time), no transfer is done.

Returns:

Whether or not the file was actually transferred.

Throws:

IOException