de.aristaflow.adept2.ui.htmlgui

Class HTMLContext.HTTPReply

java.lang.Object

de.aristaflow.adept2.ui.htmlgui.HTMLContext.HTTPReply

Enclosing interface:

HTMLContext

public static class HTMLContext.HTTPReply
extends java.lang.Object

The HTTPReply wraps the data sent as GET or POST to the web server. It supports simple strings, attachments (that is binary data and/or uploaded files) as well as lists of both types. Attachments may only be provided by multipart form-content while normal POST (or GET) may contain URL-encoded form data.
The keys in the provided maps are the names of the parameters or the form elements in the corresponding HTML set in the corresponding HTMLContext. If a parameter (or form element name) occurs several times and therefore has several values, they will be provided via the appropriate list-methods of this HTTPReply. Simple parameters occurring only once are provided via the simple maps.

Author:

Kevin Goeser, Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>>	attachmentLists Field for getAttachmentLists().
protected java.util.Map<java.lang.String,HTMLContext.Attachment>	attachments Field for getAttachments().
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	parameterLists Field for getParameterLists().
protected java.util.Map<java.lang.String,java.lang.String>	parameters Field for getParameters().

Constructor Summary

Constructors

Constructor and Description
HTTPReply(java.util.Map<java.lang.String,java.lang.String> parameters, java.util.Map<java.lang.String,HTMLContext.Attachment> attachments, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameterLists, java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> attachmentLists) Creates a new HTTPReply with the designated attributes.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>>	getAttachmentLists() Gets the parameters (mapping from parameter name to several attachments) that are binary data and/or files and occur several times in the HTTP-reply.
java.util.Map<java.lang.String,HTMLContext.Attachment>	getAttachments() Gets the parameters (mapping from parameter name to attachment) that are binary data and/or files and occur only once in the HTTP-reply.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterLists() Gets the parameters (mapping from parameter name to several values) that occur several times in the HTTP-reply and therefore have several values.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets the parameters (mapping from parameter name to value) that occur only once in the HTTP-reply and therefore have only one value.

Methods inherited from class java.lang.Object

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

Field Detail

attachmentLists

protected final java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> attachmentLists

Field for getAttachmentLists().

attachments

protected final java.util.Map<java.lang.String,HTMLContext.Attachment> attachments

Field for getAttachments().

parameterLists

protected final java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameterLists

Field for getParameterLists().

parameters

protected final java.util.Map<java.lang.String,java.lang.String> parameters

Field for getParameters().

Constructor Detail

HTTPReply

public HTTPReply(java.util.Map<java.lang.String,java.lang.String> parameters,
                 java.util.Map<java.lang.String,HTMLContext.Attachment> attachments,
                 java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameterLists,
                 java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> attachmentLists)

Creates a new HTTPReply with the designated attributes. All maps are stored unmodifiable including the lists in the map. Do not modify the maps or lists after calling this constructor. This may cause unwanted side-effects since neither the maps nor the lists are copied.

Parameters:

parameters - The map containing all simple parameters having only one value. This must not be null.

attachments - The map containing all attachment parameters (uploaded files) having only one value/attachment. This must not be null!

parameterLists - The map containing all simple parameters having several value. This must not be null.

attachmentLists - The map containing all attachment parameters (uploaded files) having several values/attachments. This must not be null!

Method Detail

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets the parameters (mapping from parameter name to value) that occur only once in the HTTP-reply and therefore have only one value.

Returns:

An unmodifiable map providing the parameters (mapping from parameter name to value) having only one value in the HTTP-reply sent by the client.

getAttachments

public java.util.Map<java.lang.String,HTMLContext.Attachment> getAttachments()

Gets the parameters (mapping from parameter name to attachment) that are binary data and/or files and occur only once in the HTTP-reply.

Returns:

An unmodifiable map providing the binary data/file parameters (mapping from parameter name to attachment) having only one attachment in the HTTP-reply sent by the client.

getParameterLists

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameterLists()

Gets the parameters (mapping from parameter name to several values) that occur several times in the HTTP-reply and therefore have several values.

Returns:

An unmodifiable map providing the parameters (mapping from parameter name to values) having several values in the HTTP-reply sent by the client.

getAttachmentLists

public java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> getAttachmentLists()

Gets the parameters (mapping from parameter name to several attachments) that are binary data and/or files and occur several times in the HTTP-reply.

Returns:

An unmodifiable map providing the binary data/file parameters (mapping from parameter name to attachments) having several attachments in the HTTP-reply sent by the client.