org.randombits.support.confluence

Class RequestInfo

java.lang.Object

org.randombits.support.confluence.RequestInfo

Direct Known Subclasses:

PageInfo

public class RequestInfo
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RequestInfo(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant) Constructs a new RequestInfo with no specified HTTP servlet request instance.
RequestInfo(javax.servlet.http.HttpServletRequest req) Constructs a new RequestInfo with a specific HTTP servlet request instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Call this method to indicate the class can free up its resources.
protected void	finalize()
protected org.randombits.support.core.env.EnvironmentAssistant	getEnvironmentAssistant()
javax.servlet.http.HttpServletRequest	getRequest() The HTTP page request object.
org.randombits.storage.Storage	getRequestAttributes() Retrieves a Storage instance providing access to the request attributes.
org.randombits.storage.Storage	getRequestParams() Retrieves a read-only Storage instance providing access to the request parameters.
javax.servlet.http.HttpSession	getSession()
org.randombits.storage.Storage	getSessionAttributes() Returns a storage instance for the current session.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestInfo

public RequestInfo(javax.servlet.http.HttpServletRequest req)

Constructs a new RequestInfo with a specific HTTP servlet request instance.

Parameters:

req - The HTTP servlet request.

RequestInfo

public RequestInfo(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant)

Constructs a new RequestInfo with no specified HTTP servlet request instance. The instance will be discovered when required via ServletAssistant.getRequest().

Parameters:

environmentAssistant - The servlet assistant.

Method Detail

getEnvironmentAssistant

protected org.randombits.support.core.env.EnvironmentAssistant getEnvironmentAssistant()

getRequestParams

public org.randombits.storage.Storage getRequestParams()

Retrieves a read-only Storage instance providing access to the request parameters. This may be null if the HTTP request is not available in the current context.

Returns:

The request parameter storage instance, or null.

getRequestAttributes

public org.randombits.storage.Storage getRequestAttributes()

Retrieves a Storage instance providing access to the request attributes. This may be null if the HTTP request is not available in the current context.

Returns:

The request attribute storage instance, or null.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

The HTTP page request object.

Returns:

The request object.

getSession

public javax.servlet.http.HttpSession getSession()

getSessionAttributes

public org.randombits.storage.Storage getSessionAttributes()

Returns a storage instance for the current session. This storage is reset for each macro - any boxes opened or closed will not be carried over to the next macro.

Returns:

The session storage object.

close

public void close()

Call this method to indicate the class can free up its resources. Any call to methods on this instance after calling close may throw unexpected errors.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable