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(java.io.File inLocalRootDir) Copies the remote file to the specified local root dir plus the file's remote path.
java.io.InputStream	getInputStream()
java.lang.String	getName()
java.lang.String	getPath()
long	getSize()
java.util.Calendar	getTimestamp()
java.lang.String	getURL()
boolean	writeToLocalDir(java.io.File inLocalDir) Copies the remote file to the specified local directory.
boolean	writeToLocalFile(java.io.File inLocalFile) Copies the remote file to the specified local file.
long	writeToStream(java.io.OutputStream stream)

Method Detail

getName

java.lang.String getName()

getPath

java.lang.String getPath()

getURL

java.lang.String getURL()

getSize

long getSize()

getTimestamp

java.util.Calendar getTimestamp()

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Throws:

java.io.IOException

writeToStream

long writeToStream(java.io.OutputStream stream)
            throws java.io.IOException

Throws:

java.io.IOException

writeToLocalDir

boolean writeToLocalDir(java.io.File inLocalDir)
                 throws java.io.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:

java.io.IOException

writeToLocalFile

boolean writeToLocalFile(java.io.File inLocalFile)
                  throws java.io.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:

java.io.IOException

copyLocallyPreservingPath

boolean copyLocallyPreservingPath(java.io.File inLocalRootDir)
                           throws java.io.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:

java.io.IOException