net.lecousin.framework.network.mime.entity

Class FormDataEntity

java.lang.Object

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

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

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

All Implemented Interfaces:

AutoCloseable, MimeHeadersContainer<MimeEntity>, net.lecousin.framework.util.AsyncCloseable<IOException>

public class FormDataEntity
extends MultipartEntity
implements AutoCloseable, 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.FormDataPartFactory Factory to create PartField or PartFile depending on headers.
static class	FormDataEntity.PartField Part for a field.
static class	FormDataEntity.PartFile Part for a file.

Nested classes/interfaces inherited from class net.lecousin.framework.network.mime.entity.MultipartEntity

MultipartEntity.BodyProducer, MultipartEntity.Parser

Nested classes/interfaces inherited from class net.lecousin.framework.network.mime.entity.MimeEntity

MimeEntity.Transfer

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPART_SUB_TYPE

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

boundary, MAIN_CONTENT_TYPE, partFactory, parts

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

headers, parent

Constructor Summary

Constructors

Constructor and Description
FormDataEntity() Constructor.
FormDataEntity(byte[] boundary) Constructor.
FormDataEntity(MimeEntity parent, MimeHeaders headers) 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.async.IAsync<IOException>	closeAsync()
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.
void	setPartFactory(MimeEntityFactory partFactory)

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

add, canProduceBodyRange, createBodyProducer, createBodyRange, createConsumer, generateBoundary, getBoundary, getPartFactory, getParts, getPartsOfType

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

getHeaders, getParent, parse, writeEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.util.AsyncCloseable

closeAfter

Methods inherited from interface net.lecousin.framework.network.mime.header.MimeHeadersContainer

addHeader, addHeader, addHeader, setHeader, setHeader, setHeader

Field Detail

MULTIPART_SUB_TYPE

public static final String MULTIPART_SUB_TYPE

See Also:

Constant Field Values

Constructor Detail

FormDataEntity

public FormDataEntity()

Constructor.

FormDataEntity

public FormDataEntity(byte[] boundary)

Constructor.

FormDataEntity

public FormDataEntity(MimeEntity parent,
                      MimeHeaders headers)
               throws MimeException

Constructor.

Throws:

MimeException

Method Detail

setPartFactory

public void setPartFactory(MimeEntityFactory partFactory)

Overrides:

setPartFactory in class MultipartEntity

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 AutoCloseable

Throws:

IOException

closeAsync

public net.lecousin.framework.concurrent.async.IAsync<IOException> closeAsync()

Specified by:

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