uws.service.request

Class FormEncodedParser

java.lang.Object

uws.service.request.FormEncodedParser

All Implemented Interfaces:

RequestParser

public class FormEncodedParser
extends java.lang.Object
implements RequestParser

Extract parameters encoded using the HTTP-GET method or the Content-type application/x-www-form-urlencoded with the HTTP-POST or HTTP-PUT method in an HttpServletRequest.

By default, this RequestParser overwrite parameter occurrences in the map: that's to say if a parameter is provided several times, only the last value will be kept. This behavior can be changed by overwriting the function consumeParameter(String, Object, Map) of this class.

Note: When HTTP-POST is used, these parameters are actually already extracted by the server application (like Apache/Tomcat) and are available with ServletRequest.getParameterMap(). However, when using HTTP-PUT, the parameters are extracted manually from the request content.

Since:

4.1

Version:

4.3 (08/2018)

Author:

Grégory Mantelet (ARI;CDS)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPECTED_CONTENT_TYPE HTTP content-type for HTTP request formated in url-form-encoded.

Constructor Summary

Constructors

Constructor and Description
FormEncodedParser()

Method Summary

Modifier and Type	Method and Description
protected void	consumeParameter(java.lang.String name, java.lang.Object value, java.util.Map<java.lang.String,java.lang.Object> allParams) Consume the specified parameter: add it inside the given map.
static boolean	isFormEncodedRequest(javax.servlet.http.HttpServletRequest request) Utility method that determines whether the content of the given request is a application/x-www-form-urlencoded.
java.util.Map<java.lang.String,java.lang.Object>	parse(javax.servlet.http.HttpServletRequest request) Extract parameters from the given HTTP request.

Methods inherited from class java.lang.Object

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

Field Detail

EXPECTED_CONTENT_TYPE

public static final java.lang.String EXPECTED_CONTENT_TYPE

HTTP content-type for HTTP request formated in url-form-encoded.

See Also:

Constant Field Values

Constructor Detail

FormEncodedParser

public FormEncodedParser()

Method Detail

parse

public final java.util.Map<java.lang.String,java.lang.Object> parse(javax.servlet.http.HttpServletRequest request)
                                                             throws UWSException

Description copied from interface: RequestParser

Extract parameters from the given HTTP request.

These parameters can be fetched from ServletRequest.getParameterMap() or directly from the full request content. In this last case, a parsing is necessary ; hence this function.

In case a parameter is provided several times with the same time and the same case, the request parser can choose to keep only the last occurrence or all occurrences. If all occurrences are kept, this function MUST return an array of Objects (in which types may be mixed), otherwise a map value MUST be an elementary object.

Note: A parameter item can be a simple value (e.g. String, integer, ...) or a more complex object (e.g. File, InputStream, ...).

IMPORTANT: This function MUST NOT be used to check the parameters' value. It only aims to parse the given request in order to extract its embedded parameters.
Consequently, if this function throws an exception, it could be only because the request can not be read, and not because a parameter format or value is incorrect.
Parameter checks should be done in UWSParameters and more particularly by an InputParamController.

Specified by:

parse in interface RequestParser

Parameters:

request - An HTTP request.

Returns:

A map listing all extracted parameters. Values are either an elementary object (whatever is the type), or an array of Objects (in which types can be mixed).

Throws:

UWSException - If any error provides this function to read the parameters.

consumeParameter

protected void consumeParameter(java.lang.String name,
                                java.lang.Object value,
                                java.util.Map<java.lang.String,java.lang.Object> allParams)

Consume the specified parameter: add it inside the given map.

By default, this function is just putting the given value inside the map. So, if the parameter already exists in the map, its old value will be overwritten by the given one.

Parameters:

name - Name of the parameter to consume.

value - Its value.

allParams - The list of all parameters read until now.

isFormEncodedRequest

public static final boolean isFormEncodedRequest(javax.servlet.http.HttpServletRequest request)

Utility method that determines whether the content of the given request is a application/x-www-form-urlencoded.

Important: This function just test the content-type of the request. The HTTP method (e.g. GET, POST, ...) is not tested.

Parameters:

request - The servlet request to be evaluated. Must be non-null.

Returns:

true if the request is url-form-encoded, false otherwise.