org.apache.cocoon.components.modules.output
Class RequestAttributeMap

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.components.modules.output.AbstractOutputModule
          org.apache.cocoon.components.modules.output.RequestAttributeMap

All Implemented Interfaces:

Configurable, Disposable, org.apache.cocoon.components.modules.output.OutputModule, ThreadSafe

public class RequestAttributeMap

extends org.apache.cocoon.components.modules.output.AbstractOutputModule

implements ThreadSafe

Abstraction layer to encapsulate different output destinations. This module outputs to a request attribute java.util.Map object that contains all the attributes that were set. Configuration option <key-prefix> defaults to "org.apache.cocoon.components.modules.output.OutputModule"

Version:

$Id: RequestAttributeMap.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

String	PREFIX
String	TRANS_PREFIX

Fields inherited from class org.apache.cocoon.components.modules.output.AbstractOutputModule

settings

Fields inherited from interface org.apache.cocoon.components.modules.output.OutputModule

ROLE

Constructor Summary

RequestAttributeMap()

Method Summary

void	commit(Configuration modeConf, Map objectModel) Signal that the database transaction completed successfully.
void	rollback(Configuration modeConf, Map objectModel, Exception e) If a database transaction needs to rollback, this is called to inform the further processing logic about this fact.
void	setAttribute(Configuration modeConf, Map objectModel, String name, Object value) communicate an attribute value to further processing logic.

Methods inherited from class org.apache.cocoon.components.modules.output.AbstractOutputModule

attributeExists, configure, dispose, prepareCommit, rollback, transientSetAttribute

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

Field Detail

PREFIX

public final String PREFIX

See Also:

Constant Field Values

TRANS_PREFIX

public final String TRANS_PREFIX

See Also:

Constant Field Values

Constructor Detail

RequestAttributeMap

public RequestAttributeMap()

Method Detail

setAttribute

public void setAttribute(Configuration modeConf,
                         Map objectModel,
                         String name,
                         Object value)

communicate an attribute value to further processing logic.

Specified by:

setAttribute in interface org.apache.cocoon.components.modules.output.OutputModule

Parameters:

modeConf - column's mode configuration from resource description. This argument is optional.

objectModel - The objectModel

name - The attribute's label, consisting of "table.column" or "table.column[index]" in case of multiple attributes of the same spec.

value - The attriute's value.

rollback

public void rollback(Configuration modeConf,
                     Map objectModel,
                     Exception e)

If a database transaction needs to rollback, this is called to inform the further processing logic about this fact. All already set attribute values are invalidated. This is difficult because only the request object can be used to synchronize this and build some kind of transaction object. Beaware that sending your data straight to some beans or other entities could result in data corruption!

Specified by:

rollback in interface org.apache.cocoon.components.modules.output.OutputModule

commit

public void commit(Configuration modeConf,
                   Map objectModel)

Signal that the database transaction completed successfully. See notes on @link{rollback}.

Specified by:

commit in interface org.apache.cocoon.components.modules.output.OutputModule