Class ServletRequestUtils

java.lang.Object
org.springframework.web.bind.ServletRequestUtils
public abstract class ServletRequestUtils extends Object
Parameter extraction methods, for an approach distinct from data binding, in which parameters of specific types are required.

This approach is very useful for simple submissions, where binding request parameters to a command object would be overkill.

Since:
2.0
Author:
Juergen Hoeller, Keith Donald

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServletRequestUtils()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Boolean
    getBooleanParameter(jakarta.servlet.ServletRequest request, String name)
    Get a Boolean parameter, or null if not present.
    static boolean
    getBooleanParameter(jakarta.servlet.ServletRequest request, String name, boolean defaultVal)
    Get a boolean parameter, with a fallback value.
    static boolean[]
    getBooleanParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of boolean parameters, return an empty array if not found.
    static @Nullable Double
    getDoubleParameter(jakarta.servlet.ServletRequest request, String name)
    Get a Double parameter, or null if not present.
    static double
    getDoubleParameter(jakarta.servlet.ServletRequest request, String name, double defaultVal)
    Get a double parameter, with a fallback value.
    static double[]
    getDoubleParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of double parameters, return an empty array if not found.
    static @Nullable Float
    getFloatParameter(jakarta.servlet.ServletRequest request, String name)
    Get a Float parameter, or null if not present.
    static float
    getFloatParameter(jakarta.servlet.ServletRequest request, String name, float defaultVal)
    Get a float parameter, with a fallback value.
    static float[]
    getFloatParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of float parameters, return an empty array if not found.
    static @Nullable Integer
    getIntParameter(jakarta.servlet.ServletRequest request, String name)
    Get an Integer parameter, or null if not present.
    static int
    getIntParameter(jakarta.servlet.ServletRequest request, String name, int defaultVal)
    Get an int parameter, with a fallback value.
    static int[]
    getIntParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of int parameters, return an empty array if not found.
    static @Nullable Long
    getLongParameter(jakarta.servlet.ServletRequest request, String name)
    Get a Long parameter, or null if not present.
    static long
    getLongParameter(jakarta.servlet.ServletRequest request, String name, long defaultVal)
    Get a long parameter, with a fallback value.
    static long[]
    getLongParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of long parameters, return an empty array if not found.
    static boolean
    getRequiredBooleanParameter(jakarta.servlet.ServletRequest request, String name)
    Get a boolean parameter, throwing an exception if it isn't found or isn't a boolean.
    static boolean[]
    getRequiredBooleanParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of boolean parameters, throwing an exception if not found or one isn't a boolean.
    static double
    getRequiredDoubleParameter(jakarta.servlet.ServletRequest request, String name)
    Get a double parameter, throwing an exception if it isn't found or isn't a number.
    static double[]
    getRequiredDoubleParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of double parameters, throwing an exception if not found or one is not a number.
    static float
    getRequiredFloatParameter(jakarta.servlet.ServletRequest request, String name)
    Get a float parameter, throwing an exception if it isn't found or isn't a number.
    static float[]
    getRequiredFloatParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of float parameters, throwing an exception if not found or one is not a number.
    static int
    getRequiredIntParameter(jakarta.servlet.ServletRequest request, String name)
    Get an int parameter, throwing an exception if it isn't found or isn't a number.
    static int[]
    getRequiredIntParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of int parameters, throwing an exception if not found or one is not a number.
    static long
    getRequiredLongParameter(jakarta.servlet.ServletRequest request, String name)
    Get a long parameter, throwing an exception if it isn't found or isn't a number.
    static long[]
    getRequiredLongParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of long parameters, throwing an exception if not found or one is not a number.
    static String
    getRequiredStringParameter(jakarta.servlet.ServletRequest request, String name)
    Get a String parameter, throwing an exception if it isn't found.
    static String[]
    getRequiredStringParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of String parameters, throwing an exception if not found.
    static @Nullable String
    getStringParameter(jakarta.servlet.ServletRequest request, String name)
    Get a String parameter, or null if not present.
    static String
    getStringParameter(jakarta.servlet.ServletRequest request, String name, String defaultVal)
    Get a String parameter, with a fallback value.
    static String[]
    getStringParameters(jakarta.servlet.ServletRequest request, String name)
    Get an array of String parameters, return an empty array if not found.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ServletRequestUtils

      public ServletRequestUtils()

  • Method Details

    • getIntParameter

      public static @Nullable Integer getIntParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an Integer parameter, or null if not present. Throws an exception if the parameter value isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the Integer value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getIntParameter

      public static int getIntParameter(jakarta.servlet.ServletRequest request, String name, int defaultVal)
      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.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getIntParameters

      public static int[] getIntParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of int parameters, return an empty array if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredIntParameter

      public static int getRequiredIntParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an int parameter, throwing an exception if it isn't found or isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredIntParameters

      public static int[] getRequiredIntParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of int parameters, throwing an exception if not found or one is not a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getLongParameter

      public static @Nullable Long getLongParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a Long parameter, or null if not present. Throws an exception if the parameter value isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the Long value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getLongParameter

      public static long getLongParameter(jakarta.servlet.ServletRequest request, String name, long defaultVal)
      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.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getLongParameters

      public static long[] getLongParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of long parameters, return an empty array if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredLongParameter

      public static long getRequiredLongParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a long parameter, throwing an exception if it isn't found or isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredLongParameters

      public static long[] getRequiredLongParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of long parameters, throwing an exception if not found or one is not a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getFloatParameter

      public static @Nullable Float getFloatParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a Float parameter, or null if not present. Throws an exception if the parameter value isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the Float value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getFloatParameter

      public static float getFloatParameter(jakarta.servlet.ServletRequest request, String name, float defaultVal)
      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.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getFloatParameters

      public static float[] getFloatParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of float parameters, return an empty array if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredFloatParameter

      public static float getRequiredFloatParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a float parameter, throwing an exception if it isn't found or isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredFloatParameters

      public static float[] getRequiredFloatParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of float parameters, throwing an exception if not found or one is not a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getDoubleParameter

      public static @Nullable Double getDoubleParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a Double parameter, or null if not present. Throws an exception if the parameter value isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the Double value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getDoubleParameter

      public static double getDoubleParameter(jakarta.servlet.ServletRequest request, String name, double defaultVal)
      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.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getDoubleParameters

      public static double[] getDoubleParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of double parameters, return an empty array if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredDoubleParameter

      public static double getRequiredDoubleParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a double parameter, throwing an exception if it isn't found or isn't a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredDoubleParameters

      public static double[] getRequiredDoubleParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of double parameters, throwing an exception if not found or one is not a number.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getBooleanParameter

      public static @Nullable Boolean getBooleanParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a Boolean parameter, or null if not present. Throws an exception if the parameter value isn't a boolean.

      Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).

      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the Boolean value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getBooleanParameter

      public static boolean getBooleanParameter(jakarta.servlet.ServletRequest request, String name, boolean defaultVal)
      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.

      Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).

      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getBooleanParameters

      public static boolean[] getBooleanParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of boolean parameters, return an empty array if not found.

      Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).

      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredBooleanParameter

      public static boolean getRequiredBooleanParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a boolean parameter, throwing an exception if it isn't found or isn't a boolean.

      Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).

      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredBooleanParameters

      public static boolean[] getRequiredBooleanParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of boolean parameters, throwing an exception if not found or one isn't a boolean.

      Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).

      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getStringParameter

      public static @Nullable String getStringParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a String parameter, or null if not present.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Returns:
      the String value, or null if not present
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getStringParameter

      public static String getStringParameter(jakarta.servlet.ServletRequest request, String name, String defaultVal)
      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.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      defaultVal - the default value to use as fallback

    • getStringParameters

      public static String[] getStringParameters(jakarta.servlet.ServletRequest request, String name)
      Get an array of String parameters, return an empty array if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter with multiple possible values

    • getRequiredStringParameter

      public static String getRequiredStringParameter(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get a String parameter, throwing an exception if it isn't found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught

    • getRequiredStringParameters

      public static String[] getRequiredStringParameters(jakarta.servlet.ServletRequest request, String name) throws ServletRequestBindingException
      Get an array of String parameters, throwing an exception if not found.
      Parameters:
      request - current HTTP request
      name - the name of the parameter
      Throws:
      ServletRequestBindingException - a subclass of ServletException, so it doesn't need to be caught