HttpResource (NetPhantom(R) 5.5 Java API documentation)

java.lang.Object
- se.entra.phantom.server.http.HttpResource

Direct Known Subclasses:

HtmlResource, HttpClientJarResource, XMLResource
```
public class HttpResource
extends Object
```
Contains information of an individual HTTP resource.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class HttpResource.HttpDataParams
Small parameter object that is sent to getData method, and all methods thereafter.

Nested Classes
Modifier and Type	Class and Description
`class`	`HttpResource.HttpDataParams` Small parameter object that is sent to getData method, and all methods thereafter.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`extension` The extension of the resource.
`String`	`fileName` The file name of the resource (includes the 'htdocs' path).
`boolean`	`isFromRoot` Is resource name is root directory address or relative the document root.
`String`	`name` The name of the resource.
`HttpWebServer`	`webServer` The web server.

Constructor Summary

Constructors
Constructor and Description
`HttpResource(HttpWebServer webServer, String fileName, String name, String extension)` Creates a new file resource without loading it.

Method Summary

Methods
Modifier and Type	Method and Description
`protected File`	`createFile(String fn)` Creates the File object.
`protected InputStream`	`createInputStream()` Creates the input stream.
`protected JarEntry`	`createJarEntry(String fn)` Creates the JarEntry object.
`byte[]`	`getData(HttpSession httpSession, HttpResource.HttpDataParams dParams)` Get the data that is transformed through parsing and modification of the resource if the resource is an HTML document.
`long`	`getFileSize()` Gets the file size, typically used for large binary resources.
`int`	`getHitCount()` Gets the hit count of this resource.
`long`	`getLastModified()` Gets the variable that represents the time when this resource was last modified.
`protected long`	`getLength()` Gets the size of the File or JarEntry, 0 or -1 for error.
`HttpResource.HttpDataParams`	`getParamObj(boolean isInclude)` Get parameter object to getData method.
`byte[]`	`getRawData()` Gets the raw loaded data.
`long`	`getRawSize()` Gets the size of the raw data (e.g.
`boolean`	`hasDynamicData(HttpSession httpSession)` Checks if this resource could return different content for each call to getData when the last modified time has not been changed.
`void`	`increaseHitCount()` Increases the hit count of this resource.
`boolean`	`isHandleSet()` Check if it's handle is set, i.e.
`boolean`	`isModifiedSince(Date dateValue)` Checks if resource has been modified since the given date.
`boolean`	`isUncached()` Checks if this resource is of "large" binary (byte array) type that exceeds the block size for sending data to the client.
`boolean`	`isUnmodifiedSince(Date dateValue)` Checks if resource has not been modified since the given date.
`protected long`	`lastModified()` Gets the last modified time for the File or JarEntry, -1 for error.
`long`	`load(HttpResourceParameters httpParams)` Loads or reloads a resource if required.
`protected byte[]`	`loadFile()` Load the file into memory.
`protected void`	`loadInternal(boolean doPlaceInCache)` Loads or reloads the file.
`protected void`	`loadInternal(HttpResourceParameters httpParam)` Loads or reloads the file.
`boolean`	`reload()` Reloads a the resource if required.
`protected boolean`	`reload2()` Reloads a the resource if required.
`void`	`sendRawDataInBlocks(OutputStream out)` Sends the raw data in block size.
`protected void`	`setRawData(byte[] data)` Sets the raw data.
`protected void`	`setRawData(byte[] data, long lastModified)` Sets the raw data.

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

- Field Detail
  - webServer
```
public final HttpWebServer webServer
```
    The web server.
  - name
```
public final String name
```
    The name of the resource.
  - fileName
```
public final String fileName
```
    The file name of the resource (includes the 'htdocs' path).
  - extension
```
public final String extension
```
    The extension of the resource.
  - isFromRoot
```
public boolean isFromRoot
```
    Is resource name is root directory address or relative the document root.
- Constructor Detail
  - HttpResource
```
public HttpResource(HttpWebServer webServer,
            String fileName,
            String name,
            String extension)
```
    Creates a new file resource without loading it. The loading is done with the load method.
    
    See Also:
    load(se.entra.phantom.server.http.HttpResourceParameters)
- Method Detail
  - increaseHitCount
```
public final void increaseHitCount()
```
    Increases the hit count of this resource.
  - getHitCount
```
public final int getHitCount()
```
    Gets the hit count of this resource.
  - createFile
```
protected File createFile(String fn)
```
    Creates the File object. Is overridden by the JarEntry resource type.
  - createJarEntry
```
protected JarEntry createJarEntry(String fn)
```
    Creates the JarEntry object. Is overridden by the JarEntry resource type.
  - lastModified
```
protected long lastModified()
```
    Gets the last modified time for the File or JarEntry, -1 for error.
  - getLength
```
protected long getLength()
```
    Gets the size of the File or JarEntry, 0 or -1 for error.
  - isHandleSet
```
public boolean isHandleSet()
```
    Check if it's handle is set, i.e. File or JarEntry is set.
  - load
```
public final long load(HttpResourceParameters httpParams)
                throws IOException
```
    Loads or reloads a resource if required.
    If a resource fails to load because it's not found, it will throw an error. The size it returns is zero if the resource is already loaded (previously or by another thread at the same time).
    If the resource is reloaded because it has been changed on the file system since last load, the size returned is the difference between the first load and the new one.
    
    Throws:
    
    IOException - if the loading of the resource fails even when it exists.
    
    FileNotFoundException - if the loading of the resource cannot be found.
  - reload
```
public boolean reload()
```
    Reloads a the resource if required.
    If the document is not loaded, nothing will happen.
    No failures will occur, because (e.g.) if the file is not found anymore the first content will be used.
    This is typically done for application or error documents.
    
    Returns:
    true if the document was reloaded.
  - reload2
```
protected final boolean reload2()
```
    Reloads a the resource if required.
    If the document is not loaded, nothing will happen.
    No failures will occur, because (e.g.) if the file is not found anymore the first content will be used.
    This is typically done for application or error documents.
    
    Returns:
    true if the document was reloaded.
  - loadInternal
```
protected void loadInternal(HttpResourceParameters httpParam)
                     throws IOException
```
    Loads or reloads the file.
    
    Throws:
    
    IOException - if the loading of the resource fails even when it exists.
    
    FileNotFoundException - if the loading of the resource cannot be found.
  - loadInternal
```
protected final void loadInternal(boolean doPlaceInCache)
                           throws IOException
```
    Loads or reloads the file. This second function is required because HtmlResourceUnparsed requires usage of loadInternal.
    
    Throws:
    
    IOException - if the loading of the resource fails even when it exists.
    
    FileNotFoundException - if the loading of the resource cannot be found.
  - loadFile
```
protected byte[] loadFile()
                   throws IOException
```
    Load the file into memory.
    
    Throws:
    
    IOException - if the loading of the resource fails even when it exists.
  - getFileSize
```
public final long getFileSize()
```
    Gets the file size, typically used for large binary resources.
  - getRawSize
```
public final long getRawSize()
```
    Gets the size of the raw data (e.g. for the cache).
    
    Returns:
    0 if not loaded.
  - getRawData
```
public final byte[] getRawData()
```
    Gets the raw loaded data. If this call is done to a resource that is larger than the maximum resource size, the data is loaded into memory at this point (and is kept).
    
    Returns:
    null if not loaded.
  - getData
```
public byte[] getData(HttpSession httpSession,
             HttpResource.HttpDataParams dParams)
```
    Get the data that is transformed through parsing and modification of the resource if the resource is an HTML document. Note that a new set of data is returned each time this call is done.
    For the HttpResource class, the raw data is returned.
    
    Returns:
    null if not loaded.
  - getParamObj
```
public HttpResource.HttpDataParams getParamObj(boolean isInclude)
```
    Get parameter object to getData method. Include flag is set from argument.
  - setRawData
```
protected final void setRawData(byte[] data)
```
    Sets the raw data. This method should only be used from HtmlResource if the HTML document starts with <noparse> and needs to change the raw data.
  - setRawData
```
protected final void setRawData(byte[] data,
              long lastModified)
```
    Sets the raw data. This method should only be used from HtmlResource if the HTML document starts with <noparse> and needs to change the raw data.
  - isUncached
```
public final boolean isUncached()
```
    Checks if this resource is of "large" binary (byte array) type that exceeds the block size for sending data to the client.
    Note: This method cannot be overridden by an extending class.
    
    Returns:
    false if the resource is larger than the maximum size.
  - createInputStream
```
protected InputStream createInputStream()
                                 throws IOException
```
    Creates the input stream.
    
    Throws:
    
    IOException - for errors.
  - sendRawDataInBlocks
```
public final void sendRawDataInBlocks(OutputStream out)
                               throws IOException
```
    Sends the raw data in block size.
    Note: This method cannot be overridden by an extending class.
    
    Throws:
    
    IOException - for errors.
  - getLastModified
```
public final long getLastModified()
```
    Gets the variable that represents the time when this resource was last modified. If this time is ahead of time, the current time is assumed (as per Last-Modified spec in HTTP/1.1).
    
    Returns:
    lastModified The value represents the time when resource was last modified.
  - isModifiedSince
```
public final boolean isModifiedSince(Date dateValue)
```
    Checks if resource has been modified since the given date. Seconds is the smallest tick value, milliseconds are truncated.
    
    Returns:
    boolean indicating if resource has been modified or not. Always returns true if the resource has dynamic data.
  - isUnmodifiedSince
```
public final boolean isUnmodifiedSince(Date dateValue)
```
    Checks if resource has not been modified since the given date. Seconds is the smallest tick value, milliseconds are truncated.
    
    Returns:
    boolean indicating if resource has been modified or not. Always returns false if the resource has dynamic data.
  - hasDynamicData
```
public boolean hasDynamicData(HttpSession httpSession)
```
    Checks if this resource could return different content for each call to getData when the last modified time has not been changed.
    
    Returns:
    false for non-HTML resources.

Class HttpResource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

webServer

name

fileName

extension

isFromRoot

Constructor Detail

HttpResource

Method Detail

increaseHitCount

getHitCount

createFile

createJarEntry

lastModified

getLength

isHandleSet

load

reload

reload2

loadInternal

loadInternal

loadFile

getFileSize

getRawSize

getRawData

getData

getParamObj

setRawData

setRawData

isUncached

createInputStream

sendRawDataInBlocks

getLastModified

isModifiedSince

isUnmodifiedSince

hasDynamicData