Open Source Repository

Home /spring/spring-web-portlet-3.0.5 | Repository Home


org/springframework/web/portlet/bind/PortletRequestUtils.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.portlet.bind;

import javax.portlet.PortletRequest;

/**
 * Parameter extraction methods, for an approach distinct from data binding,
 * in which parameters of specific types are required.
 *
 <p>This approach is very useful for simple submissions, where binding
 * request parameters to a command object would be overkill.
 *
 @author Juergen Hoeller
 @author Keith Donald
 @author John A. Lewis
 @since 2.0
 */
public abstract class PortletRequestUtils {

  private static final IntParser INT_PARSER = new IntParser();

  private static final LongParser LONG_PARSER = new LongParser();

  private static final FloatParser FLOAT_PARSER = new FloatParser();

  private static final DoubleParser DOUBLE_PARSER = new DoubleParser();

  private static final BooleanParser BOOLEAN_PARSER = new BooleanParser();

  private static final StringParser STRING_PARSER = new StringParser();


  /**
   * Get an Integer parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @return the Integer value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static Integer getIntParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return getRequiredIntParameter(request, name);
  }

  /**
   * Get an int parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value as default to enable checks of whether it was supplied.
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static int getIntParameter(PortletRequest request, String name, int defaultVal) {
    if (request.getParameter(name== null) {
      return defaultVal;
    }
    try {
      return getRequiredIntParameter(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return defaultVal;
    }
  }

  /**
   * Get an array of int parameters, return an empty array if not found.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static int[] getIntParameters(PortletRequest request, String name) {
    try {
      return getRequiredIntParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new int[0];
    }
  }

  /**
   * Get an int parameter, throwing an exception if it isn't found or isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static int getRequiredIntParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return INT_PARSER.parseInt(name, request.getParameter(name));
  }

  /**
   * Get an array of int parameters, throwing an exception if not found or one is not a number..
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static int[] getRequiredIntParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return INT_PARSER.parseInts(name, request.getParameterValues(name));
  }


  /**
   * Get a Long parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @return the Long value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static Long getLongParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return getRequiredLongParameter(request, name);
  }

  /**
   * Get a long parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value as default to enable checks of whether it was supplied.
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static long getLongParameter(PortletRequest request, String name, long defaultVal) {
    if (request.getParameter(name== null) {
      return defaultVal;
    }
    try {
      return getRequiredLongParameter(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return defaultVal;
    }
  }

  /**
   * Get an array of long parameters, return an empty array if not found.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static long[] getLongParameters(PortletRequest request, String name) {
    try {
      return getRequiredLongParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new long[0];
    }
  }

  /**
   * Get a long parameter, throwing an exception if it isn't found or isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static long getRequiredLongParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return LONG_PARSER.parseLong(name, request.getParameter(name));
  }

  /**
   * Get an array of long parameters, throwing an exception if not found or one is not a number.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static long[] getRequiredLongParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return LONG_PARSER.parseLongs(name, request.getParameterValues(name));
  }


  /**
   * Get a Float parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @return the Float value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static Float getFloatParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return getRequiredFloatParameter(request, name);
  }

  /**
   * Get a float parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value as default to enable checks of whether it was supplied.
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static float getFloatParameter(PortletRequest request, String name, float defaultVal) {
    if (request.getParameter(name== null) {
      return defaultVal;
    }
    try {
      return getRequiredFloatParameter(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return defaultVal;
    }
  }

  /**
   * Get an array of float parameters, return an empty array if not found.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static float[] getFloatParameters(PortletRequest request, String name) {
    try {
      return getRequiredFloatParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new float[0];
    }
  }

  /**
   * Get a float parameter, throwing an exception if it isn't found or isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static float getRequiredFloatParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return FLOAT_PARSER.parseFloat(name, request.getParameter(name));
  }

  /**
   * Get an array of float parameters, throwing an exception if not found or one is not a number.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static float[] getRequiredFloatParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return FLOAT_PARSER.parseFloats(name, request.getParameterValues(name));
  }


  /**
   * Get a Double parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @return the Double value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static Double getDoubleParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return getRequiredDoubleParameter(request, name);
  }

  /**
   * Get a double parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value as default to enable checks of whether it was supplied.
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static double getDoubleParameter(PortletRequest request, String name, double defaultVal) {
    if (request.getParameter(name== null) {
      return defaultVal;
    }
    try {
      return getRequiredDoubleParameter(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return defaultVal;
    }
  }

  /**
   * Get an array of double parameters, return an empty array if not found.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static double[] getDoubleParameters(PortletRequest request, String name) {
    try {
      return getRequiredDoubleParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new double[0];
    }
  }

  /**
   * Get a double parameter, throwing an exception if it isn't found or isn't a number.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static double getRequiredDoubleParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return DOUBLE_PARSER.parseDouble(name, request.getParameter(name));
  }

  /**
   * Get an array of double parameters, throwing an exception if not found or one is not a number.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static double[] getRequiredDoubleParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return DOUBLE_PARSER.parseDoubles(name, request.getParameterValues(name));
  }


  /**
   * Get a Boolean parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value isn't a boolean.
   <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
   * treats every other non-empty value as false (i.e. parses leniently).
   @param request current portlet request
   @param name the name of the parameter
   @return the Boolean value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static Boolean getBooleanParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return (getRequiredBooleanParameter(request, name));
  }

  /**
   * Get a boolean parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value as default to enable checks of whether it was supplied.
   <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
   * treats every other non-empty value as false (i.e. parses leniently).
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static boolean getBooleanParameter(PortletRequest request, String name, boolean defaultVal) {
    if (request.getParameter(name== null) {
      return defaultVal;
    }
    try {
      return getRequiredBooleanParameter(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return defaultVal;
    }
  }

  /**
   * Get an array of boolean parameters, return an empty array if not found.
   <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
   * treats every other non-empty value as false (i.e. parses leniently).
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static boolean[] getBooleanParameters(PortletRequest request, String name) {
    try {
      return getRequiredBooleanParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new boolean[0];
    }
  }

  /**
   * Get a boolean parameter, throwing an exception if it isn't found
   * or isn't a boolean.
   <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
   * treats every other non-empty value as false (i.e. parses leniently).
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static boolean getRequiredBooleanParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return BOOLEAN_PARSER.parseBoolean(name, request.getParameter(name));
  }

  /**
   * Get an array of boolean parameters, throwing an exception if not found
   * or one isn't a boolean.
   <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
   * treats every other non-empty value as false (i.e. parses leniently).
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static boolean[] getRequiredBooleanParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return BOOLEAN_PARSER.parseBooleans(name, request.getParameterValues(name));
  }


  /**
   * Get a String parameter, or <code>null</code> if not present.
   * Throws an exception if it the parameter value is empty.
   @param request current portlet request
   @param name the name of the parameter
   @return the String value, or <code>null</code> if not present
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static String getStringParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    if (request.getParameter(name== null) {
      return null;
    }
    return getRequiredStringParameter(request, name);
  }

  /**
   * Get a String parameter, with a fallback value. Never throws an exception.
   * Can pass a distinguished value to default to enable checks of whether it was supplied.
   @param request current portlet request
   @param name the name of the parameter
   @param defaultVal the default value to use as fallback
   */
  public static String getStringParameter(PortletRequest request, String name, String defaultVal) {
    String val = request.getParameter(name);
    return (val != null ? val : defaultVal);
  }

  /**
   * Get an array of String parameters, return an empty array if not found.
   @param request current portlet request
   @param name the name of the parameter with multiple possible values
   */
  public static String[] getStringParameters(PortletRequest request, String name) {
    try {
      return getRequiredStringParameters(request, name);
    }
    catch (PortletRequestBindingException ex) {
      return new String[0];
    }
  }

  /**
   * Get a String parameter, throwing an exception if it isn't found or is empty.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static String getRequiredStringParameter(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return STRING_PARSER.validateRequiredString(name, request.getParameter(name));
  }

  /**
   * Get an array of String parameters, throwing an exception if not found or one is empty.
   @param request current portlet request
   @param name the name of the parameter
   @throws PortletRequestBindingException a subclass of PortletException,
   * so it doesn't need to be caught
   */
  public static String[] getRequiredStringParameters(PortletRequest request, String name)
      throws PortletRequestBindingException {

    return STRING_PARSER.validateRequiredStrings(name, request.getParameterValues(name));
  }


  private abstract static class ParameterParser<T> {

    protected final T parse(String name, String parameterthrows PortletRequestBindingException {
      validateRequiredParameter(name, parameter);
      try {
        return doParse(parameter);
      }
      catch (NumberFormatException ex) {
        throw new PortletRequestBindingException(
            "Required " + getType() " parameter '" + name + "' with value of '" +
            parameter + "' is not a valid number", ex);
      }
    }

    protected final void validateRequiredParameter(String name, Object parameter)
        throws PortletRequestBindingException {

      if (parameter == null) {
        throw new MissingPortletRequestParameterException(name, getType());
      }
    }

    protected abstract String getType();

    protected abstract T doParse(String parameterthrows NumberFormatException;
  }


  private static class IntParser extends ParameterParser<Integer> {

    @Override
    protected String getType() {
      return "int";
    }

    @Override
    protected Integer doParse(String sthrows NumberFormatException {
      return Integer.valueOf(s);
    }

    public int parseInt(String name, String parameterthrows PortletRequestBindingException {
      return parse(name, parameter);
    }

    public int[] parseInts(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      int[] parameters = new int[values.length];
      for (int i = 0; i < values.length; i++) {
        parameters[i= parseInt(name, values[i]);
      }
      return parameters;
    }
  }


  private static class LongParser extends ParameterParser<Long> {

    @Override
    protected String getType() {
      return "long";
    }

    @Override
    protected Long doParse(String parameterthrows NumberFormatException {
      return Long.valueOf(parameter);
    }

    public long parseLong(String name, String parameterthrows PortletRequestBindingException {
      return parse(name, parameter);
    }

    public long[] parseLongs(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      long[] parameters = new long[values.length];
      for (int i = 0; i < values.length; i++) {
        parameters[i= parseLong(name, values[i]);
      }
      return parameters;
    }
  }


  private static class FloatParser extends ParameterParser<Float> {

    @Override
    protected String getType() {
      return "float";
    }

    @Override
    protected Float doParse(String parameterthrows NumberFormatException {
      return Float.valueOf(parameter);
    }

    public float parseFloat(String name, String parameterthrows PortletRequestBindingException {
      return parse(name, parameter);
    }

    public float[] parseFloats(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      float[] parameters = new float[values.length];
      for (int i = 0; i < values.length; i++) {
        parameters[i= parseFloat(name, values[i]);
      }
      return parameters;
    }
  }


  private static class DoubleParser extends ParameterParser<Double> {

    @Override
    protected String getType() {
      return "double";
    }

    @Override
    protected Double doParse(String parameterthrows NumberFormatException {
      return Double.valueOf(parameter);
    }

    public double parseDouble(String name, String parameterthrows PortletRequestBindingException {
      return parse(name, parameter);
    }

    public double[] parseDoubles(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      double[] parameters = new double[values.length];
      for (int i = 0; i < values.length; i++) {
        parameters[i= parseDouble(name, values[i]);
      }
      return parameters;
    }
  }


  private static class BooleanParser extends ParameterParser<Boolean> {

    @Override
    protected String getType() {
      return "boolean";
    }

    @Override
    protected Boolean doParse(String parameterthrows NumberFormatException {
      return (parameter.equalsIgnoreCase("true"|| parameter.equalsIgnoreCase("on"||
          parameter.equalsIgnoreCase("yes"|| parameter.equals("1"));
    }

    public boolean parseBoolean(String name, String parameterthrows PortletRequestBindingException {
      return parse(name, parameter);
    }

    public boolean[] parseBooleans(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      boolean[] parameters = new boolean[values.length];
      for (int i = 0; i < values.length; i++) {
        parameters[i= parseBoolean(name, values[i]);
      }
      return parameters;
    }
  }


  private static class StringParser extends ParameterParser<String> {

    @Override
    protected String getType() {
      return "string";
    }

    @Override
    protected String doParse(String parameterthrows NumberFormatException {
      return parameter;
    }

    public String validateRequiredString(String name, String valuethrows PortletRequestBindingException {
      validateRequiredParameter(name, value);
      return value;
    }

    public String[] validateRequiredStrings(String name, String[] valuesthrows PortletRequestBindingException {
      validateRequiredParameter(name, values);
      for (String value : values) {
        validateRequiredParameter(name, value);
      }
      return values;
    }
  }

}