com.guiseframework.platform.web
Class HTTPServletGuiseRequest

java.lang.Object
  com.guiseframework.platform.web.HTTPServletGuiseRequest

public class HTTPServletGuiseRequest
extends java.lang.Object

Information about the Guise request of an HTTP servlet.

Author:

Garret Wilson

Constructor Summary

HTTPServletGuiseRequest(HttpServletRequest request, GuiseContainer guiseContainer, GuiseApplication guiseApplication)
Creates an HTTP request.

Method Summary

Bookmark	getBookmark()
java.net.URI	getDepictURI()
HttpServletRequest	getHTTPServletRequest()
com.globalmentor.net.URIPath	getNavigationPath()
java.net.URI	getReferrerURI()
com.globalmentor.net.ContentType	getRequestContentType()
boolean	isAJAX()
boolean	isRequestPathReserved()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPServletGuiseRequest

public HTTPServletGuiseRequest(HttpServletRequest request,
                               GuiseContainer guiseContainer,
                               GuiseApplication guiseApplication)
                        throws java.io.IOException

Creates an HTTP request.

Parameters:

request - The HTTP request.

response - The HTTP response.

guiseContainer - The Guise container.

guiseApplication - The Guise application.

guiseSession - The Guise session.

Throws:

java.io.IOException - if there is an error reading or writing data.

Method Detail

getHTTPServletRequest

public HttpServletRequest getHTTPServletRequest()

Returns:

The HTTP servlet request.

getDepictURI

public java.net.URI getDepictURI()

Returns:

The requested plain depict URI.

getNavigationPath

public com.globalmentor.net.URIPath getNavigationPath()

Returns:

The requested path in its logical form (which may be different than that which appears in the request URI).

isRequestPathReserved

public boolean isRequestPathReserved()

Returns:

Whether the request is for a Guise reserved path.

getRequestContentType

public com.globalmentor.net.ContentType getRequestContentType()

Returns:

The content type of the request, or null if not known.

isAJAX

public boolean isAJAX()

Returns:

Whether this is an AJAX request.

getBookmark

public Bookmark getBookmark()

Returns:

The bookmark represented by the request, or null if no bookmark is contained in the request.

getReferrerURI

public java.net.URI getReferrerURI()

Returns:

The plain URI of the referring location, or null if there is no referrer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the request.