This project has retired. For details please refer to its Attic page.

org.apache.cocoon.components.modules.input
Class RequestModule

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.AbstractJXPathModule
              org.apache.cocoon.components.modules.input.RequestModule

All Implemented Interfaces:

Disposable, Component, Configurable, LogEnabled, ThreadSafe, InputModule

public class RequestModule
extends AbstractJXPathModule
implements ThreadSafe

RequestModule provides access to Request object properties. To get access to request properties use XPath syntax, e.g. to get the request context path use 'contextPath' as the attribute name.
More complex expressions are also supported, e.g.:

 'userPrincipal/name'
 

will return the name property of the Principal object returned by the request.getUserPrincipal() method. If requested object is not found then an exception will be thrown.

Version:

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

Author:

Konstantin Piroumian

Field Summary

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractJXPathModule

configuration, parameter

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

settings

Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule

ROLE

Constructor Summary

RequestModule()

Method Summary

protected Object

getContextObject(Configuration modeConf, Map objectModel) Returns the object which should be used as JXPath context.

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractJXPathModule

configure, getAttribute, getAttributeNames, getAttributeValues

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

dispose

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestModule

public RequestModule()

Method Detail

getContextObject

protected Object getContextObject(Configuration modeConf,
                                  Map objectModel)

Description copied from class: AbstractJXPathModule

Returns the object which should be used as JXPath context. Descendants should override this method to return a specific object that is requried by the implementing class. Examples are: request, session and application context objects.

Specified by:

getContextObject in class AbstractJXPathModule