net.lecousin.framework.network.mime.entity

Class MultipartEntity

java.lang.Object

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

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

All Implemented Interfaces:

MimeHeadersContainer<MimeEntity>

Direct Known Subclasses:

FormDataEntity

public class MultipartEntity
extends MimeEntity

Multi-part entity, see RFC 1341.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MultipartEntity.BodyProducer Producer of body data.
class	MultipartEntity.Parser Parser for multi-part content.

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

MimeEntity.Transfer

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	boundary
static String	MAIN_CONTENT_TYPE
protected MimeEntityFactory	partFactory
protected LinkedList<MimeEntity>	parts

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

headers, parent

Constructor Summary

Constructors

Constructor and Description
MultipartEntity(byte[] boundary, String subType) Constructor.
MultipartEntity(MimeEntity parent, MimeHeaders headers) From existing headers.
MultipartEntity(String subType) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(MimeEntity part) Append a part.
boolean	canProduceBodyRange() Return true if this entity is able to extract a range of the body.
net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.util.Pair<Long,net.lecousin.framework.concurrent.util.AsyncProducer<ByteBuffer,IOException>>,IOException>	createBodyProducer() Create a producer of this entity's body.
net.lecousin.framework.util.Triple<net.lecousin.framework.math.RangeLong,Long,BinaryEntity>	createBodyRange(net.lecousin.framework.math.RangeLong range) Extract a range of this entity's body.
net.lecousin.framework.concurrent.util.AsyncConsumer<ByteBuffer,IOException>	createConsumer(Long size) Create a consumer of data to parse the body.
protected static byte[]	generateBoundary()
byte[]	getBoundary()
MimeEntityFactory	getPartFactory()
List<MimeEntity>	getParts()
<T extends MimeEntity> List<T>	getPartsOfType(Class<T> type) Return the parts compatible with the given type.
void	setPartFactory(MimeEntityFactory partFactory)

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.network.mime.header.MimeHeadersContainer

addHeader, addHeader, addHeader, setHeader, setHeader, setHeader

Field Detail

MAIN_CONTENT_TYPE

public static final String MAIN_CONTENT_TYPE

See Also:

Constant Field Values

boundary

protected byte[] boundary

parts

protected LinkedList<MimeEntity> parts

partFactory

protected MimeEntityFactory partFactory

Constructor Detail

MultipartEntity

public MultipartEntity(byte[] boundary,
                       String subType)

Constructor.

MultipartEntity

public MultipartEntity(String subType)

Constructor.

MultipartEntity

public MultipartEntity(MimeEntity parent,
                       MimeHeaders headers)
                throws MimeException

From existing headers.

Throws:

MimeException

Method Detail

getPartFactory

public MimeEntityFactory getPartFactory()

setPartFactory

public void setPartFactory(MimeEntityFactory partFactory)

generateBoundary

protected static byte[] generateBoundary()

getBoundary

public byte[] getBoundary()

add

public void add(MimeEntity part)

Append a part.

getParts

public List<MimeEntity> getParts()

getPartsOfType

public <T extends MimeEntity> List<T> getPartsOfType(Class<T> type)

Return the parts compatible with the given type.

createBodyProducer

public net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.util.Pair<Long,net.lecousin.framework.concurrent.util.AsyncProducer<ByteBuffer,IOException>>,IOException> createBodyProducer()

Description copied from class: MimeEntity

Create a producer of this entity's body.

Specified by:

createBodyProducer in class MimeEntity

Returns:

a Pair with the body size (or null if undetermined) and the producer

canProduceBodyRange

public boolean canProduceBodyRange()

Description copied from class: MimeEntity

Return true if this entity is able to extract a range of the body.

Specified by:

canProduceBodyRange in class MimeEntity

createBodyRange

public net.lecousin.framework.util.Triple<net.lecousin.framework.math.RangeLong,Long,BinaryEntity> createBodyRange(net.lecousin.framework.math.RangeLong range)

Description copied from class: MimeEntity

Extract a range of this entity's body. If range.min is -1, it means the last range.max bytes have to be extracted. If range.max is -1, it means to extract from range.min until the end. Else the extraction starts at range.min until range.max included. If range.max is greater than the total size, extraction is done until the end. Return values are: the range extracted (without -1 and with a max not greater than the total size), the total size, and a BinaryEntity containing the extracted body.

Specified by:

createBodyRange in class MimeEntity

createConsumer

public net.lecousin.framework.concurrent.util.AsyncConsumer<ByteBuffer,IOException> createConsumer(Long size)

Description copied from class: MimeEntity

Create a consumer of data to parse the body.

Specified by:

createConsumer in class MimeEntity

Parameters:

size - size of data to consume if known, null if unknown