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

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.URLDecodeModule

All Implemented Interfaces:

Disposable, Component, Configurable, LogEnabled, ThreadSafe, InputModule

public final class URLDecodeModule
extends AbstractInputModule
implements ThreadSafe

This module provides functionality for converting a String from the application/x-www-form-urlencoded MIME format. It is useful for example for calling remote services:
<map:generate src="http://remote/page?param1={url-encode:{request-param:param1}}"/>
Module configuration takes only one configuration parameter: "encoding" which is a target string encoding. This is utf-8 by default.

Version:

$Id: URLDecodeModule.html 1304258 2012-03-23 10:09:27Z 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

URLDecodeModule()

Method Summary

Object

getAttribute(String name, Configuration modeConf, Map objectModel) Standard access to an attribute's value.

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

configure, dispose, getAttributeNames, getAttributeValues

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

URLDecodeModule

public URLDecodeModule()

Method Detail

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