se.entra.phantom.server.http

Class HttpResource

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
static 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.
HttpResource(HttpWebServer webServer, String fileName, String name, String extension, byte[] data, long lastModified) Creates a new file resource with file name, data and last modified, typically used for client Jar files.

Method Summary

Modifier and Type	Method and Description
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.
HttpResource.HttpDataParams	getParamObj(boolean isInclude) Get parameter object to getData method.
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	isUncached() Checks if this resource is of "large" binary (byte array) type that exceeds the block size for sending data to the client.
long	load(HttpResourceParameters httpParams) Loads or reloads a resource if required.
boolean	reload() Reloads a the resource if required.
void	sendRawDataInBlocks(OutputStream out) Sends the raw data in block size.

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)

HttpResource

public HttpResource(HttpWebServer webServer,
                    String fileName,
                    String name,
                    String extension,
                    byte[] data,
                    long lastModified)

Creates a new file resource with file name, data and last modified, typically used for client Jar files.

This constructor is intended to be used internally and should not be used.

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.

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,
                       FileNotFoundException

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.

getFileSize

public final long getFileSize()

Gets the file size, typically used for large binary resources.

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.

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.

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.

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.

Parameters:

httpSession - The session instance.

Returns:

false for non-HTML resources.