org.apache.hc.core5.reactive

Class ReactiveEntityProducer

java.lang.Object

org.apache.hc.core5.reactive.ReactiveEntityProducer

All Implemented Interfaces:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder

@Contract(threading=SAFE)
public final class ReactiveEntityProducer
extends Object
implements AsyncEntityProducer

An AsyncEntityProducer that subscribes to a Publisher instance, as defined by the Reactive Streams specification.

Since:

5.0

Constructor Summary

Constructors

Constructor and Description
ReactiveEntityProducer(org.reactivestreams.Publisher<ByteBuffer> publisher, long contentLength, ContentType contentType, String contentEncoding) Creates a new ReactiveEntityProducer with the given parameters.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes immediately available for output.
void	failed(Exception cause) Triggered to signal a failure in data generation.
String	getContentEncoding() Returns content encoding of the entity, if known.
long	getContentLength() Returns length of the entity, if known.
String	getContentType() Returns content type of the entity, if known.
Set<String>	getTrailerNames() Preliminary declaration of trailing headers.
boolean	isChunked() Returns chunked transfer hint for this entity.
boolean	isRepeatable() Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().
void	produce(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.
void	releaseResources()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveEntityProducer

public ReactiveEntityProducer(org.reactivestreams.Publisher<ByteBuffer> publisher,
                              long contentLength,
                              ContentType contentType,
                              String contentEncoding)

Creates a new ReactiveEntityProducer with the given parameters.

Parameters:

publisher - the publisher of the entity stream.

contentLength - the length of the entity, or -1 if unknown (implies chunked encoding).

contentType - the Content-Type of the entity, or null if none.

contentEncoding - the Content-Encoding of the entity, or null if none.

Method Detail

available

public int available()

Description copied from interface: AsyncDataProducer

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

Specified by:

available in interface AsyncDataProducer

Returns:

the number of bytes immediately available for output

produce

public void produce(DataStreamChannel channel)
             throws IOException

Description copied from interface: AsyncDataProducer

Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

Specified by:

produce in interface AsyncDataProducer

Parameters:

channel - the data channel capable to accepting more data.

Throws:

IOException

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder

isRepeatable

public boolean isRepeatable()

Description copied from interface: AsyncEntityProducer

Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().

Specified by:

isRepeatable in interface AsyncEntityProducer

failed

public void failed(Exception cause)

Description copied from interface: AsyncEntityProducer

Triggered to signal a failure in data generation.

Specified by:

failed in interface AsyncEntityProducer

Parameters:

cause - the cause of the failure.

getContentLength

public long getContentLength()

Description copied from interface: EntityDetails

Returns length of the entity, if known.

Specified by:

getContentLength in interface EntityDetails

getContentType

public String getContentType()

Description copied from interface: EntityDetails

Returns content type of the entity, if known.

Specified by:

getContentType in interface EntityDetails

getContentEncoding

public String getContentEncoding()

Description copied from interface: EntityDetails

Returns content encoding of the entity, if known.

Specified by:

getContentEncoding in interface EntityDetails

isChunked

public boolean isChunked()

Description copied from interface: EntityDetails

Returns chunked transfer hint for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

Specified by:

isChunked in interface EntityDetails

getTrailerNames

public Set<String> getTrailerNames()

Description copied from interface: EntityDetails

Preliminary declaration of trailing headers.

Specified by:

getTrailerNames in interface EntityDetails