org.apache.cocoon.components.modules.input
Class RawRequestParameterModule
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.cocoon.components.modules.input.RawRequestParameterModule
- All Implemented Interfaces:
- Disposable, Component, Configurable, LogEnabled, ThreadSafe, InputModule
public class RawRequestParameterModule
- extends AbstractInputModule
- implements ThreadSafe
RawRequestParameterModule accesses request parameters without
decoding to the specified form-encoding
or casting. It uses the
Request.get(java.lang.String)
method instead of the
Request.getParameter(java.lang.String)
method of the
Request
This is useful for example
in conjunction with uploads.
If get()
returns a Vector, getAttribute()
will return
the first element, otherwise it will return the same as get()
.
getAttributeValues()
will either convert the Vector to an array,
place the result in a new array, or return the array as is.
- Version:
- $Id: RawRequestParameterModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $
- Author:
- Christian Haul
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
ROLE |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RawRequestParameterModule
public RawRequestParameterModule()
getAttribute
public Object getAttribute(String name,
Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Description copied from interface:
InputModule
- Standard access to an attribute's value. If more than one value
exists, the first is returned. If the value does not exist,
null is returned. To get all values, use
InputModule.getAttributeValues(String, Configuration, Map)
or
InputModule.getAttributeNames(Configuration, Map)
and
InputModule.getAttribute(String, Configuration, Map)
to get them one by one.
- Specified by:
getAttribute
in interface InputModule
- Overrides:
getAttribute
in class AbstractInputModule
- Parameters:
name
- a String that specifies what the caller thinks
would identify an attribute. This is mainly a fallback if no
modeConf is present.modeConf
- column's mode configuration from resource
description. This argument is optional.
- Throws:
ConfigurationException
getAttributeNames
public Iterator getAttributeNames(Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Description copied from interface:
InputModule
- Returns an Iterator of String objects containing the names
of the attributes available. If no attributes are available,
the method returns an empty Iterator.
- Specified by:
getAttributeNames
in interface InputModule
- Overrides:
getAttributeNames
in class AbstractInputModule
- Parameters:
modeConf
- column's mode configuration from resource
description. This argument is optional.
- Throws:
ConfigurationException
getAttributeValues
public Object[] getAttributeValues(String name,
Configuration modeConf,
Map objectModel)
throws ConfigurationException
- Description copied from interface:
InputModule
- Returns an array of String objects containing all of the values
the given attribute has, or null if the attribute does not
exist. As an alternative,
InputModule.getAttributeNames(Configuration, Map)
together with
InputModule.getAttribute(String, Configuration, Map)
can be used to get the
values one by one.
- Specified by:
getAttributeValues
in interface InputModule
- Overrides:
getAttributeValues
in class AbstractInputModule
- Parameters:
name
- a String that specifies what the caller thinks
would identify an attributes. This is mainly a fallback
if no modeConf is present.modeConf
- column's mode configuration from resource
description. This argument is optional.
- Throws:
ConfigurationException
Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.