uws.service.request

Class NoEncodingParser

java.lang.Object

uws.service.request.NoEncodingParser

All Implemented Interfaces:

RequestParser

public class NoEncodingParser
extends java.lang.Object
implements RequestParser

This parser merely copies the whole HTTP request content inside a file. It names this file: "JDL" (Job Description Language).

The created file is stored in the temporary upload directory (UWSFileManager.getTmpDirectory(). This directory is supposed to be emptied regularly in case it is forgotten at any moment by the service implementation to delete unused request files.

The size of the JDL is limited by the static attribute SIZE_LIMIT before the creation of the file. Its default value is: DEFAULT_SIZE_LIMIT=2097152 bytes.

Since:

4.1

Version:

4.4 (08/2018)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE_LIMIT Default maximum allowed size for an HTTP request content: 2 MiB.
protected UWSFileManager	fileManager File manager to use to create UploadFile instances.
static int	SIZE_LIMIT Maximum allowed size for an HTTP request content.

Constructor Summary

Constructors

Constructor and Description
NoEncodingParser(UWSFileManager fileManager) Build the request parser.

Method Summary

Modifier and Type	Method and Description
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

DEFAULT_SIZE_LIMIT

public static final int DEFAULT_SIZE_LIMIT

Default maximum allowed size for an HTTP request content: 2 MiB.

See Also:

Constant Field Values

SIZE_LIMIT

public static int SIZE_LIMIT

Maximum allowed size for an HTTP request content. Over this limit, an exception is thrown and the request is aborted.

Note: The default value is DEFAULT_SIZE_LIMIT (= 2097152 MiB).

Note: This limit is expressed in bytes and can not be negative. Its smallest possible value is 0. If the set value is though negative, it will be ignored and DEFAULT_SIZE_LIMIT will be used instead.

fileManager

protected final UWSFileManager fileManager

File manager to use to create UploadFile instances. It is required by this new object to execute open, move and delete operations whenever it could be asked.

Constructor Detail

NoEncodingParser

public NoEncodingParser(UWSFileManager fileManager)

Build the request parser.

Parameters:

fileManager - A file manager. MUST NOT be NULL

Method Detail

parse

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