Class RequestModule

  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.components.modules.input.AbstractInputModule
          extended by org.apache.cocoon.components.modules.input.AbstractJXPathModule
              extended by 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.:

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.

$Id: RequestModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $
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
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule
Constructor Summary
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
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


public RequestModule()
Method Detail


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

Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.