Package 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 java.lang.Object implements AsyncEntityProducer
AnAsyncEntityProducer
that subscribes to aPublisher
instance, as defined by the Reactive Streams specification.- Since:
- 5.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
contentEncoding
private long
contentLength
private ContentType
contentType
private ReactiveDataProducer
reactiveDataProducer
-
Constructor Summary
Constructors Constructor Description ReactiveEntityProducer(org.reactivestreams.Publisher<java.nio.ByteBuffer> publisher, long contentLength, ContentType contentType, java.lang.String contentEncoding)
Creates a newReactiveEntityProducer
with the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
Returns the number of bytes immediately available for output.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data generation.java.lang.String
getContentEncoding()
Returns content encoding of the entity, if known.long
getContentLength()
Returns length of the entity, if known.java.lang.String
getContentType()
Returns content type of the entity, if known.java.util.Set<java.lang.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 ofResourceHolder.releaseResources()
.void
produce(DataStreamChannel channel)
Triggered to signal the ability of the underlying data channel to accept more data.void
releaseResources()
-
-
-
Field Detail
-
reactiveDataProducer
private final ReactiveDataProducer reactiveDataProducer
-
contentLength
private final long contentLength
-
contentType
private final ContentType contentType
-
contentEncoding
private final java.lang.String contentEncoding
-
-
Constructor Detail
-
ReactiveEntityProducer
public ReactiveEntityProducer(org.reactivestreams.Publisher<java.nio.ByteBuffer> publisher, long contentLength, ContentType contentType, java.lang.String contentEncoding)
Creates a newReactiveEntityProducer
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
- theContent-Type
of the entity, or null if none.contentEncoding
- theContent-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 interfaceAsyncDataProducer
- Returns:
- the number of bytes immediately available for output
-
produce
public void produce(DataStreamChannel channel) throws java.io.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 interfaceAsyncDataProducer
- Parameters:
channel
- the data channel capable to accepting more data.- Throws:
java.io.IOException
-
releaseResources
public void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
isRepeatable
public boolean isRepeatable()
Description copied from interface:AsyncEntityProducer
Determines whether the producer can consistently produce the same content after invocation ofResourceHolder.releaseResources()
.- Specified by:
isRepeatable
in interfaceAsyncEntityProducer
-
failed
public void failed(java.lang.Exception cause)
Description copied from interface:AsyncEntityProducer
Triggered to signal a failure in data generation.- Specified by:
failed
in interfaceAsyncEntityProducer
- 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 interfaceEntityDetails
-
getContentType
public java.lang.String getContentType()
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
getContentEncoding
public java.lang.String getContentEncoding()
Description copied from interface:EntityDetails
Returns content encoding of the entity, if known.- Specified by:
getContentEncoding
in interfaceEntityDetails
-
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 interfaceEntityDetails
-
getTrailerNames
public java.util.Set<java.lang.String> getTrailerNames()
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
-