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:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, InputModule, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.thread.ThreadSafe

public class RequestModule

extends AbstractJXPathModule

implements org.apache.avalon.framework.thread.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.java,v 1.1.2.1 2002/11/17 19:12:49 haul Exp $

Author:

Konstantin Piroumian

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

library

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 java.lang.Object

getContextObject(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.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, getFunctions, getPackages, setupExtensions

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 java.lang.Object getContextObject(org.apache.avalon.framework.configuration.Configuration modeConf,
                                            java.util.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.

Overrides:

getContextObject in class AbstractJXPathModule