uws.service.request

Class UWSRequestParser

java.lang.Object

uws.service.request.UWSRequestParser

All Implemented Interfaces:

RequestParser

public final class UWSRequestParser
extends java.lang.Object
implements RequestParser

This parser adapts the request parser to use in function of the request content-type:

• application/x-www-form-urlencoded: FormEncodedParser
• multipart/form-data: MultipartParser
• (text|application)/(.+-)?xml: XMLRequestParser (the whole request body is an XML document)
• other: no parameter is returned

The request body size is limited for the multipart AND the XML-Request parsers. If you want to change this limit, you MUST do it for each of these parsers, setting the following static attributes: resp. MultipartParser.SIZE_LIMIT and XMLRequestParser.SIZE_LIMIT (and also XMLRequestParser.SMALL_XML_THRESHOLD).

Note: If you want to change the support other request parsing, you will have to write your own RequestParser implementation.

Since:

4.1

Version:

4.2 (06/2017)

Author:

Grégory Mantelet (ARI)

Constructor Summary

Constructors

Constructor and Description
UWSRequestParser(UWSFileManager fileManager) Build a RequestParser able to choose the most appropriate RequestParser in function of the request content-type.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	parse(javax.servlet.http.HttpServletRequest req) 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

Constructor Detail

UWSRequestParser

public UWSRequestParser(UWSFileManager fileManager)

Build a RequestParser able to choose the most appropriate RequestParser in function of the request content-type.

Parameters:

fileManager - The file manager to use in order to store any eventual upload. Must NOT be NULL.

Method Detail

parse

public java.util.Map<java.lang.String,java.lang.Object> parse(javax.servlet.http.HttpServletRequest req)
                                                       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:

req - 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.