HTTPRemoteFile (com.hfg API Documentation)

java.lang.Object
- com.hfg.util.io.AbstractRemoteFile
- - com.hfg.util.io.HTTPRemoteFile

All Implemented Interfaces:

RemoteFile
```
public class HTTPRemoteFile
extends AbstractRemoteFile
```
Implementation of RemoteFile for HTTP files

Constructor Summary

Constructors
Constructor and Description

HTTPRemoteFile(String inURL)

Constructors
Constructor and Description
`HTTPRemoteFile(String inURL)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`copyLocallyPreservingPath(File inLocalDir)` Copies the remote file to the specified local root dir plus the file's remote path.
`static String`	`getDefaultUserAgentString()`
`InputStream`	`getInputStream()`
`static Logger`	`getLogger()`
`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()`
`String`	`geUserAgentString()`
`static void`	`setDefaultUserAgentString(String inValue)`
`HTTPRemoteFile`	`setRequestedPath(String inValue)`
`HTTPRemoteFile`	`setUserAgentString(String inValue)`
`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)`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HTTPRemoteFile
```
public HTTPRemoteFile(String inURL)
```
- Method Detail
  - setDefaultUserAgentString
```
public static void setDefaultUserAgentString(String inValue)
```
  - getDefaultUserAgentString
```
public static String getDefaultUserAgentString()
```
  - setUserAgentString
```
public HTTPRemoteFile setUserAgentString(String inValue)
```
  - geUserAgentString
```
public String geUserAgentString()
```
  - getLogger
```
public static Logger getLogger()
```
  - getURL
```
public String getURL()
```
  - getName
```
public String getName()
```
  - getPath
```
public String getPath()
```
  - setRequestedPath
```
public HTTPRemoteFile 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.
  - getSize
```
public long getSize()
```
  - getTimestamp
```
public Calendar getTimestamp()
```
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Throws:
    
    IOException
  - writeToLocalDir
```
public boolean writeToLocalDir(File inLocalDir)
                        throws IOException
```
    Description copied from interface: RemoteFile
    
    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.
    
    Specified by:
    
    writeToLocalDir in interface RemoteFile
    
    Overrides:
    
    writeToLocalDir in class AbstractRemoteFile
    
    Returns:
    
    Whether or not the file was actually transferred.
    
    Throws:
    
    IOException
  - copyLocallyPreservingPath
```
public boolean copyLocallyPreservingPath(File inLocalDir)
                                  throws IOException
```
    Description copied from interface: RemoteFile
    
    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.
    
    Specified by:
    
    copyLocallyPreservingPath in interface RemoteFile
    
    Overrides:
    
    copyLocallyPreservingPath in class AbstractRemoteFile
    
    Returns:
    
    Whether or not the file was actually transferred.
    
    Throws:
    
    IOException
  - writeToStream
```
public long writeToStream(OutputStream stream)
                   throws IOException
```
    Specified by:
    
    writeToStream in interface RemoteFile
    
    Overrides:
    
    writeToStream in class AbstractRemoteFile
    
    Throws:
    
    IOException
  - writeToLocalFile
```
public boolean writeToLocalFile(File inLocalFile)
                         throws IOException
```
    Description copied from interface: RemoteFile
    
    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.
    
    Specified by:
    
    writeToLocalFile in interface RemoteFile
    
    Overrides:
    
    writeToLocalFile in class AbstractRemoteFile
    
    Returns:
    
    Whether or not the file was actually transferred.
    
    Throws:
    
    IOException

Class HTTPRemoteFile

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

HTTPRemoteFile

Method Detail

setDefaultUserAgentString

getDefaultUserAgentString

setUserAgentString

geUserAgentString

getLogger

getURL

getName

getPath

setRequestedPath

getRequestedPath

getSize

getTimestamp

getInputStream

writeToLocalDir

copyLocallyPreservingPath

writeToStream

writeToLocalFile