Class AbstractClassicEntityProducer
- java.lang.Object
-
- org.apache.hc.core5.http.nio.support.classic.AbstractClassicEntityProducer
-
- All Implemented Interfaces:
EntityDetails
,AsyncDataProducer
,AsyncEntityProducer
,ResourceHolder
public abstract class AbstractClassicEntityProducer extends java.lang.Object implements AsyncEntityProducer
AsyncEntityProducer
implementation that acts as a compatibility layer for classicOutputStream
based interfaces. Blocking output processing is executed through anExecutor
.- Since:
- 5.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
AbstractClassicEntityProducer.State
-
Field Summary
Fields Modifier and Type Field Description private SharedOutputBuffer
buffer
private ContentType
contentType
private java.util.concurrent.atomic.AtomicReference<java.lang.Exception>
exception
private java.util.concurrent.Executor
executor
private java.util.concurrent.atomic.AtomicReference<AbstractClassicEntityProducer.State>
state
-
Constructor Summary
Constructors Constructor Description AbstractClassicEntityProducer(int initialBufferSize, ContentType contentType, java.util.concurrent.Executor executor)
-
Method Summary
All Methods Instance Methods Abstract 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.lang.Exception
getException()
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.protected abstract void
produceData(ContentType contentType, java.io.OutputStream outputStream)
Writes out entity data into the given stream.void
releaseResources()
-
-
-
Field Detail
-
buffer
private final SharedOutputBuffer buffer
-
contentType
private final ContentType contentType
-
executor
private final java.util.concurrent.Executor executor
-
state
private final java.util.concurrent.atomic.AtomicReference<AbstractClassicEntityProducer.State> state
-
exception
private final java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exception
-
-
Constructor Detail
-
AbstractClassicEntityProducer
public AbstractClassicEntityProducer(int initialBufferSize, ContentType contentType, java.util.concurrent.Executor executor)
-
-
Method Detail
-
produceData
protected abstract void produceData(ContentType contentType, java.io.OutputStream outputStream) throws java.io.IOException
Writes out entity data into the given stream.- Parameters:
contentType
- the entity content typeoutputStream
- the output stream- Throws:
java.io.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
public final 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
-
getContentLength
public final long getContentLength()
Description copied from interface:EntityDetails
Returns length of the entity, if known.- Specified by:
getContentLength
in interfaceEntityDetails
-
getContentType
public final 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 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
public final java.util.Set<java.lang.String> getTrailerNames()
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
failed
public final 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.
-
getException
public final java.lang.Exception getException()
-
releaseResources
public void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
-