This project has retired. For details please refer to its Attic page.

org.apache.cocoon.webapps.session.acting
Class SessionFormAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.AbstractConfigurableAction
              org.apache.cocoon.acting.ConfigurableServiceableAction
                  org.apache.cocoon.acting.AbstractComplementaryConfigurableAction
                      org.apache.cocoon.acting.AbstractValidatorAction
                          org.apache.cocoon.acting.FormValidatorAction
                              org.apache.cocoon.webapps.session.acting.SessionFormAction

All Implemented Interfaces:

Component, Configurable, LogEnabled, Serviceable, ThreadSafe, Action

Deprecated. This block is deprecated and will be removed in future versions.

public class SessionFormAction
extends FormValidatorAction

This is the action used to validate Request parameters. The validation rules are either embedded within the form

    <session:form name="info_form">
      <session:action>next_page</session:action>
      <session:content>
        <session:inputxml name="name" type="text" context="trackdemo" path="/user/name"/>
      </session:content>
      <session:validate>
        <root>
          <parameter name="name" type="string" nullable="no"/>
          <constraint-set name="form_a_set">
            <validate name="name"/>
          </constraint-set>
        </root>
      </session:validate>
    </session:form>
 

or described via the external xml file referenced through the "src" attribute (the format is defined in AbstractValidatorAction). Then the constraint-set to be used has to be identified through the "constraint-set" element

    <session:form name="info_form>
      <session:action>next_page</session:action>
      <session:content>
        <session:inputxml name="name" type="text" context="trackdemo" path="/user/name"/>
      </session:content>
      <session:validate src="descriptor.xml">
        <constraint-set name="form_a_set"/>
      </session:validate>
    </session:form>
 

Since the validation rules are contained within the form document they are read and supplied by the SessionTransformer. So this action has to be used in conjunction with the SessionTransformer. The "next_page" pipeline might look like this:

     <map:match pattern="next_page">
       <map:act type="session-form">
           <map:generate src="next_page.xml"/>
           <map:transform type="session"/>
           <map:transform src="simple2html.xsl"/>
           <map:serialize/>
       </map:act>
       <map:generate src="first_page.xml"/>
       <map:transform type="session"/>
       <map:transform src="simple2html.xsl"/>
       <map:serialize/>
     </map:match>
 

where "session-form" is configured as SessionFormAction

Version:

$Id: SessionFormAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Guido Casper, Christian Haul

See Also:

FormValidatorAction, AbstractValidatorAction

Field Summary

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

manager

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

settings

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

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

SessionFormAction()
Deprecated.

Method Summary

protected Configuration

getDescriptor(SourceResolver resolver, Map objectModel, Parameters parameters) Deprecated. Load the descriptor containing the constraints.

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

createMapOfParameters

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

act, getSetOfParameterNamesFromSitemap, indexConfiguration, isDescriptorReloadable, resolveConstraints, setResult, validateParameter, validateParameter, validateSetOfParameters, validateValue

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

getConfiguration, getConfiguration, getConfiguration

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

service

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

configure

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

Constructor Detail

SessionFormAction

public SessionFormAction()

Deprecated.

Method Detail

getDescriptor

protected Configuration getDescriptor(SourceResolver resolver,
                                      Map objectModel,
                                      Parameters parameters)

Deprecated.

Description copied from class: AbstractValidatorAction

Load the descriptor containing the constraints.

Overrides:

getDescriptor in class AbstractValidatorAction

Returns:

a Configuration containing the constraints or null if a problem occurred.