cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From h...@apache.org
Subject cvs commit: cocoon-2.1/src/scratchpad/src/org/apache/cocoon/acting CookieValidatorAction.java
Date Fri, 15 Aug 2003 20:10:27 GMT
haul        2003/08/15 13:10:27

  Modified:    src/scratchpad/src/org/apache/cocoon/acting
                        CookieValidatorAction.java
  Log:
  Refactor validation actions (forgot to commit this one, sorry)
  
  Revision  Changes    Path
  1.2       +28 -221   cocoon-2.1/src/scratchpad/src/org/apache/cocoon/acting/CookieValidatorAction.java
  
  Index: CookieValidatorAction.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/scratchpad/src/org/apache/cocoon/acting/CookieValidatorAction.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- CookieValidatorAction.java	9 Mar 2003 00:10:08 -0000	1.1
  +++ CookieValidatorAction.java	15 Aug 2003 20:10:27 -0000	1.2
  @@ -50,242 +50,49 @@
   */
   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.parameters.Parameters;
   
  -import org.apache.cocoon.Constants;
   import org.apache.cocoon.components.language.markup.xsp.XSPCookieHelper;
  -import org.apache.cocoon.environment.ObjectModelHelper;
  -import org.apache.cocoon.environment.Redirector;
  -import org.apache.cocoon.environment.Request;
  -import org.apache.cocoon.environment.SourceResolver;
  -import org.apache.cocoon.util.Tokenizer;
  +
  +import java.util.Collection;
  +import java.util.HashMap;
  +import java.util.Iterator;
  +import java.util.Map;
   
   /**
    *  This is the action used to validate Cookie parameters (values). The
  - *  parameters are described via the external xml file (its format is defined in
  - *  AbstractValidatorAction). <h3>Variant 1</h3> <pre>
  - * &lt;map:act type="cookie-validator"&gt;
  - *         &lt;parameter name="descriptor" value="context://descriptor.xml"&gt;
  - *         &lt;parameter name="validate" value="username,password"&gt;
  - * &lt;/map:act&gt;
  - * </pre> 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. <h3>Variant 2</h3> <pre>
  - * <pre>
  - * &lt;map:act type="cookie-validator"&gt;
  - *         &lt;parameter name="descriptor" value="context://descriptor.xml"&gt;
  - *         &lt;parameter name="validate-set" value="is-logged-in"&gt;
  - * &lt;/map:act&gt;
  - * </pre> 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.
  + *  parameters are described via the external xml file.
  + *  @see org.apache.cocoon.acting.AbstractValidatorAction 
    *
    * @author <a href="mailto:paolo@arsenio.net">Paolo Scaffardi</a>
  + * @author <a href="mailto:haul@apache.org">Christian Haul</a>
    * @version CVS $Id$
    */
   
   public class CookieValidatorAction extends AbstractValidatorAction {
   
  -    /**
  -     *  Constructor for the CookieValidatorAction object
  -     */
  -    public CookieValidatorAction() { }
  -
  -
  -    /**
  -     *  Description of the Method
  -     *
  -     * @param  redirector     Description of Parameter
  -     * @param  resolver       Description of Parameter
  -     * @param  objectModel    Description of Parameter
  -     * @param  src            Description of Parameter
  -     * @param  parameters     Description of Parameter
  -     * @return                Description of the Returned Value
  -     * @exception  Exception  Description of Exception
  +    /* (non-Javadoc)
  +     * @see org.apache.cocoon.acting.AbstractValidatorAction#createMapOfParameters(java.util.Map,
java.util.Collection)
        */
  -    public Map act(Redirector redirector,
  -            SourceResolver resolver,
  -            Map objectModel,
  -            String src,
  -            Parameters parameters)
  -        throws Exception {
  -
  -        Request req = ObjectModelHelper.getRequest(objectModel);
  -
  -        if (req == null) {
  -            if (getLogger().isDebugEnabled()) {
  -                getLogger().debug("COOKIEVALIDATOR: no request object");
  -            }
  -            return null;
  -        }
  -
  -        // read global parameter settings
  -        boolean reloadable = Constants.DESCRIPTOR_RELOADABLE_DEFAULT;
  -        if (this.settings.containsKey("reloadable")) {
  -            reloadable = Boolean.valueOf((String) this.settings.get("reloadable")).booleanValue();
  +    protected HashMap createMapOfParameters(Map objectModel, Collection set) {
  +        String name;
  +        HashMap params = new HashMap(set.size());
  +        // put required params into hash
  +        for (Iterator i = set.iterator(); i.hasNext();) {
  +            name = ((Configuration) i.next()).getAttribute("name", "").trim();
  +            Object value = XSPCookieHelper.getCookie(objectModel, name, -1).getValue();
  +            params.put(name, value);
           }
  +        return params;
  +    }
   
  -        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")),
  -                    resolver,
  -                    parameters.getParameterAsBoolean("reloadable", reloadable)
  -                    );
  -            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())) {
  -                if (getLogger().isDebugEnabled()) {
  -                    getLogger().debug("COOKIEVALIDATOR: 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())) {
  -                        if (getLogger().isDebugEnabled()) {
  -                            getLogger().debug("COOKIEVALIDATOR: "
  -                                     + "wrong syntax of the 'validate' parameter");
  -                        }
  -                        return null;
  -                    }
  -                    name = name.trim();
  -
  -                    /*
  -                     *  String cookieValue = XSPCookieHelper.getValue(objectModel, name,-1)
;
  -                     *  getLogger().debug("COOKIE(" + name + ")=" + cookieValue + "(" +
  -                     *  XSPCookieHelper.getCookie (objectModel, name, -1).getValue()
  -                     *  +")");
  -                     */
  -                    params.put(name, XSPCookieHelper.getCookie(objectModel, name, -1).getValue());
  -                }
  -                for (int i = 0; i < rparams.length; i++) {
  -                    name = rparams[i].trim();
  -                    result = validateParameter(name, null, desc,
  -                            params, false);
  -                    if (!result.isOK()) {
  -                        if (getLogger().isDebugEnabled()) {
  -                            getLogger().debug("COOKIEVALIDATOR: "
  -                                     + "validation failed for parameter " + name);
  -                        }
  -                        return null;
  -                    }
  -                    actionMap.put(name, result.getObject());
  -                }
  -            }
  -
  -            /*
  -             *  new set-based method
  -             */
  -            if (valsetstr != null && !"".equals(valsetstr.trim())) {
  -                if (getLogger().isDebugEnabled()) {
  -                    getLogger().debug("COOKIEVALIDATOR: 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) {
  -                    if (getLogger().isDebugEnabled()) {
  -                        getLogger().debug("COOKIEVALIDATOR: 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);
  -                if (getLogger().isDebugEnabled()) {
  -                    getLogger().debug("COOKIEVALIDATOR: 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())) {
  -                        if (getLogger().isDebugEnabled()) {
  -                            getLogger().debug("COOKIEVALIDATOR: wrong syntax "
  -                                     + " of 'validate' children nr. " + i);
  -                        }
  -                        return null;
  -                    }
  -                    name = name.trim();
  -                    params.put(name, XSPCookieHelper.getCookie(objectModel, name, -1).getValue());
  -                }
  -                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()) {
  -                        if (getLogger().isDebugEnabled()) {
  -                            getLogger().debug("COOKIEVALIDATOR: "
  -                                     + "validation failed for cookie '" + name + "'");
  -                        }
  -                        return null;
  -                    }
  -                    actionMap.put(name, result.getObject());
  -                }
  -            }
  -            if (getLogger().isDebugEnabled()) {
  -                getLogger().debug("COOKIEVALIDATOR: all cookies validated");
  -            }
  -            return Collections.unmodifiableMap(actionMap);
  -        } catch (Exception e) {
  -            getLogger().error("Exception: ", e);
  -        }
  -        return null;
  +    /* (non-Javadoc)
  +     * @see org.apache.cocoon.acting.AbstractValidatorAction#isStringEncoded()
  +     */
  +    boolean isStringEncoded() {
  +        return true;
       }
  +    
  +
   }
   
  
  
  

Mime
View raw message