de.aristaflow.adept2.ui.htmlgui

Class HTMLContext.Attachment

java.lang.Object

de.aristaflow.adept2.ui.htmlgui.HTMLContext.Attachment

Enclosing interface:

HTMLContext

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

An Attachment represents either binary data or a (text) file uploaded to the HTTP-service. This data or the uploaded files may be provided as mulitpart-POST-data generated by appropriate HTML set via the HTMLContext. Attachments provide a high-level interface for a body part of the multipart by providing the size, the content-type, the data, the filename, as well as all additional header data of the body part.
Since attachments need not necessarily be files, the filename may be null. However all other information is guaranteed to be non-null. Note that the header data is not parsed but just provided as-is from the body part.

Author:

Kevin Goeser, Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	contentType Field for getContentType().
protected java.io.InputStream	data Field for getData().
protected java.lang.String	fileName Field for getFileName().
protected java.util.Map<java.lang.String,java.lang.String>	headerData Field for getHeaderData().
protected long	size Field for getSize().

Constructor Summary

Constructors

Constructor and Description
Attachment(java.lang.String contentType, java.io.InputStream data, long size, java.lang.String fileName, java.util.Map<java.lang.String,java.lang.String> headerData) Creates a new Attachment with the designated attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType() Gets the content type of the data, that is the value of the RFC 822 "Content-Type" header field of the body part.
java.io.InputStream	getData() Gets the actual data as input stream; this is the content of the corresponding body part of the multipart.
java.lang.String	getFileName() Gets the name of the file as sent by the client, in case the attachment was a file upload, null otherwise (for non-file binary data).
java.util.Map<java.lang.String,java.lang.String>	getHeaderData() Gets all header data which is sent with the body part of the multipart this attachment stems from.
long	getSize() Gets the size of the attachment as number of bytes.

Methods inherited from class java.lang.Object

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

Field Detail

contentType

protected final java.lang.String contentType

Field for getContentType().

size

protected final long size

Field for getSize().

data

protected final java.io.InputStream data

Field for getData().

fileName

protected final java.lang.String fileName

Field for getFileName().

headerData

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

Field for getHeaderData().

Constructor Detail

Attachment

public Attachment(java.lang.String contentType,
                  java.io.InputStream data,
                  long size,
                  java.lang.String fileName,
                  java.util.Map<java.lang.String,java.lang.String> headerData)

Creates a new Attachment with the designated attributes. The header data is stored as unmodifiable map. Do not modify it after calling this constructor to prevent unwanted side-effects since it is not copied.

Parameters:

contentType - The value of the RFC 822 "Content-Type" header field of the body part, which indicates how to interpret the data of this attachment. This must neither be null nor the empty string.

data - The data of this attachment which is the content of the corresponding body part. This must not be null.

size - The size in bytes of the data/content of the body part.

fileName - The name of the file in case the body part contains a file, null otherwise.

headerData - The map containing the complete and unparsed headers of the corresponding body part. This must not be null.

Method Detail

getContentType

public java.lang.String getContentType()

Gets the content type of the data, that is the value of the RFC 822 "Content-Type" header field of the body part.

Returns:

The content type of the data, e.g. text/html.

getSize

public long getSize()

Gets the size of the attachment as number of bytes.

Returns:

The size of the attachment (number of bytes).

getData

public java.io.InputStream getData()

Gets the actual data as input stream; this is the content of the corresponding body part of the multipart.

Returns:

The actual data of this attachment as provided as content of the body part.

getFileName

public java.lang.String getFileName()

Gets the name of the file as sent by the client, in case the attachment was a file upload, null otherwise (for non-file binary data).

Returns:

The file name in case of a file upload, null otherwise (for non-file binary data).

getHeaderData

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

Gets all header data which is sent with the body part of the multipart this attachment stems from. The values of the header data may be arbitrary strings even containing key-value-pairs again. However, they are just provided as from the body part.

Returns:

All header data (mapping from header name to value) which is sent with the body part of the multipart this attachment stems from.

See Also:

javax.mail.Header