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 Object
implements AsyncEntityProducer
An
AsyncEntityProducer
that subscribes to a Publisher
instance, as defined by the Reactive Streams specification.- Since:
- 5.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final long
private final ContentType
private final ReactiveDataProducer
-
Constructor Summary
ConstructorsConstructorDescriptionReactiveEntityProducer
(org.reactivestreams.Publisher<ByteBuffer> publisher, long contentLength, ContentType contentType, String contentEncoding) Creates a newReactiveEntityProducer
with the given parameters. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of bytes immediately available for output.void
Triggered to signal a failure in data generation.Returns content encoding of the entity, if known.long
Returns length of the entity, if known.Returns content type of the entity, if known.Preliminary declaration of trailing headers.boolean
Returns chunked transfer hint for this entity.boolean
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
-
Field Details
-
reactiveDataProducer
-
contentLength
private final long contentLength -
contentType
-
contentEncoding
-
-
Constructor Details
-
ReactiveEntityProducer
public ReactiveEntityProducer(org.reactivestreams.Publisher<ByteBuffer> publisher, long contentLength, ContentType contentType, 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 Details
-
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
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:
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
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
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
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
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-