Package at.gv.egovernment.moa.id.util

Class InOrderServletRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper

public class InOrderServletRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

Special ServletRequestWrapper class which provides a more precise implementation of the getParameter* family. This implementation cares about the order of the parameters from Query String and HTTP POST Body. Use this as Filter class for Servlets which such needs.

Field Summary

Fields

Modifier and Type	Field	Description
static int	BODY_PARAM	Identifier used to identify HTTP body parameters
static String	DEFAULT_CHARACTER_ENCODING	standard encoding used to decode the URL string.
static int	QUERY_PARAM	Identifier used to identify query parameters

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
InOrderServletRequestWrapper(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext sContext)

Method Summary

Modifier and Type	Method	Description
String	getParameter(String name)	Returns the value of a request parameter as a String, or null if the parameter does not exist.
String	getParameter(String name, int parameterType)	Returns the value of a request parameter as a String, or null if the parameter does not exist.
Enumeration	getParameterNames()	Returns an Enumeration of String objects containing the names of the parameters.
Enumeration	getParameterNames(int parameterType)	Returns an Enumeration of String objects containing the names of the parameters contained in this request.
String	getParameterValues(String name, int parameterType)	Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
protected void	parseParameters(javax.servlet.http.HttpServletRequest req)	parses the Query and if availlable also HTTP POST parameters

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameterMap, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameterMap, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Field Detail

DEFAULT_CHARACTER_ENCODING

public static final String DEFAULT_CHARACTER_ENCODING

standard encoding used to decode the URL string.

See Also:

Constant Field Values

QUERY_PARAM

public static final int QUERY_PARAM

Identifier used to identify query parameters

See Also:

Constant Field Values

BODY_PARAM

public static final int BODY_PARAM

Identifier used to identify HTTP body parameters

See Also:

Constant Field Values

Constructor Detail

InOrderServletRequestWrapper

public InOrderServletRequestWrapper(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.ServletContext sContext)

See Also:

HttpServletRequestWrapper

Method Detail

parseParameters

protected final void parseParameters(javax.servlet.http.HttpServletRequest req)

parses the Query and if availlable also HTTP POST parameters

Parameters:

req - a HttpServletRequest which should be parsed

getParameter

public final String getParameter(String name)

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues(String, int).

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via ServletRequestWrapper.getInputStream() or ServletRequestWrapper.getReader()can interfere with the execution of this method.

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

Parameters:

name - a String containing the name of the parameter whose value is requested

Returns:

a String representing the single value of the parameter

See Also:

getParameterValues(String, int)

getParameter

public final String getParameter(String name,
                                 int parameterType)

Returns the value of a request parameter as a String, or null if the parameter does not exist.

Parameters:

name - a String containing the name of the parameter whose value is requested

parameterType - type of parameter

Returns:

value of the (single) parameter or null if not availlable

See Also:

and @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#BODY_PARAM, ServletRequestWrapper.getParameterValues(String)

getParameterValues

public final String getParameterValues(String name,
                                       int parameterType)

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

Parameters:

name - a String containing the name of the parameter whose value is requested

parameterType - type of parameter

Returns:

an array of String objects containing the parameter's values or null

See Also:

and @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#BODY_PARAM, getParameter(java.lang.String)

getParameterNames

public final Enumeration getParameterNames()

Returns an Enumeration of String objects containing the names of the parameters. If there are no parameters, the method returns an empty Enumeration.

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterNames

public final Enumeration getParameterNames(int parameterType)

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Parameters:

parameterType - type of parameter

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters