org.apache.cocoon.callstack.environment
Class CallFrameHelper

java.lang.Object
  org.apache.cocoon.callstack.environment.CallFrameHelper

public final class CallFrameHelper

extends Object

A set of constants and methods to access the content of the call frame.

The call frame is used to pass information about the Request, Response and Context of the calling environment to components used while the call frame is active.

Version:

$Id: CallFrameHelper.java 503923 2007-02-05 23:36:34Z danielf $

Field Summary

static String	CONTEXT_OBJECT Key for the environment ServletContext in the call frame.
static String	REQUEST_OBJECT Key for the environment HttpServletRequest in the call frame.
static String	RESPONSE_OBJECT Key for the environment HttpServletResponse in the call frame.

Method Summary

static ServletContext	getContext()
static HttpServletRequest	getRequest()
static HttpServletResponse	getResponse()
static void	setContext(ServletContext context)
static void	setEnvironment(HttpServletRequest request, HttpServletResponse response, ServletContext context)
static void	setRequest(HttpServletRequest request)
static void	setResponse(HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_OBJECT

public static final String REQUEST_OBJECT

Key for the environment HttpServletRequest in the call frame.

See Also:

Constant Field Values

RESPONSE_OBJECT

public static final String RESPONSE_OBJECT

Key for the environment HttpServletResponse in the call frame.

See Also:

Constant Field Values

CONTEXT_OBJECT

public static final String CONTEXT_OBJECT

Key for the environment ServletContext in the call frame.

See Also:

Constant Field Values

Method Detail

setEnvironment

public static final void setEnvironment(HttpServletRequest request,
                                        HttpServletResponse response,
                                        ServletContext context)

getRequest

public static final HttpServletRequest getRequest()

setRequest

public static final void setRequest(HttpServletRequest request)

getResponse

public static final HttpServletResponse getResponse()

setResponse

public static final void setResponse(HttpServletResponse response)

getContext

public static final ServletContext getContext()

setContext

public static final void setContext(ServletContext context)