net.lecousin.framework.network.mime.entity

Class FormDataEntity

java.lang.Object

net.lecousin.framework.network.mime.MimeMessage

net.lecousin.framework.network.mime.entity.MimeEntity

net.lecousin.framework.network.mime.entity.MultipartEntity

net.lecousin.framework.network.mime.entity.FormDataEntity

All Implemented Interfaces:

Closeable, AutoCloseable, net.lecousin.framework.util.AsyncCloseable<IOException>

public class FormDataEntity
extends MultipartEntity
implements Closeable, net.lecousin.framework.util.AsyncCloseable<IOException>

form-data entity, see RFC 2388.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormDataEntity.PartField Part for a field.
static class	FormDataEntity.PartFile Part for a file.

Field Summary

Fields inherited from class net.lecousin.framework.network.mime.entity.MultipartEntity

boundary, parts

Fields inherited from class net.lecousin.framework.network.mime.MimeMessage

CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, CRLF, TRANSFER_ENCODING

Constructor Summary

Constructors

Constructor and Description
FormDataEntity() Constructor.
FormDataEntity(byte[] boundary) Constructor.

Method Summary

Modifier and Type	Method and Description
FormDataEntity.PartField	addField(String name, String value, Charset charset) Append a field with a value.
FormDataEntity.PartFile	addFile(String fieldName, String filename, ParameterizedHeaderValue contentType, net.lecousin.framework.io.IO.Readable content) Append a file.
void	close()
net.lecousin.framework.concurrent.synch.ISynchronizationPoint<IOException>	closeAsync()
protected net.lecousin.framework.concurrent.synch.AsyncWork<MimeMessage,IOException>	createPart(List<MimeHeader> headers, net.lecousin.framework.io.buffering.IOInMemoryOrFile body, boolean asReceived)
List<net.lecousin.framework.util.Pair<String,String>>	getFields() Return the fields contained in the form-data.
String	getFieldValue(String name) Return the value of the given field.
FormDataEntity.PartFile	getFile(String name) Return the file corresponding to the field of the given name.

Methods inherited from class net.lecousin.framework.network.mime.entity.MultipartEntity

add, from, generateBoundary, getBodyToSend, getBoundary, getParts, getPartsOfType, parse

Methods inherited from class net.lecousin.framework.network.mime.MimeMessage

addHeader, addHeader, addHeaderRaw, appendHeadersTo, appendHeadersTo, getBodyReceivedAsInput, getBodyReceivedAsOutput, getContentLength, getContentType, getContentTypeValue, getFirstHeader, getFirstHeaderLongValue, getFirstHeaderRawValue, getFirstHeaderValue, getHeaders, getHeaders, getHeadersValues, getLogger, getReadableStream, hasHeader, readHeader, removeHeaders, send, setBodyReceived, setBodyToSend, setContentLength, setHeader, setHeader, setHeaderRaw

Methods inherited from class java.lang.Object

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

Constructor Detail

FormDataEntity

public FormDataEntity()

Constructor.

FormDataEntity

public FormDataEntity(byte[] boundary)

Constructor.

Method Detail

addField

public FormDataEntity.PartField addField(String name,
                                         String value,
                                         Charset charset)

Append a field with a value.

addFile

public FormDataEntity.PartFile addFile(String fieldName,
                                       String filename,
                                       ParameterizedHeaderValue contentType,
                                       net.lecousin.framework.io.IO.Readable content)

Append a file.

getFields

public List<net.lecousin.framework.util.Pair<String,String>> getFields()

Return the fields contained in the form-data.

getFieldValue

public String getFieldValue(String name)

Return the value of the given field.

getFile

public FormDataEntity.PartFile getFile(String name)

Return the file corresponding to the field of the given name.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

closeAsync

public net.lecousin.framework.concurrent.synch.ISynchronizationPoint<IOException> closeAsync()

Specified by:

closeAsync in interface net.lecousin.framework.util.AsyncCloseable<IOException>

createPart

protected net.lecousin.framework.concurrent.synch.AsyncWork<MimeMessage,IOException> createPart(List<MimeHeader> headers,
                                                                                                net.lecousin.framework.io.buffering.IOInMemoryOrFile body,
                                                                                                boolean asReceived)

Overrides:

createPart in class MultipartEntity