org.itsnat.core
Interface ItsNatServletRequest

All Superinterfaces:

ItsNatUserData

All Known Subinterfaces:

ItsNatHttpServletRequest

public interface ItsNatServletRequest
extends ItsNatUserData

Is the ItsNat wrapper of the javax.servlet.ServletRequest object.

Author:

Jose Maria Arranz Santamaria

Method Summary

ItsNatVariableResolver	createItsNatVariableResolver() Creates a variable resolver bound to this request.
ClientDocument	getClientDocument() Returns the client document, this object mirrors the user (client) document/page sending this request.
ItsNatDocument	getItsNatDocument() Returns the ItsNat document associated to this request.
ItsNatDocument	getItsNatDocumentReferrer() Returns the document referrer.
ItsNatServlet	getItsNatServlet() Returns the ItsNat servlet associated to this request.
ItsNatSession	getItsNatSession() Returns the ItsNat session associated to this request.
javax.servlet.ServletRequest	getServletRequest() Returns the wrapped javax.servlet.ServletRequest object.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getServletRequest

javax.servlet.ServletRequest getServletRequest()

Returns the wrapped javax.servlet.ServletRequest object.

Returns:

the wrapped servlet request object. Can not be null.

getItsNatServlet

ItsNatServlet getItsNatServlet()

Returns the ItsNat servlet associated to this request.

Returns:

the ItsNat servlet. Can not be null.

getItsNatSession

ItsNatSession getItsNatSession()

Returns the ItsNat session associated to this request.

Returns:

the ItsNat session. Can not be null.

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the ItsNat document associated to this request.

Returns:

the ItsNat document. If null no document could be loaded/accessed.

getClientDocument

ClientDocument getClientDocument()

Returns the client document, this object mirrors the user (client) document/page sending this request.

Returns:

the client document. Is null getItsNatDocument() is null too.

createItsNatVariableResolver

ItsNatVariableResolver createItsNatVariableResolver()

Creates a variable resolver bound to this request.

Returns:

a variable resolver bound to this request.

getItsNatDocumentReferrer

ItsNatDocument getItsNatDocumentReferrer()

Returns the document referrer. This referrer document was the previous page and the document related to this request is the target using classic navigation.

The referrer feature and events in the source document must be enabled (see ItsNatDocumentTemplate.setReferrerEnabled(boolean) and ItsNatDocumentTemplate.setEventsEnabled(boolean)) otherwise returns null.

Document referrer is not available if the target document was requested using a direct URL (written on the browser URL bar) or, in the Internet Explorer case, the target document is the result of a reload button click.

Only the first request (the loading document phase) has access to the document referrer, subsequent requests (events) return null.

The document referrer is still live but is going to be unloaded.

Returns:

the document referrer. May be null.