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

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

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

RequestAttributeModule accesses request attributes. If the attribute name contains an askerisk "*" this is considered a wildcard and all attributes that would match this wildcard are considered to be part of an array of that name for getAttributeValues. Only one "*" is allowed.

Version:
$Id: RequestAttributeModule.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
RequestAttributeModule()
           
 
Method Summary
 Object getAttribute(String name, Configuration modeConf, Map objectModel)
           
protected  Object getAttribute(String name, Configuration modeConf, Map objectModel, int scope)
           
 Iterator getAttributeNames(Configuration modeConf, Map objectModel)
           
 Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel)
           
protected  Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel, int scope)
           
 
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

RequestAttributeModule

public RequestAttributeModule()
Method Detail

getAttribute

protected Object getAttribute(String name,
                              Configuration modeConf,
                              Map objectModel,
                              int scope)
                       throws ConfigurationException
Throws:
ConfigurationException

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws ConfigurationException
Specified by:
getAttribute in interface org.apache.cocoon.components.modules.input.InputModule
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

protected Object[] getAttributeValues(String name,
                                      Configuration modeConf,
                                      Map objectModel,
                                      int scope)
                               throws ConfigurationException
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


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