You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2003/02/19 08:58:55 UTC

cvs commit: jakarta-jetspeed/src/java/org/apache/jetspeed/util/parser ValidationParameterParser.java DefaultJetspeedParameterParser.java

taylor      2003/02/18 23:58:55

  Modified:    src/java/org/apache/jetspeed/util/parser
                        DefaultJetspeedParameterParser.java
  Added:       src/java/org/apache/jetspeed/util/parser
                        ValidationParameterParser.java
  Removed:     src/java/org/apache/jetspeed/util
                        ValidationParameterParser.java
  Log:
  merged parameter parsers
  
  Revision  Changes    Path
  1.2       +11 -0     jakarta-jetspeed/src/java/org/apache/jetspeed/util/parser/DefaultJetspeedParameterParser.java
  
  Index: DefaultJetspeedParameterParser.java
  ===================================================================
  RCS file: /home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/util/parser/DefaultJetspeedParameterParser.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- DefaultJetspeedParameterParser.java	13 Feb 2003 05:56:00 -0000	1.1
  +++ DefaultJetspeedParameterParser.java	19 Feb 2003 07:58:54 -0000	1.2
  @@ -84,8 +84,19 @@
    * In the above example, result is 2.
    *
    * @author <a href="mailto:shinsuke@yahoo.co.jp">Shinsuke SUGAYA</a>
  + * @version $Id$ 
   */
   public class DefaultJetspeedParameterParser extends DefaultParameterParser {
  +
  +    public DefaultJetspeedParameterParser()
  +    {      
  +        super();
  +    }
  +
  +    public DefaultJetspeedParameterParser(String characterEncoding)
  +    {
  +        super (characterEncoding);
  +    }
   
       /**
        * Sets the servlet request to be parser.  This requires a
  
  
  
  1.1                  jakarta-jetspeed/src/java/org/apache/jetspeed/util/parser/ValidationParameterParser.java
  
  Index: ValidationParameterParser.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *     "Apache Jetspeed" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache" or
   *    "Apache Jetspeed", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.jetspeed.util.parser;
  
  import java.io.BufferedReader;
  import java.io.Reader;
  import javax.servlet.http.HttpServletRequest;
  
  import java.beans.PropertyDescriptor;
  import java.beans.IndexedPropertyDescriptor;
  import java.beans.Introspector;
  import java.lang.reflect.Method;
  
  import java.math.BigDecimal;
  import org.apache.torque.om.NumberKey;
  import org.apache.torque.om.StringKey;
  import java.util.Date;
  
  import org.apache.turbine.util.Log;
  import org.apache.turbine.util.parser.DefaultParameterParser;
  import org.apache.turbine.util.ParameterParser;
  import org.apache.turbine.util.TurbineException;
  import org.apache.turbine.util.pool.Recyclable;
  import org.apache.turbine.util.upload.FileItem;
  import org.apache.turbine.services.upload.TurbineUpload;
  
  import org.apache.jetspeed.util.ValidationException;
  import org.apache.jetspeed.util.ValidationHelper;
  
  /**
   * A Turbine parameter parser with Validation built in. 
   * Validates any bean with methods that begin with validate[AttributeName].
   * Works with Torque-generated beans.
   * To use this class, override the TurbineResources.properties:
   * 
   * services.RunDataService.default.parameter.parser=org.apache.turbine.util.parser.DefaultParameterParser
   *
   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
   * @version $Id: ValidationParameterParser.java,v 1.1 2003/02/19 07:58:54 taylor Exp $
   */
  public class ValidationParameterParser
      extends DefaultJetspeedParameterParser
      implements ParameterParser,
                 Recyclable
  {
                      
      public ValidationParameterParser()
      {      
          super();
      }
  
      public ValidationParameterParser(String characterEncoding)
      {
          super (characterEncoding);
      }
  
  
     /**
       * Uses bean introspection to set writable properties of bean from
       * the parameters, where a (case-insensitive) name match between
       * the bean property and the parameter is looked for.
       *
       * @param bean An Object.
       * @exception Exception, a generic exception.
       */
      public void setProperties(Object bean)
          throws Exception
      {
          Class beanClass = bean.getClass();
          PropertyDescriptor[] props
              = Introspector.getBeanInfo(beanClass).getPropertyDescriptors();
          StringBuffer invalidFieldMessages = new StringBuffer("");
          boolean valid = true;
          for (int i = 0; i < props.length; i++)
          {
              String propname = props[i].getName();
              Method setter = props[i].getWriteMethod();
  
              if (setter != null &&
                  (containsKey(propname) ||
                   containsDateSelectorKeys(propname) ||
                   containsTimeSelectorKeys(propname)))
              {
                  /* VALIDATION */
                  if (!validateProperty(bean, props[i]))
                  {
  
                      invalidFieldMessages.append("'");
                      invalidFieldMessages.append(propname);
                      invalidFieldMessages.append("' is not a valid field, ");
                      valid = false;
                  }
                  setMyProperty(bean, props[i]);
                  
              }
          }
          //System.out.println("invalidFieldMessages ["+invalidFieldMessages+"]");    
          if (!valid)
          {
              //int lastComma = invalidFieldMessages.lastIndexOf(", ");
              int lastComma = new String(invalidFieldMessages).lastIndexOf(", ");
              String result = invalidFieldMessages.substring(0,lastComma);
              // System.err.println("Had a validation problem and am throwing: "+invalidFieldMessages);    
              throw new ValidationException(result);
          }
      }
  
     /**
       * Set the property 'prop' in the bean to the value of the
       * corresponding parameters.  Supports all types supported by
       * getXXX methods plus a few more that come for free because
       * primitives have to be wrapped before being passed to invoke
       * anyway.
       *
       * @param bean An Object.
       * @param prop A PropertyDescriptor.
       * @exception Exception, a generic exception.
       */
      protected void setMyProperty(Object bean,
                                   PropertyDescriptor prop)
          throws Exception
      {
          if (prop instanceof IndexedPropertyDescriptor)
          {
              throw new Exception(prop.getName() +
                                  " is an indexed property (not supported)");
          }
  
          Method setter = prop.getWriteMethod();
          if (setter == null)
          {
              throw new Exception(prop.getName() +
                                  " is a read only property");
          }
  
          Object[] args = getArguments(prop);
          setter.invoke(bean, args);
      }
      
  
      protected Object[] getArguments(PropertyDescriptor prop)
          throws Exception
      {
          Class propclass = prop.getPropertyType();
          Object[] args = { null };
      
          if (propclass == String.class)
          {
              args[0] = getString(prop.getName());
          }
          else if (propclass == Integer.class || propclass == Integer.TYPE)
          {
              args[0] = getInteger(prop.getName());
          }
          else if (propclass == Long.class    || propclass == Long.TYPE)
          {
              args[0] = new Long(getLong(prop.getName()));
          }
          else if (propclass == Boolean.class || propclass == Boolean.TYPE)
          {
              args[0] = getBool(prop.getName());
          }
          else if (propclass == Double.class  || propclass == Double.TYPE)
          {
              args[0] = new Double(getDouble(prop.getName()));
          }
          else if (propclass == BigDecimal.class)
          {
              args[0] = getBigDecimal(prop.getName());
          }
          else if (propclass == String[].class)
          {
              args[0] = getStrings(prop.getName());
          }
          else if (propclass == Object.class)
          {
              args[0] = getObject(prop.getName());
          }
          else if (propclass == int[].class)
          {
              args[0] = getInts(prop.getName());
          }
          else if (propclass == Integer[].class)
          {
              args[0] = getIntegers(prop.getName());
          }
          else if (propclass == Date.class)
          {
              args[0] = getDate(prop.getName());
          }
          else if (propclass == NumberKey.class)
          {
              args[0] = getNumberKey(prop.getName());
          }
          else if (propclass == StringKey.class)
          {
              args[0] = getStringKey(prop.getName());
          }
          else
          {            
              //throw new Exception("property " + prop.getName() + " is of unsupported type " + propclass.toString());                                            
          }
          return args;
      }
  
  
      /**
       * Validate a bean's property based on definition in the Torque Object Model
       *
       * @param bean The bean to be validated.
       * @param prop The bean's property descriptor
       * @return true if validation was successful, false if validation failed
       **/    
      protected boolean validateProperty(Object bean,
                                         PropertyDescriptor prop)
          throws Exception
      {
          String propertyName = prop.getName();
          String methodName = "validate" + 
                              Character.toUpperCase(propertyName.charAt(0))  +
                              propertyName.substring(1);
  
          Class[] signatureParams = { prop.getPropertyType() }; //{ java.lang.String.class };
          Object[] methodParams = getArguments(prop);
          try
          {
              Method method = bean.getClass().getMethod(methodName, signatureParams);
              boolean isValidBool = ((Boolean)method.invoke(bean, methodParams)).booleanValue();
              return isValidBool;
          }
          catch (NoSuchMethodException nsm_e)
          {
              try{
                  return validateObject(prop);
              }
              catch (Exception e)
              {
                  // System.err.println("EXCEPTION With the auto validation "+ e);
                  return false;
              }
          }
          catch (Exception e)
          {
              // System.err.println("EXCEPTION INVOKING METHOD " + methodName + " : " + e);
          }
          return true;
      }
  
  
      protected boolean validateObject(PropertyDescriptor prop)
          throws Exception
      {
          Class propclass = prop.getPropertyType();
          Object[] args = { null };
      
          if (propclass == String.class)
          {
              return ValidationHelper.isAlphaNumeric(getString(prop.getName()));
          }
          else if (propclass == Integer.class || propclass == Integer.TYPE)
          {
               return ValidationHelper.isInteger(getString(prop.getName()));
          }
          else if (propclass == Long.class    || propclass == Long.TYPE)
          {
              return ValidationHelper.isDecimal(getString(prop.getName()));
          }
          else if (propclass == Boolean.class || propclass == Boolean.TYPE)
          {
              System.err.println("Auto validate: Boolean -- NOT IMPLEMENTED");
              return true;// WORK NEEDED
          }
          else if (propclass == Double.class  || propclass == Double.TYPE)
          {
              return ValidationHelper.isDecimal(getString(prop.getName()));
          }
          else if (propclass == BigDecimal.class)
          {
              return ValidationHelper.isDecimal(getString(prop.getName()));
          }
          else if (propclass == String[].class)
          {
              return ValidationHelper.isAlphaNumeric(getString(prop.getName()));
          }
          else if (propclass == Object.class)
          {
              System.err.println("Auto validate: Object-- NOT IMPLEMENTED");
              return true;//work needed
          }
          else if (propclass == int[].class)
          {
              return ValidationHelper.isInteger(getString(prop.getName()));
          }
          else if (propclass == Integer[].class)
          {
              return ValidationHelper.isInteger(getString(prop.getName()));
          }
          else if (propclass == Date.class)
          {
              System.err.println("Auto validate: Date -- NOT IMPLEMENTED");
              return true;//work needed
          }
          else if (propclass == NumberKey.class)
          {
              return ValidationHelper.isInteger(getString(prop.getName()));
          }
          else if (propclass == StringKey.class)
          {
              return ValidationHelper.isInteger(getString(prop.getName()));
          }
          else
          {
              /*
              throw new Exception("property "
                                  + prop.getName()
                                  + " is of unsupported type "
                                  + propclass.toString());
                                  */
          }
          return false; 
      }
  
  
  }
  
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org