thredds.servlet.filter

Class ParameterValidationUtils

java.lang.Object

thredds.servlet.filter.ParameterValidationUtils

public class ParameterValidationUtils
extends Object

Utility class for validating user input to web apps. All methods validate only if target (parameter e.g.) is available. If the target is not available it is considered valid (unless explicitly documented otherwise).

Since:

3.16.47

Author:

edavis

See Also:

StringValidateEncodeUtils

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	validateParameterAsSingleValueAlphanumericString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName)
static boolean	validateParameterAsSingleValueAlphanumericStringConstrained(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName, String[] constrainedSet, boolean ignoreCase)
static boolean	validateParameterAsSingleValueBooleanString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName)
static boolean	validateParameterAsSingleValueDecimalNumber(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName)
static boolean	validateParameterAsSingleValueFilePathString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName) blah, blah, ...
static boolean	validateParameterAsSingleValueIdString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName) blah, blah, ...
static boolean	validateParameterAsSingleValuePathString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName) blah, blah, ...
static boolean	validateParameterAsSingleValueSingleLineString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName)
static boolean	validateParameterAsSingleValueUriString(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameterName) blah, blah, ...

Methods inherited from class java.lang.Object

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

Method Detail

validateParameterAsSingleValueSingleLineString

public static boolean validateParameterAsSingleValueSingleLineString(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response,
                                                     String parameterName)
                                                              throws IOException,
                                                                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

validateParameterAsSingleValuePathString

public static boolean validateParameterAsSingleValuePathString(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response,
                                               String parameterName)
                                                        throws IOException,
                                                               javax.servlet.ServletException

blah, blah, ...

Note: Currently also rejecting parameter values that contain any less than ("<"), greater than (">"), or backslash ("\") characters. [May loosen this restriction later.]

Parameters:

request - the servlet request

response - the servlet response

parameterName - the name of the parameter to check

Returns:

true if the parameter has a single value and is a valid path string

Throws:

IOException - if there is a problem writing the response.

javax.servlet.ServletException - if a problem is encountered.

validateParameterAsSingleValueFilePathString

public static boolean validateParameterAsSingleValueFilePathString(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response,
                                                   String parameterName)
                                                            throws IOException,
                                                                   javax.servlet.ServletException

blah, blah, ...

Note: Currently also rejecting parameter values that contain any less than ("<"), greater than (">"), or backslash ("\") characters. [May loosen this restriction later.]

Parameters:

request - the servlet request

response - the servlet response

parameterName - the name of the parameter to check

Returns:

true if the parameter has a single value and is a valid file path string

Throws:

IOException - if there is a problem writing the response.

javax.servlet.ServletException - if a problem is encountered.

validateParameterAsSingleValueAlphanumericString

public static boolean validateParameterAsSingleValueAlphanumericString(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       String parameterName)
                                                                throws IOException,
                                                                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

validateParameterAsSingleValueAlphanumericStringConstrained

public static boolean validateParameterAsSingleValueAlphanumericStringConstrained(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response,
                                                                  String parameterName,
                                                                  String[] constrainedSet,
                                                                  boolean ignoreCase)
                                                                           throws IOException,
                                                                                  javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

validateParameterAsSingleValueUriString

public static boolean validateParameterAsSingleValueUriString(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response,
                                              String parameterName)
                                                       throws IOException,
                                                              javax.servlet.ServletException

blah, blah, ...

Note: Currently also rejecting parameter values that contain any less than ("<"), greater than (">"), or backslash ("\") characters. [May loosen this restriction later.]

Parameters:

request - the servlet request

response - the servlet response

parameterName - the name of the parameter to check

Returns:

true if the parameter has a single value and is a valid URI string

Throws:

IOException - if there is a problem writing the response.

javax.servlet.ServletException - if a problem is encountered.

validateParameterAsSingleValueIdString

public static boolean validateParameterAsSingleValueIdString(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response,
                                             String parameterName)
                                                      throws IOException,
                                                             javax.servlet.ServletException

blah, blah, ...

Note: Currently also rejecting parameter values that contain any less than ("<"), greater than (">"), or backslash ("\") characters. [May loosen this restriction later.]

Parameters:

request - the servlet request

response - the servlet response

parameterName - the name of the parameter to check

Returns:

true if the parameter has a single value and is a valid ID string

Throws:

IOException - if there is a problem writing the response.

javax.servlet.ServletException - if a problem is encountered.

validateParameterAsSingleValueBooleanString

public static boolean validateParameterAsSingleValueBooleanString(javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response,
                                                  String parameterName)
                                                           throws IOException,
                                                                  javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

validateParameterAsSingleValueDecimalNumber

public static boolean validateParameterAsSingleValueDecimalNumber(javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response,
                                                  String parameterName)
                                                           throws IOException,
                                                                  javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException