Class AbstractClassicEntityProducer
java.lang.Object
org.apache.hc.core5.http.nio.support.classic.AbstractClassicEntityProducer
- All Implemented Interfaces:
EntityDetails
,AsyncDataProducer
,AsyncEntityProducer
,ResourceHolder
AsyncEntityProducer
implementation that acts as a compatibility
layer for classic OutputStream
based interfaces. Blocking output
processing is executed through an Executor
.- Since:
- 5.0
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SharedOutputBuffer
private final ContentType
private final AtomicReference
<Exception> private final Executor
private final AtomicReference
<AbstractClassicEntityProducer.State> -
Constructor Summary
ConstructorsConstructorDescriptionAbstractClassicEntityProducer
(int initialBufferSize, ContentType contentType, Executor executor) -
Method Summary
Modifier and TypeMethodDescriptionfinal int
Returns the number of bytes immediately available for output.final void
Triggered to signal a failure in data generation.Returns content encoding of the entity, if known.final long
Returns length of the entity, if known.final String
Returns content type of the entity, if known.final Exception
Preliminary declaration of trailing headers.final boolean
Returns chunked transfer hint for this entity.final boolean
Determines whether the producer can consistently produce the same content after invocation ofResourceHolder.releaseResources()
.final void
produce
(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.protected abstract void
produceData
(ContentType contentType, OutputStream outputStream) Writes out entity data into the given stream.void
-
Field Details
-
buffer
-
contentType
-
executor
-
state
-
exception
-
-
Constructor Details
-
AbstractClassicEntityProducer
public AbstractClassicEntityProducer(int initialBufferSize, ContentType contentType, Executor executor)
-
-
Method Details
-
produceData
protected abstract void produceData(ContentType contentType, OutputStream outputStream) throws IOException Writes out entity data into the given stream.- Parameters:
contentType
- the entity content typeoutputStream
- the output stream- Throws:
IOException
-
isRepeatable
public final 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
-
available
public final 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
-
getContentLength
public final 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 final 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
-
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.
-
getException
-
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-