core.tut.pori.utils

Class HTTPParameterUtil

java.lang.Object

core.tut.pori.utils.HTTPParameterUtil

public final class HTTPParameterUtil
extends java.lang.Object

common HTTP parameter utility methods

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterMap(javax.servlet.http.HttpServletRequest httpServletRequest, boolean decode) separates parameter values based on the defined parameter separator (",")

Methods inherited from class java.lang.Object

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

Method Detail

getParameterMap

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameterMap(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                               boolean decode)
                                                                                        throws java.lang.IllegalArgumentException

separates parameter values based on the defined parameter separator (",")

This is a helper method for parsing parameter values. By default the map returned by HttpServlerRequest (e.g. getParameterMap()) will not handle parameter values separated by ",". Also, it will do automatic URL de-coding causing "," and URL encoded comma "%2C" to appear as the same character, making further value separation impossible. Note that POST body parameters will NOT be separated by "," character because it is impossible to retrieve the raw body parameter list without implementing the entire HTTP request parsing manually through InputStreams.

e.g. the query string .../method?parameter=value1,value2 will generate a map in which "parameter" is associated with String[] = {"value1,value2"}, and not with String[] = {"value1","value2"}.

Similarly, the query string .../method?parameter=value1,value2&parameter=value3 will generate a map in which "parameter" is associated with String[] = {"value1,value2","value3"}, and not with String[] = {"value1","value2","value3"}.

The returned map will contain parameters associated with String[] = {"value1", "value2"} in URL decoded form, preserving the encoded comma (e.g. String[] = {"value1,value2"} if the query string contained ?parameter=value1%2Cvalue2

This method is uses the HttpServletRequest's parameter map as its basis, and thus, the returned list may contain both URL parameters and url-encoded-form parameters from HTTP body.

Parameters:

httpServletRequest -

decode - if false, the strings inside the map will NOT be URL decoded

Returns:

the map of parameter or null if none or req was null, note if the parameter has no values, the associated List will be null (NOT empty list)

Throws:

java.lang.IllegalArgumentException - on bad query string