net.lecousin.framework.network.mime.entity

Class MimeEntity

java.lang.Object

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

All Implemented Interfaces:

MimeHeadersContainer<MimeEntity>

Direct Known Subclasses:

BinaryEntity, BinaryFileEntity, EmptyEntity, FormDataEntity.PartField, FormUrlEncodedEntity, MultipartEntity, TextEntity

public abstract class MimeEntity
extends Object
implements MimeHeadersContainer<MimeEntity>

A Mime entity is a Mime Message with headers and a specific body.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MimeEntity.Parser Parser of a MIME message.
static class	MimeEntity.Transfer Parser of MIME Entity, using TransferEncodingFactory.

Field Summary

Fields

Modifier and Type	Field and Description
protected MimeHeaders	headers
protected MimeEntity	parent

Constructor Summary

Constructors

Constructor and Description
MimeEntity(MimeEntity parent) Constructor.
MimeEntity(MimeEntity parent, MimeHeaders headers) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canProduceBodyRange() Return true if this entity is able to extract a range of the body.
abstract 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.
abstract 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.
abstract net.lecousin.framework.concurrent.util.AsyncConsumer<ByteBuffer,IOException>	createConsumer(Long size) Create a consumer of data to parse the body.
MimeHeaders	getHeaders() Return the MIME headers.
MimeEntity	getParent()
static net.lecousin.framework.concurrent.async.AsyncSupplier<MimeEntity,IOException>	parse(net.lecousin.framework.io.IO.Readable input, MimeEntityFactory entityFactory) Parse the given input as a MimeEntity.
net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.io.IO.OutputToInput,IOException>	writeEntity() Write the headers and body of this entity into an OutputToInput.

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

parent

protected MimeEntity parent

headers

protected MimeHeaders headers

Constructor Detail

MimeEntity

public MimeEntity(MimeEntity parent,
                  MimeHeaders headers)

Constructor.

MimeEntity

public MimeEntity(MimeEntity parent)

Constructor.

Method Detail

getParent

public MimeEntity getParent()

getHeaders

public MimeHeaders getHeaders()

Description copied from interface: MimeHeadersContainer

Return the MIME headers.

Specified by:

getHeaders in interface MimeHeadersContainer<MimeEntity>

createBodyProducer

public abstract 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.

Returns:

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

canProduceBodyRange

public abstract boolean canProduceBodyRange()

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

createBodyRange

public abstract 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. 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.

writeEntity

public net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.io.IO.OutputToInput,IOException> writeEntity()

Write the headers and body of this entity into an OutputToInput.

createConsumer

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

Create a consumer of data to parse the body.

Parameters:

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

parse

public static net.lecousin.framework.concurrent.async.AsyncSupplier<MimeEntity,IOException> parse(net.lecousin.framework.io.IO.Readable input,
                                                                                                  MimeEntityFactory entityFactory)

Parse the given input as a MimeEntity.