Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » acting » [javadoc | source]
org.apache.cocoon.acting
public class: ServerPagesAction [javadoc | source]
java.lang.Object
   org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
         org.apache.cocoon.acting.AbstractConfigurableAction
            org.apache.cocoon.acting.ConfigurableComposerAction
               org.apache.cocoon.acting.ServerPagesAction

All Implemented Interfaces:
    org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.thread.ThreadSafe, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, Action

Allows actions to be written in XSP. This allows to use XSP to produce XML fragments that are later reused in generators.
This action works in concert with the "action" logicheet, that offers actions-related services such as redirect or result map access, and the "capture" logicsheet that allows to capture parts of XSP-generated XML either as an XMLizable containing serialized SAX events, or as a DOM Node.
As for generators, the XSP file name is set using the "src" attribute.
This action accepts a single parameter, "output-attribute", which names the request attribute where the XSP-generated document will be stored (as an XMLizable). If this parameter is omitted, the XSP result is discarded (often the case when inner fragments are captured with the "capture" logicsheet").
When "output-attribute" is set, the action status defaults to "success", meaning child sitemap statements are executed. This allows to use an existing XSP without modification with this action.
When "output-attribute" isn't set, the action status defaults to "failure". The XSP must then use the "action" logicsheet to set its status.
Example :
<action type="serverpages" src="myAction.xsp">
<map:param name="output-attribute" value="xsp-action-result"/>
...
</action>
Field Summary
public static final  String REDIRECTOR_OBJECT     
public static final  String ACTION_RESULT_OBJECT     
public static final  String ACTION_SUCCESS_OBJECT     
 ComponentHandler generatorHandler     
Fields inherited from org.apache.cocoon.acting.ConfigurableComposerAction:
manager
Fields inherited from org.apache.cocoon.acting.AbstractConfigurableAction:
settings
Fields inherited from org.apache.cocoon.acting.AbstractAction:
EMPTY_MAP
Method from org.apache.cocoon.acting.ServerPagesAction Summary:
act,   configure,   dispose
Methods from org.apache.cocoon.acting.ConfigurableComposerAction:
compose
Methods from org.apache.cocoon.acting.AbstractConfigurableAction:
configure
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.acting.ServerPagesAction Detail:
 public Map act(Redirector redirector,
    SourceResolver resolver,
    Map objectModel,
    String source,
    Parameters parameters) throws Exception 
 public  void configure(Configuration conf) throws ConfigurationException 
 public  void dispose()