net.lecousin.framework.network.mime.entity

Class BinaryEntity

java.lang.Object

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

net.lecousin.framework.network.mime.entity.BinaryEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

FormDataEntity.PartFile

public class BinaryEntity
extends MimeEntity
implements AutoCloseable, net.lecousin.framework.util.AsyncCloseable<IOException>

Binary entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BinaryEntity.Consumer Consume data into an OutputToInput.

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

MimeEntity.Parser, MimeEntity.Transfer

Field Summary

Fields

Modifier and Type	Field and Description
protected net.lecousin.framework.io.IO.Readable	content

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

headers, parent

Constructor Summary

Constructors

Constructor and Description
BinaryEntity(net.lecousin.framework.io.IO.Readable content) Constructor.
BinaryEntity(MimeEntity parent, MimeHeaders headers) From existing headers.
BinaryEntity(MimeEntity parent, ParameterizedHeaderValue contentType, net.lecousin.framework.io.IO.Readable content) Constructor.
BinaryEntity(ParameterizedHeaderValue contentType, net.lecousin.framework.io.IO.Readable content) Constructor.
BinaryEntity(String contentType, net.lecousin.framework.io.IO.Readable content) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canProduceBodyRange() Return true if this entity is able to extract a range of the body.
void	close()
net.lecousin.framework.concurrent.async.IAsync<IOException>	closeAsync()
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.
static BinaryEntity	fromString(String content, Charset charset, String contentType) Create a BinaryEntity with a Content-Type header and the body from the given string.
net.lecousin.framework.io.IO.Readable	getContent()
void	setContent(net.lecousin.framework.io.IO.Readable content)
void	setContentType(ParameterizedHeaderValue contentType) Set the Content-Type.
void	setContentType(String contentType) Set the Content-Type.

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

content

protected net.lecousin.framework.io.IO.Readable content

Constructor Detail

BinaryEntity

public BinaryEntity(ParameterizedHeaderValue contentType,
                    net.lecousin.framework.io.IO.Readable content)

Constructor.

BinaryEntity

public BinaryEntity(String contentType,
                    net.lecousin.framework.io.IO.Readable content)

Constructor.

BinaryEntity

public BinaryEntity(net.lecousin.framework.io.IO.Readable content)

Constructor.

BinaryEntity

public BinaryEntity(MimeEntity parent,
                    ParameterizedHeaderValue contentType,
                    net.lecousin.framework.io.IO.Readable content)

Constructor.

BinaryEntity

public BinaryEntity(MimeEntity parent,
                    MimeHeaders headers)

From existing headers.

Method Detail

getContent

public net.lecousin.framework.io.IO.Readable getContent()

setContent

public void setContent(net.lecousin.framework.io.IO.Readable content)

setContentType

public void setContentType(ParameterizedHeaderValue contentType)

Set the Content-Type.

setContentType

public void setContentType(String contentType)

Set the Content-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

closeAsync

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

Specified by:

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

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

fromString

public static BinaryEntity fromString(String content,
                                      Charset charset,
                                      String contentType)

Create a BinaryEntity with a Content-Type header and the body from the given string.