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

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.components.modules.input.AbstractInputModule
          extended byorg.apache.cocoon.components.modules.input.AbstractJXPathModule
              extended byorg.apache.cocoon.components.modules.input.RequestModule
All Implemented Interfaces:
Configurable, Disposable, org.apache.cocoon.components.modules.input.InputModule, ThreadSafe

public class RequestModule
extends org.apache.cocoon.components.modules.input.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 1304280 2012-03-23 11:18:01Z ilgrosso $

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)
           
 
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.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
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)


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.