tap

Class TAPRequestParser

java.lang.Object

tap.TAPRequestParser

All Implemented Interfaces:

RequestParser

public class TAPRequestParser
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
• other: no parameter is returned

The request body size is limited for the multipart. You can change these limits with the constructor TAPRequestParser(UWSFileManager, boolean, long, long)

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

Since:

2.0

Version:

2.3 (09/2018)

Author:

Grégory Mantelet (ARI;CDS)

Constructor Summary

Constructors

Constructor and Description
TAPRequestParser(UWSFileManager fileManager) Build a RequestParser able to choose the most appropriate RequestParser in function of the request content-type.
TAPRequestParser(UWSFileManager fileManager, boolean uploadEnabled, long maxFileSize, long maxRequestSize) 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

TAPRequestParser

public TAPRequestParser(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

TAPRequestParser

public TAPRequestParser(UWSFileManager fileManager,
                        boolean uploadEnabled,
                        long maxFileSize,
                        long maxRequestSize)

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

uploadEnabled - true to support UPLOADs, false otherwise (i.e. all Multipart requests with files will be rejected).

maxFileSize - Maximum size for a single uploaded file. A negative value means "no limit".

maxRequestSize - Maximum size for a whole Multipart HTTP Request. A negative value means "no limit".

Since:

2.3

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.