// $Id: SessionValidatorAction.java,v 1.6 2001/07/20 13:37:17 cziegeler Exp $
package org.apache.cocoon.acting;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.logger.AbstractLoggable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.acting.ValidatorActionHelper;
import org.apache.cocoon.Constants;
import org.apache.cocoon.environment.Redirector;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.cocoon.util.Tokenizer;
import org.apache.log.Logger;
/**
* 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.
*
* @author Martin Man <Martin.Man@seznam.cz>
* @version CVS $Revision: 1.6 $ $Date: 2001/07/20 13:37:17 $
*/
public class SessionValidatorAction extends AbstractValidatorAction
{
/**
* Main invocation routine.
*/
public Map act (Redirector redirector, SourceResolver resolver, Map objectModel, String src,
Parameters parameters) throws Exception {
Request req = (Request)
objectModel.get (Constants.REQUEST_OBJECT);
if (req == null) {
getLogger ().debug ("SESSIONVALIDATOR: no request object");
return null;
}
/* check session validity */
Session session = req.getSession (false);
if (session == null) {
getLogger ().debug ("SESSIONVALIDATOR: no session object");
return null;
}
// read global parameter settings
boolean reloadable = Constants.DESCRIPTOR_RELOADABLE_DEFAULT;
if (this.settings.containsKey("reloadable"))
reloadable = Boolean.getBoolean((String) this.settings.get("reloadable"));
/* oliver.dauben@dresdner-bank.com 2001-08-08: changed the following to fix a NPE bug */
// CHECK CHANGES !!!
//String valsetstr = (String) this.settings.get("validate-set");
//String valstr = (String) this.settings.get("validate");
try {
Configuration conf = this.getConfiguration (
parameters.getParameter ("descriptor", (String) this.settings.get("descriptor")),
parameters.getParameterAsBoolean("reloadable",reloadable));
// oliver.dauben@dresdner-bank.com 2001-08-08: NEW:
String valsetstr = parameters.getParameter ("validate-set", (String) settings.get("validate-set",""));
String valstr = parameters.getParameter ("validate", (String) settings.get("validate",""));
// oliver.dauben@dresdner-bank.com 2001-08-08: END-NEW.
//valstr = parameters.getParameter ("validate", valstr);
//valsetstr = parameters.getParameter ("validate-set", valsetstr);
Configuration[] desc = conf.getChildren ("parameter");
Configuration[] csets = conf.getChildren ("constraint-set");
HashMap actionMap = new HashMap ();
/*
* old obsoleted method
*/
if (!"".equals (valstr.trim ())) {
getLogger ().debug ("SESSIONVALIDATOR: validating parameters "
+ "as specified via 'validate' parameter");
/* get list of params to be validated */
String[] rparams = Tokenizer.tokenize (valstr, ",", false);
/* perform actuall validation */
ValidatorActionHelper result = null;
String name = null;
HashMap params = new HashMap (rparams.length);
/* put required params into hash */
for (int i = 0; i < rparams.length; i ++) {
name = rparams[i];
if (name == null || "".equals (name.trim ())) {
getLogger ().debug ("SESSIONVALIDATOR: "
+ "wrong syntax of the 'validate' parameter");
return null;
}
name = name.trim ();
params.put (name, session.getAttribute (name));
}
for (int i = 0; i < rparams.length; i ++) {
name = rparams[i].trim ();
result = validateParameter (name, null, desc,
params, false);
if (!result.isOK()) {
getLogger().debug ("SESSIONVALIDATOR: "
+ "validation failed for parameter " + name);
return null;
}
session.setAttribute (name, result.getObject());
actionMap.put (name, result.getObject());
}
}
/*
* new set-based method
*/
if (valsetstr != null && !"".equals (valsetstr.trim ())) {
getLogger ().debug ("SESSIONVALIDATOR: validating parameters "
+ "from given constraint-set " + valsetstr);
Configuration cset = null;
String setname = null;
int j = 0;
boolean found = false;
for (j = 0; j < csets.length; j ++) {
setname = csets[j].getAttribute ("name", "");
if (valsetstr.trim().equals (setname.trim ())) {
found = true;
break;
}
}
if (!found) {
getLogger ().debug ("SESSIONVALIDATOR: given set "
+ valsetstr
+ " does not exist in a description file");
return null;
}
cset = csets[j];
/* get the list of params to be validated */
Configuration[] set = cset.getChildren ("validate");
/* perform actuall validation */
ValidatorActionHelper result = null;
String name = null;
HashMap params = new HashMap (set.length);
getLogger ().debug ("SESSIONVALIDATOR: given set "
+ valsetstr
+ " contains " + set.length + " rules");
/* put required params into hash */
for (int i = 0; i < set.length; i ++) {
name = set[i].getAttribute ("name", "");
if ("".equals (name.trim ())) {
getLogger ().debug ("SESSIONVALIDATOR: wrong syntax "
+ " of 'validate' children nr. " + i);
return null;
}
name = name.trim ();
params.put (name, session.getAttribute (name));
}
for (int i = 0; i < set.length; i ++) {
name = set[i].getAttribute ("name", null);
result = validateParameter (name, set[i],
desc, params, false);
if (!result.isOK()) {
getLogger().debug ("SESSIONVALIDATOR: "
+ "validation failed for parameter " + name);
return null;
}
session.setAttribute (name, result.getObject());
actionMap.put (name, result.getObject());
}
}
getLogger().debug ("SESSIONVALIDATOR: all session "
+ "params validated");
return Collections.unmodifiableMap (actionMap);
} catch (Exception e) {
getLogger().debug ("exception: ", e);
}
return null;
}
}
// $Id: SessionValidatorAction.java,v 1.6 2001/07/20 13:37:17 cziegeler Exp $
// vim: set et ts=4 sw=4: