org.apache.cocoon.acting
Class SetCharacterEncodingAction

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.acting.AbstractAction
              |
              +--org.apache.cocoon.acting.ComposerAction
                    |
                    +--org.apache.cocoon.acting.SetCharacterEncodingAction

All Implemented Interfaces:

Action, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.thread.ThreadSafe

public class SetCharacterEncodingAction

extends ComposerAction

implements org.apache.avalon.framework.thread.ThreadSafe, org.apache.avalon.framework.parameters.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.

Author:

MIYABE Tatsuhiko

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

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

java.util.Map	act(Redirector redirector, SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters par) Set character encoding of current request.
void	parameterize(org.apache.avalon.framework.parameters.Parameters parameters)

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

compose

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

getLogger, setLogger, 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(org.apache.avalon.framework.parameters.Parameters parameters)
                  throws org.apache.avalon.framework.parameters.ParameterException

Specified by:

parameterize in interface org.apache.avalon.framework.parameters.Parameterizable

act

public java.util.Map act(Redirector redirector,
                         SourceResolver resolver,
                         java.util.Map objectModel,
                         java.lang.String src,
                         org.apache.avalon.framework.parameters.Parameters par)
                  throws java.lang.Exception

Set character encoding of current request.

Following copied from interface: org.apache.cocoon.acting.Action

Parameters:

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).

source - A source String to the Action

parameters - 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:

java.lang.Exception - Indicates something is totally wrong