org.apache.cocoon.environment
Class ObjectModelHelper

java.lang.Object
  org.apache.cocoon.environment.ObjectModelHelper

public final class ObjectModelHelper
extends Object

A set of constants and methods to access the content of the object model.

The object model is a Map used to pass information about the calling environment to the sitemap and its components (matchers, actions, transformers, etc).

This class provides accessors only for the objects in the object model that are common to every environment and which can thus be used safely. Some environments provide additional objects, but they are not described here and accessing them should be done in due cause since this ties the application to that particular environment.

Version:

CVS $Id: ObjectModelHelper.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Sylvain Wallez

Field Summary

static String	CONTEXT_OBJECT Key for the environment Context in the object model.
static String	EXPIRES_OBJECT Key for the expiration value (Long) in the object model.
static String	PARENT_CONTEXT Key for a Map containing information from a parent request provided to a sub-request (internal processing)
static String	REQUEST_OBJECT Key for the environment Request in the object model.
static String	RESPONSE_OBJECT Key for the environment Response in the object model.
static String	THROWABLE_OBJECT Key for the throwable object, only available within a <map:handle-errors>.

Method Summary

static Context	getContext(Map objectModel)
static Cookie	getCookie(Map objectModel, String cookieName, int cookieIndex) Deprecated. Don't use this method which should never have been there
static Long	getExpires(Map objectModel)
static Request	getRequest(Map objectModel)
static Response	getResponse(Map objectModel)
static Throwable	getThrowable(Map objectModel)

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 Request in the object model.

See Also:

Constant Field Values

RESPONSE_OBJECT

public static final String RESPONSE_OBJECT

Key for the environment Response in the object model.

See Also:

Constant Field Values

CONTEXT_OBJECT

public static final String CONTEXT_OBJECT

Key for the environment Context in the object model.

See Also:

Constant Field Values

EXPIRES_OBJECT

public static final String EXPIRES_OBJECT

Key for the expiration value (Long) in the object model.

See Also:

Constant Field Values

THROWABLE_OBJECT

public static final String THROWABLE_OBJECT

Key for the throwable object, only available within a <map:handle-errors>.

See Also:

Constant Field Values

PARENT_CONTEXT

public static final String PARENT_CONTEXT

Key for a Map containing information from a parent request provided to a sub-request (internal processing)

See Also:

Constant Field Values

Method Detail

getRequest

public static final Request getRequest(Map objectModel)

getResponse

public static final Response getResponse(Map objectModel)

getContext

public static final Context getContext(Map objectModel)

getExpires

public static final Long getExpires(Map objectModel)

getThrowable

public static final Throwable getThrowable(Map objectModel)

getCookie

public static Cookie getCookie(Map objectModel,
                               String cookieName,
                               int cookieIndex)

Deprecated. Don't use this method which should never have been there

Since:

2.1.7