Package emissary.server.mvc.adapters

Class RequestUtil

java.lang.Object

emissary.server.mvc.adapters.RequestUtil

public class RequestUtil
extends Object

Utilities for dealing with request parameters

Field Summary

Fields

Modifier and Type	Field	Description
static float	FLOAT_PARAM_NOT_FOUND
static int	INT_PARAM_NOT_FOUND

Method Summary

Modifier and Type	Method	Description
static boolean	getBooleanParam(jakarta.servlet.ServletRequest request, String param)	Retrieves boolean as a String ("true") and returns boolean.
static boolean	getBooleanParam(jakarta.servlet.ServletRequest request, String param, String trueString)	Retrieves boolean if the string value of the parameter equals the trueString argument.
static boolean	getBooleanParam(jakarta.servlet.ServletRequest request, String param, String trueString, boolean defaultVal)	Retrieves boolean if the string value of the parameter equals the trueString argument.
static float	getFloatParam(jakarta.servlet.ServletRequest request, String param)	gets a float parameter.
static float	getFloatParam(jakarta.servlet.ServletRequest request, String param, float defValue)	gets a float parameter.
static Integer[]	getIntegers(jakarta.servlet.ServletRequest request, String param)	Retrieves a list of Integers from the request
static Integer[]	getIntegers(jakarta.servlet.ServletRequest request, String param, int defValue)	Retrieves a list of Integers from the request
static int	getIntParam(jakarta.servlet.ServletRequest request, String param)	gets an int parameter.
static int	getIntParam(jakarta.servlet.ServletRequest request, String param, int defValue)	gets an int parameter.
static String	getParameter(jakarta.servlet.ServletRequest request, String param)	Get attribute or parameter from request.
static String	getParameter(jakarta.servlet.ServletRequest request, String param, String defaultVal)	Get attribute or parameter from request.
static String[]	getParameterValues(jakarta.servlet.ServletRequest request, String param)	Get attribute or parameters from request and return an array of Strings.
static String	getParamNoNull(jakarta.servlet.ServletRequest request, String param)	gets a string parameter
static String	sanitizeParameter(String parameter)	Sanitize request parameter to remove CR/LF values
static String[]	sanitizeParameters(String[] parameters)	Sanitize request parameters to remove CR/LF values
static List<String>	sanitizeParametersStringList(List<String> parameters)	Sanitize request parameters to remove CR/LF values

Methods inherited from class java.lang.Object

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

Field Detail

INT_PARAM_NOT_FOUND

public static final int INT_PARAM_NOT_FOUND

See Also:

Constant Field Values

FLOAT_PARAM_NOT_FOUND

public static final float FLOAT_PARAM_NOT_FOUND

See Also:

Constant Field Values

Method Detail

getParameter

public static String getParameter(jakarta.servlet.ServletRequest request,
                                  String param,
                                  @Nullable
                                  String defaultVal)

Get attribute or parameter from request. Attribute has priority over parameter when both are present. If no parameter is found, return the default value.

getParameter

public static String getParameter(jakarta.servlet.ServletRequest request,
                                  String param)

Get attribute or parameter from request. Attribute has priority over parameter when both are present. If no parameter is found, return null.

getParameterValues

public static String[] getParameterValues(jakarta.servlet.ServletRequest request,
                                          String param)

Get attribute or parameters from request and return an array of Strings. Attribute has priority over parameter when both are present

getIntParam

public static int getIntParam(jakarta.servlet.ServletRequest request,
                              String param)

gets an int parameter.

Returns:

the parameter's int value, or -99 if the parameter is null.

getIntParam

public static int getIntParam(jakarta.servlet.ServletRequest request,
                              String param,
                              int defValue)

gets an int parameter.

Returns:

the parameter's int value, or the default value if the parameter is null.

getBooleanParam

public static boolean getBooleanParam(jakarta.servlet.ServletRequest request,
                                      String param)

Retrieves boolean as a String ("true") and returns boolean.

Returns:

boolean

getBooleanParam

public static boolean getBooleanParam(jakarta.servlet.ServletRequest request,
                                      String param,
                                      String trueString)

Retrieves boolean if the string value of the parameter equals the trueString argument. If the parameter is not present, false will be returned

Returns:

boolean

getBooleanParam

public static boolean getBooleanParam(jakarta.servlet.ServletRequest request,
                                      String param,
                                      String trueString,
                                      boolean defaultVal)

Retrieves boolean if the string value of the parameter equals the trueString argument.

Returns:

boolean

getIntegers

public static Integer[] getIntegers(jakarta.servlet.ServletRequest request,
                                    String param)

Retrieves a list of Integers from the request

Returns:

Integer[]

getIntegers

public static Integer[] getIntegers(jakarta.servlet.ServletRequest request,
                                    String param,
                                    int defValue)

Retrieves a list of Integers from the request

Returns:

Integer[]

getParamNoNull

public static String getParamNoNull(jakarta.servlet.ServletRequest request,
                                    String param)

gets a string parameter

Returns:

the parameter's value, or "" if the parameter is null.

getFloatParam

public static float getFloatParam(jakarta.servlet.ServletRequest request,
                                  String param)

gets a float parameter.

Returns:

the parameter's int value, or -99 if the parameter is null.

getFloatParam

public static float getFloatParam(jakarta.servlet.ServletRequest request,
                                  String param,
                                  float defValue)

gets a float parameter.

Returns:

the parameter's float value, or the default value if the parameter is null.

sanitizeParameter

@Nullable
public static String sanitizeParameter(String parameter)

Sanitize request parameter to remove CR/LF values

Parameters:

parameter - the String to sanitize

Returns:

a new String object with any CR/LF characters removed or null when the provided argument is null

sanitizeParameters

public static String[] sanitizeParameters(String[] parameters)

Sanitize request parameters to remove CR/LF values

Parameters:

parameters - the String[] to sanitize

Returns:

a new String[] object with any CR/LF characters removed

sanitizeParametersStringList

public static List<String> sanitizeParametersStringList(List<String> parameters)

Sanitize request parameters to remove CR/LF values

Parameters:

parameters - the List String to sanitize

Returns:

a new List String object with any CR/LF characters removed