| java.lang.Object
 org.springframework.web.bind.RequestUtils
| RequestUtils | | abstract public class RequestUtils (Code) | | 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.
author:
Rod Johnson
author:
Juergen Hoeller
author:
Keith Donald
See Also: ServletRequestUtils |
| Method Summary | |
| public static Boolean | getBooleanParameter(HttpServletRequest request, String name)
Get a Boolean parameter, or null if not present.
Throws an exception if it 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. | | public static boolean | getBooleanParameter(HttpServletRequest request, String name, boolean defaultVal)
Get a boolean parameter, with a fallback value. | | public static boolean[] | getBooleanParameters(HttpServletRequest 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. | | public static Double | getDoubleParameter(HttpServletRequest request, String name)
Get a Double parameter, or null if not present. | | public static double | getDoubleParameter(HttpServletRequest request, String name, double defaultVal)
Get a double parameter, with a fallback value. | | public static double[] | getDoubleParameters(HttpServletRequest request, String name)
Get an array of double parameters, return an empty array if not found. | | public static Float | getFloatParameter(HttpServletRequest request, String name)
Get a Float parameter, or null if not present. | | public static float | getFloatParameter(HttpServletRequest request, String name, float defaultVal)
Get a float parameter, with a fallback value. | | public static float[] | getFloatParameters(HttpServletRequest request, String name)
Get an array of float parameters, return an empty array if not found. | | public static Integer | getIntParameter(HttpServletRequest request, String name)
Get an Integer parameter, or null if not present. | | public static int | getIntParameter(HttpServletRequest request, String name, int defaultVal)
Get an int parameter, with a fallback value. | | public static int[] | getIntParameters(HttpServletRequest request, String name)
Get an array of int parameters, return an empty array if not found. | | public static Long | getLongParameter(HttpServletRequest request, String name)
Get a Long parameter, or null if not present. | | public static long | getLongParameter(HttpServletRequest request, String name, long defaultVal)
Get a long parameter, with a fallback value. | | public static long[] | getLongParameters(HttpServletRequest request, String name)
Get an array of long parameters, return an empty array if not found. | | public static boolean | getRequiredBooleanParameter(HttpServletRequest request, String name)
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. | | public static boolean[] | getRequiredBooleanParameters(HttpServletRequest request, String name)
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. | | public static double | getRequiredDoubleParameter(HttpServletRequest request, String name)
Get a double parameter, throwing an exception if it isn't found or isn't a number. | | public static double[] | getRequiredDoubleParameters(HttpServletRequest request, String name)
Get an array of double parameters, throwing an exception if not found or one is not a number. | | public static float | getRequiredFloatParameter(HttpServletRequest request, String name)
Get a float parameter, throwing an exception if it isn't found or isn't a number. | | public static float[] | getRequiredFloatParameters(HttpServletRequest request, String name)
Get an array of float parameters, throwing an exception if not found or one is not a number. | | public static int | getRequiredIntParameter(HttpServletRequest request, String name)
Get an int parameter, throwing an exception if it isn't found or isn't a number. | | public static int[] | getRequiredIntParameters(HttpServletRequest request, String name)
Get an array of int parameters, throwing an exception if not found or one is not a number.. | | public static long | getRequiredLongParameter(HttpServletRequest request, String name)
Get a long parameter, throwing an exception if it isn't found or isn't a number. | | public static long[] | getRequiredLongParameters(HttpServletRequest request, String name)
Get an array of long parameters, throwing an exception if not found or one is not a number. | | public static String | getRequiredStringParameter(HttpServletRequest request, String name)
Get a String parameter, throwing an exception if it isn't found or is empty. | | public static String[] | getRequiredStringParameters(HttpServletRequest request, String name)
Get an array of String parameters, throwing an exception if not found or one is empty. | | public static String | getStringParameter(HttpServletRequest request, String name)
Get a String parameter, or null if not present. | | public static String | getStringParameter(HttpServletRequest request, String name, String defaultVal)
Get a String parameter, with a fallback value. | | public static String[] | getStringParameters(HttpServletRequest request, String name)
Get an array of String parameters, return an empty array if not found. | | public static void | rejectRequestMethod(HttpServletRequest request, String method)
Throw a ServletException if the given HTTP request method should be rejected. |
| getBooleanParameter | | public static Boolean getBooleanParameter(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get a Boolean parameter, or null if not present.
Throws an exception if it 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
Parameters:
name - the name of the parameter 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(HttpServletRequest request, String name, boolean defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getBooleanParameters | | public static boolean[] getBooleanParameters(HttpServletRequest request, String name)(Code) | | 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
Parameters:
name - the name of the parameter with multiple possible values |
| getDoubleParameter | | public static Double getDoubleParameter(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get a Double parameter, or null if not present.
Throws an exception if it the parameter value isn't a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter 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(HttpServletRequest request, String name, double defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getDoubleParameters | | public static double[] getDoubleParameters(HttpServletRequest request, String name)(Code) | | Get an array of double parameters, return an empty array if not found.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values |
| getFloatParameter | | public static Float getFloatParameter(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get a Float parameter, or null if not present.
Throws an exception if it the parameter value isn't a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter 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(HttpServletRequest request, String name, float defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getFloatParameters | | public static float[] getFloatParameters(HttpServletRequest request, String name)(Code) | | Get an array of float parameters, return an empty array if not found.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values |
| getIntParameter | | public static int getIntParameter(HttpServletRequest request, String name, int defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getIntParameters | | public static int[] getIntParameters(HttpServletRequest request, String name)(Code) | | Get an array of int parameters, return an empty array if not found.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values |
| getLongParameter | | public static Long getLongParameter(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get a Long parameter, or null if not present.
Throws an exception if it the parameter value isn't a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter 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(HttpServletRequest request, String name, long defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getLongParameters | | public static long[] getLongParameters(HttpServletRequest request, String name)(Code) | | Get an array of long parameters, return an empty array if not found.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values |
| getRequiredBooleanParameter | | public static boolean getRequiredBooleanParameter(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | 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
Parameters:
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(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | 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
Parameters:
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(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get an array of double parameters, throwing an exception if not found or one is not a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values
throws:
ServletRequestBindingException - a subclass of ServletException,so it doesn't need to be caught |
| getRequiredFloatParameters | | public static float[] getRequiredFloatParameters(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get an array of float parameters, throwing an exception if not found or one is not a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values
throws:
ServletRequestBindingException - a subclass of ServletException,so it doesn't need to be caught |
| getRequiredIntParameters | | public static int[] getRequiredIntParameters(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get an array of int parameters, throwing an exception if not found or one is not a number..
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values
throws:
ServletRequestBindingException - a subclass of ServletException,so it doesn't need to be caught |
| getRequiredLongParameters | | public static long[] getRequiredLongParameters(HttpServletRequest request, String name) throws ServletRequestBindingException(Code) | | Get an array of long parameters, throwing an exception if not found or one is not a number.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values
throws:
ServletRequestBindingException - a subclass of ServletException,so it doesn't need to be caught |
| getStringParameter | | public static String getStringParameter(HttpServletRequest request, String name, String defaultVal)(Code) | | 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
Parameters:
name - the name of the parameter
Parameters:
defaultVal - the default value to use as fallback |
| getStringParameters | | public static String[] getStringParameters(HttpServletRequest request, String name)(Code) | | Get an array of String parameters, return an empty array if not found.
Parameters:
request - current HTTP request
Parameters:
name - the name of the parameter with multiple possible values |
| rejectRequestMethod | | public static void rejectRequestMethod(HttpServletRequest request, String method) throws ServletException(Code) | | Throw a ServletException if the given HTTP request method should be rejected.
Parameters:
request - request to check
Parameters:
method - method (such as "GET") which should be rejected
throws:
ServletException - if the given HTTP request is rejected |
|
|