org.apache.cocoon.acting
Class SessionValidatorAction

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.acting.AbstractAction
              |
              +--org.apache.cocoon.acting.AbstractConfigurableAction
                    |
                    +--org.apache.cocoon.acting.ConfigurableComposerAction
                          |
                          +--org.apache.cocoon.acting.AbstractComplementaryConfigurableAction
                                |
                                +--org.apache.cocoon.acting.AbstractValidatorAction
                                      |
                                      +--org.apache.cocoon.acting.SessionValidatorAction

All Implemented Interfaces:

Action, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.framework.thread.ThreadSafe

public class SessionValidatorAction

extends AbstractValidatorAction

implements org.apache.avalon.framework.thread.ThreadSafe

This is the action used to validate Session parameters (attributes). The parameters are described via the external xml file (its format is defined in AbstractValidatorAction).

Variant 1

 <map:act type="session-validator">
         <parameter name="descriptor" value="context://descriptor.xml">
         <parameter name="validate" value="username,password">
 </map:act>
 

The list of parameters to be validated is specified as a comma separated list of their names. descriptor.xml can therefore be used among many various actions.

Variant 2

 
 <map:act type="session-validator">
         <parameter name="descriptor" value="context://descriptor.xml">
         <parameter name="validate-set" value="is-logged-in">
 </map:act>
 

 The parameter "validate-set" tells to take a given "constraint-set"
 from description
 file and test all parameters against given criteria. This variant is more
 powerful, more aspect oriented and more flexibile than the previous one,
 becuase it allows the comparsion constructs, etc. See
 AbstractValidatorAction documentation.

 This action returns null when validation fails, otherwise it provides
 all validated parameters to the sitemap via {name} expression.


Version: 
CVS $Id: SessionValidatorAction.java,v 1.8.2.1 2002/08/25 09:12:09 haul Exp $
Author: 
Martin Man










Fields inherited from class org.apache.cocoon.acting.ConfigurableComposerAction
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
SessionValidatorAction()



           
 



Method Summary




 java.util.Map
act(Redirector redirector,
    SourceResolver resolver,
    java.util.Map objectModel,
    java.lang.String src,
    org.apache.avalon.framework.parameters.Parameters parameters)



          Main invocation routine.


 
Methods inherited from class org.apache.cocoon.acting.AbstractValidatorAction
validateParameter, validateParameter
 
Methods inherited from class org.apache.cocoon.acting.AbstractComplementaryConfigurableAction
getConfiguration, getConfiguration, getConfiguration
 
Methods inherited from class org.apache.cocoon.acting.ConfigurableComposerAction
compose
 
Methods inherited from class org.apache.cocoon.acting.AbstractConfigurableAction
configure
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable
getLogger, setLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.avalon.framework.configuration.Configurable
configure
 








Constructor Detail



SessionValidatorAction
public SessionValidatorAction()






Method Detail



act
public java.util.Map act(Redirector redirector,
                         SourceResolver resolver,
                         java.util.Map objectModel,
                         java.lang.String src,
                         org.apache.avalon.framework.parameters.Parameters parameters)
                  throws java.lang.Exception

Main invocation routine.



Following copied from interface: org.apache.cocoon.acting.Action

Parameters:
resolver - The SourceResolver in charge
objectModel - The Map with object of the
                    calling environment which can be used
                    to select values this controller may need
                    (ie Request, Response).
source - A source String to the Action
parameters - The Parameters for this invocation
Returns:
Map        The returned Map object with
                    sitemap substitution values which can be used
                    in subsequent elements attributes like src=
                    using a xpath like expression: src="mydir/{myval}/foo"
                    If the return value is null the processing inside
                    the  element of the sitemap will
                    be skipped.
Throws:
java.lang.Exception - Indicates something is totally wrong