cz.ues.platform.webcmd

Class MultipartRequest

java.lang.Object

cz.ues.platform.webcmd.MultipartRequest

public class MultipartRequest
extends java.lang.Object

Helper class for safe working with multipart requests.

Since:

UES7-10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MultipartRequest.MultipartFileSource Special implementation of UESFileSource allowing to create file source for data not physically stored on disk.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_MULTIPART_THRESHOLD_SIZE Default threshold size of multipart request.
private java.lang.String	defaultEncoding Default multipart items encoding.
private static java.lang.String	CHARSET_PARAM Header parameter containing default charset.
private java.util.Map<java.lang.String,FileItem>	itemMap Map of multipart items.
static java.lang.String	MULTIPART_FILE_STORAGE Request attribute containing path to multipart temporary files storage.
static java.lang.String	MULTIPART_THRESHOLD_SIZE Request attribute containing threshold size of multipart request.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MultipartRequest(java.util.List<FileItem> fileItems, java.lang.String defaultEncoding) Creates new instance of MultipartRequest.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Cleans all temporary files containing streamed parameter values.
private java.lang.String	determineEncoding(FileItem item) Determines encoding of multipart item.
java.lang.String	getParameter(java.lang.String name) Returns request parameter as plain text.
java.lang.String	getParameterType(java.lang.String name) Returns content-type of parameter with given name (content-type may not be defined for all parameters, in that case method returns null).
UESStreamHandler	getStreamedParameter(java.lang.String name) Returns request parameter as stream.
static boolean	isMultipart(javax.servlet.http.HttpServletRequest request) Determines whether the request contains multipart content.
static MultipartRequest	parse(javax.servlet.http.HttpServletRequest request) Parses given request and resolves multipart content.

Methods inherited from class java.lang.Object

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

Field Detail

MULTIPART_FILE_STORAGE

public static final MULTIPART_FILE_STORAGE

Request attribute containing path to multipart temporary files storage.

See Also:

Constant Field Values

MULTIPART_THRESHOLD_SIZE

public static final MULTIPART_THRESHOLD_SIZE

Request attribute containing threshold size of multipart request.

See Also:

Constant Field Values

DEFAULT_MULTIPART_THRESHOLD_SIZE

private static final DEFAULT_MULTIPART_THRESHOLD_SIZE

Default threshold size of multipart request.

See Also:

Constant Field Values

CHARSET_PARAM

private static final CHARSET_PARAM

Header parameter containing default charset.

See Also:

Constant Field Values

itemMap

private itemMap

Map of multipart items.

defaultEncoding

private defaultEncoding

Default multipart items encoding.

Constructor Detail

MultipartRequest

private MultipartRequest(java.util.List<FileItem> fileItems,
java.lang.String defaultEncoding)

Creates new instance of MultipartRequest.

Parameters:

fileItems - Parsed multipart items

defaultEncoding - Default encoding

Method Detail

isMultipart

public static boolean isMultipart(javax.servlet.http.HttpServletRequest request)

Determines whether the request contains multipart content.

Parameters:

request - Instance of request to be evaluated

Returns:

True if request is multipart, else false

Since:

UES7-10

parse

public static MultipartRequest parse(javax.servlet.http.HttpServletRequest request)

Parses given request and resolves multipart content.

Parameters:

request - Instance of request to be parsed

Returns:

Instance of MultipartRequest object

Since:

UES7-10

getParameter

public java.lang.String getParameter(java.lang.String name)

Returns request parameter as plain text.

Parameters:

name - Name of parameter

Returns:

Plain text value of parameter, null in case parameter does not exist, parameter is file, or parameter exceeds threshold size (and thus must be handled as stream)

Since:

UES7-10

getStreamedParameter

public UESStreamHandler getStreamedParameter(java.lang.String name)

Returns request parameter as stream.

Parameters:

name - Name Name of parameter

Returns:

Instance of UESStreamHandler (UESFileHandler in case of file parameter) containing streamed value of parameter, null in case parameter does not exist.

Since:

UES7-10

getParameterType

public java.lang.String getParameterType(java.lang.String name)

Returns content-type of parameter with given name (content-type may not be defined for all parameters, in that case method returns null).

Parameters:

name - Name of parameter

Returns:

Content-type or null (if parameter does not exist or content-type is not defined)

Since:

UES7-10

cleanup

public void cleanup()

Cleans all temporary files containing streamed parameter values.

Since:

UES7-10

determineEncoding

private java.lang.String determineEncoding(FileItem item)

Determines encoding of multipart item.

Parameters:

item - Item for which to resolve encoding

Returns:

Item encoding

Since:

UES7-10