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

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

public class CookieModule
extends org.apache.cocoon.components.modules.input.AbstractInputModule
implements ThreadSafe

Input module for cookies. Retrieves the value of the requested cookie.

Version:
$Id: CookieModule.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
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
CookieModule()
           
 
Method Summary
 Object getAttribute(String name, Configuration modeConf, Map objectModel)
           
 Iterator getAttributeNames(Configuration modeConf, Map objectModel)
           
 Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel)
           
protected  Map getCookieMap(Map objectModel)
           
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
configure, 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

CookieModule

public CookieModule()
Method Detail

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws ConfigurationException
Specified by:
getAttribute in interface org.apache.cocoon.components.modules.input.InputModule
Returns:
the value of the cookie whose name matches the one requested, or null if there is no match.
Throws:
ConfigurationException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws ConfigurationException
Specified by:
getAttributeNames in interface org.apache.cocoon.components.modules.input.InputModule
Throws:
ConfigurationException

getAttributeValues

public Object[] getAttributeValues(String name,
                                   Configuration modeConf,
                                   Map objectModel)
                            throws ConfigurationException
Specified by:
getAttributeValues in interface org.apache.cocoon.components.modules.input.InputModule
Throws:
ConfigurationException

getCookieMap

protected Map getCookieMap(Map objectModel)
Parameters:
objectModel - Object Model for the current request
Returns:
a Map of {see: HttpCookie}s for the current request, keyed on cookie name.


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