org.apache.cocoon.components.modules.input: public class: RequestModule

org.apache.cocoon.components.modules.input
public class: RequestModule [javadoc | source]

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:
org.apache.avalon.framework.thread.ThreadSafe, org.apache.avalon.framework.activity.Disposable, InputModule, org.apache.avalon.framework.configuration.Configurable

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.

author: < - a href="mailto:kpiroumian@apache.org">Konstantin Piroumian

version: $ - Id: RequestModule.java 433543 2006-08-22 06:22:54Z crossley $

Fields inherited from org.apache.cocoon.components.modules.input.AbstractJXPathModule:
configuration, parameter

Fields inherited from org.apache.cocoon.components.modules.input.AbstractInputModule:
returnNames, settings

Method from org.apache.cocoon.components.modules.input.RequestModule Summary:
getContextObject

Methods from org.apache.cocoon.components.modules.input.AbstractJXPathModule:
configure, getAttribute, getAttributeNames, getAttributeValues, getContextObject

Methods from org.apache.cocoon.components.modules.input.AbstractInputModule:
configure, dispose, getAttribute, getAttributeNames, getAttributeValues

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.cocoon.components.modules.input.RequestModule Detail:
protected Object getContextObject(Configuration modeConf, Map objectModel) { return ObjectModelHelper.getRequest(objectModel); }