Introduction

Actions are executed during pipeline setup. Their purpose is to execute some arbitrary complex code. They are the work horses of pipelines. Use them to update databases, check external resources etc. The execution may fail or complete successfully. Only if the execution was successful, the pipeline fragment contained inside is used within the pipeline. Related concepts are matchers and selectors. Since this is important, let me repeat it: Actions are executed during pipeline setup.

Action sets group actions together. If some actions are often used together in pipeline fragments, it's easier to group them and refer to the group. For more info, please see the docs.

Overview

The following section presents the actions available in Cocoon. It was auto-generated from the java source files.

• org.apache.cocoon.acting.DatabaseUpdateAction
• org.apache.cocoon.acting.OraUpdateAction
• org.apache.cocoon.acting.SessionInvalidatorAction
• org.apache.cocoon.acting.SendmailAction
• org.apache.cocoon.acting.ExtendedSectionCutterAction
• org.apache.cocoon.acting.HttpHeaderAction
• org.apache.cocoon.acting.SessionIsValidAction
• org.apache.cocoon.acting.ScriptAction
• org.apache.cocoon.acting.SessionStateAction
• org.apache.cocoon.acting.LocaleAction
• org.apache.cocoon.acting.DatabaseCookieAuthenticatorAction
• org.apache.cocoon.acting.SessionPropagatorAction
• org.apache.cocoon.acting.MultiAction
• org.apache.cocoon.acting.HelloAction
• org.apache.cocoon.acting.SectionCutterAction
• org.apache.cocoon.acting.SessionValidatorAction
• org.apache.cocoon.acting.CookieValidatorAction
• org.apache.cocoon.acting.ServerPagesAction
• org.apache.cocoon.acting.DatabaseAuthenticatorAction
• org.apache.cocoon.acting.FormValidatorAction
• org.apache.cocoon.acting.LangSelect
• org.apache.cocoon.acting.ResourceExistsAction
• org.apache.cocoon.acting.DatabaseAddAction
• org.apache.cocoon.acting.OraAddAction
• org.apache.cocoon.acting.CookieCreatorAction
• org.apache.cocoon.acting.SetCharacterEncodingAction
• org.apache.cocoon.acting.DbXMLAuthenticatorAction
• org.apache.cocoon.acting.RequestParameterExistsAction
• org.apache.cocoon.acting.RequestParamAction
• org.apache.cocoon.acting.DatabaseSelectAction
• org.apache.cocoon.acting.DatabaseDeleteAction
• org.apache.cocoon.webapps.session.acting.SessionAction
• org.apache.cocoon.webapps.authentication.acting.LoginAction
• org.apache.cocoon.webapps.authentication.acting.LoggedInAction
• org.apache.cocoon.webapps.authentication.acting.LogoutAction
• org.apache.cocoon.webapps.authentication.acting.AuthAction
• org.apache.cocoon.webapps.portal.acting.AuthAction
• org.apache.cocoon.precept.acting.PreceptorDemoAction
• org.apache.cocoon.acting.modular.DatabaseSelectAction
• org.apache.cocoon.acting.modular.TestAction
• org.apache.cocoon.acting.modular.DatabaseDeleteAction
• org.apache.cocoon.acting.modular.DatabaseUpdateAction
• org.apache.cocoon.acting.modular.DatabaseAddAction
• org.apache.cocoon.samples.castor.TestBeanAction
• org.apache.cocoon.samples.xmlform.WizardAction

org.apache.cocoon.acting.DatabaseUpdateAction

Update a record in a database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.DatabaseUpdateAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.OraUpdateAction

Update a record in a database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.OraUpdateAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SessionInvalidatorAction

This is the action used to invalidate an HTTP session.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SessionInvalidatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SendmailAction

The SendmailAction class sends email.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SendmailAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.ExtendedSectionCutterAction

An action designed to set any number of variables, based on the current site section.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.ExtendedSectionCutterAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.HttpHeaderAction

This action adds HTTP headers to the response.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.HttpHeaderAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SessionIsValidAction

This action just checks if a session exists and whether the current seesion is still valid.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SessionIsValidAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.ScriptAction

A simple action that executes any script that can be run by the BSF

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.ScriptAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SessionStateAction

Store the session's current state in a session attribute.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SessionStateAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.LocaleAction

LocaleAction is a class which obtains the request's locale information (language, country, variant) and makes it available to the sitemap/pipeline.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.LocaleAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.DatabaseCookieAuthenticatorAction

This action is used to authenticate user by comparing several cookie values (username, password) with the values in database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.DatabaseCookieAuthenticatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SessionPropagatorAction

This is the action used to propagate parameters into session.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SessionPropagatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.MultiAction

This is just a simple example how to use the new action syntax.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.MultiAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.HelloAction

A simple Action that tracks if a Session object has been created or not.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.HelloAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SectionCutterAction

An action designed to set any number of variables, based on the current site section.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SectionCutterAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SessionValidatorAction

This is the action used to validate Session parameters (attributes).

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.SessionValidatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.CookieValidatorAction

This is the action used to validate Cookie parameters (values).

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.CookieValidatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.ServerPagesAction

Allows actions to be written in XSP.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.ServerPagesAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.DatabaseAuthenticatorAction

This action is used to authenticate user by comparing several request fields (username, password) with the values in database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.DatabaseAuthenticatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.FormValidatorAction

This is the action used to validate Request parameters.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.FormValidatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.LangSelect

LangSelect Action returns two character language code to sitemap.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.LangSelect"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.ResourceExistsAction

This action simply checks to see if a given resource exists.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.ResourceExistsAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.DatabaseAddAction

Adds record in a database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.DatabaseAddAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.OraAddAction

Add a record in a database.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.OraAddAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.CookieCreatorAction

The CookieCreatorAction class create or remove cookies.

Overview

Sitemap Definition

Actions sitemap definition:

<map:actions>
  ...
  <map:action name="" 
    src="org.apache.cocoon.acting.CookieCreatorAction"/>
  ...
</map:actions>

Action usage in an action set definition:

<map:action-sets>
 <map:action-set name="action-set-name">
  <map:act type="" action="ActionName"/>
  ...
 </map:action-set>
 ...
</map:action-sets>

Sitemap Usage

Action usage example using a single action

<map:pipeline>
  <map:match pattern="foo"/>
    <map:act type="">
     <map:parameter name="fooparameters" value="bar"/>
     ...
     <map:generate src="barfoo.xml"/>
     ...
    </map:act>
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.acting.SetCharacterEncodingAction

Sets the character encoding of parameters.

Overview