se.entra.phantom.server.http

Class XMLResource

java.lang.Object

se.entra.phantom.server.http.HttpResource

se.entra.phantom.server.http.XMLResource

public class XMLResource
extends HttpResource

Contains information of an individual XML resource.

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from class se.entra.phantom.server.http.HttpResource

HttpResource.HttpDataParams

Field Summary

Fields inherited from class se.entra.phantom.server.http.HttpResource

extension, fileName, isFromRoot, name, webServer

Constructor Summary

Constructors

Constructor and Description
XMLResource(HttpWebServer webServer, String fileName, String name, String extension) Creates a new XML resource without loading it.

Method Summary

Modifier and Type	Method and Description
byte[]	getData(HttpSession httpSession, HttpResource.HttpDataParams params) Get the data that is transformed through parsing and modification of the resource if the resource is an XML document.
Document	getDocument() Gets the original XML document.
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.
protected void	loadInternal(HttpResourceParameters httpParams) Loads or reloads the file.
boolean	reload() Reloads a the resource if required.
void	setParse(boolean doParse) Sets no parsing for this document.

Methods inherited from class se.entra.phantom.server.http.HttpResource

getFileSize, getHitCount, getLastModified, getParamObj, increaseHitCount, isHandleSet, isUncached, load, sendRawDataInBlocks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLResource

public XMLResource(HttpWebServer webServer,
                   String fileName,
                   String name,
                   String extension)

Creates a new XML resource without loading it. The loading is done with the load method.

Method Detail

setParse

public void setParse(boolean doParse)

Sets no parsing for this document.

getDocument

public Document getDocument()

Gets the original XML document.

Returns:

null If the document resource is not yet loaded.

loadInternal

protected void loadInternal(HttpResourceParameters httpParams)
                     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.

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.

Overrides:

reload in class HttpResource

Returns:

true if the document was reloaded.

getData

public byte[] getData(HttpSession httpSession,
                      HttpResource.HttpDataParams params)

Get the data that is transformed through parsing and modification of the resource if the resource is an XML document. Note that a new set of data is returned each time this call is done.

Overrides:

getData in class HttpResource

Returns:

null if not loaded.

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.

Overrides:

hasDynamicData in class HttpResource

Parameters:

httpSession - The session instance.

Returns:

true if the XML document contains some variable info, false otherwise.