Class SessionAttributeOutputModule

  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.components.modules.output.AbstractOutputModule
          extended by org.apache.cocoon.components.modules.output.SessionAttributeOutputModule
All Implemented Interfaces:
Disposable, Component, Configurable, LogEnabled, OutputModule

public class SessionAttributeOutputModule
extends AbstractOutputModule

Abstraction layer to encapsulate different output destinations. Configuration option <key-prefix> defaults to "org.apache.cocoon.components.modules.output.OutputModule"+":" Can be used with different isolation-level: default is "0" being no isolation at all, values are immediately visible but are removed on a rollback; "1" keeps the values at a save place until either rollback or commit is called. Then values are either discarded or copied to the final destination.

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

Field Summary
 String PREFIX
Fields inherited from class org.apache.cocoon.components.modules.output.AbstractOutputModule
Fields inherited from interface org.apache.cocoon.components.modules.output.OutputModule
Constructor Summary
Method Summary
 void commit(Configuration modeConf, Map objectModel)
          Signal that the database transaction completed successfully.
protected  String getName(String name)
 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.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

Field Detail


public final String PREFIX
See Also:
Constant Field Values


public final String TRANS_PREFIX
See Also:
Constant Field Values


public final String ROLLBACK_LIST
See Also:
Constant Field Values
Constructor Detail


public SessionAttributeOutputModule()
Method Detail


public void setAttribute(Configuration modeConf,
                         Map objectModel,
                         String name,
                         Object value)
communicate an attribute value to further processing logic.

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.


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!


public void commit(Configuration modeConf,
                   Map objectModel)
Signal that the database transaction completed successfully. See notes on @link{rollback}.


protected String getName(String name)

Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.