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

java.lang.Object
  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.SessionModule
All Implemented Interfaces:
Disposable, Component, Configurable, LogEnabled, ThreadSafe, InputModule

public class SessionModule
extends AbstractJXPathModule
implements ThreadSafe

SessionModule provides access to Session object properties. To get access to session properties use XPath syntax, e.g. to get the session id use 'id' as the attribute name.
More complex expressions with functions are also supported, e.g.:

 'substring(id, 8)'
 
will return the substring of id property of the session object. NOTE: The module does not create a new session.

Version:
$Id: SessionModule.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
SessionModule()
           
 
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

SessionModule

public SessionModule()
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


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