org.apache.cocoon.acting
Class SetCharacterEncodingAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.ServiceableAction
              org.apache.cocoon.acting.SetCharacterEncodingAction

All Implemented Interfaces:

Component, LogEnabled, Parameterizable, Serviceable, ThreadSafe, Action

public class SetCharacterEncodingAction
extends ServiceableAction
implements ThreadSafe, Parameterizable

Sets the character encoding of parameters. Components use this encoding as default after the action.

Configuration parameters:

form-encoding (optional)

The supposed encoding of the request parameter.

These configuration options supported in both declaration and use time.

If no encoding specified, the action does nothing.

Version:

CVS $Id: SetCharacterEncodingAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

MIYABE Tatsuhiko

Field Summary

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

SetCharacterEncodingAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters par) Set character encoding of current request.
void	parameterize(Parameters parameters)

Methods inherited from class org.apache.cocoon.acting.ServiceableAction

service

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

SetCharacterEncodingAction

public SetCharacterEncodingAction()

Method Detail

parameterize

public void parameterize(Parameters parameters)
                  throws ParameterException

Specified by:

parameterize in interface Parameterizable

Throws:

ParameterException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String src,
               Parameters par)
        throws Exception

Set character encoding of current request.

Specified by:

act in interface Action

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

src - A source String to the Action

par - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong