Package org.apache.hc.core5.http.nio.support.classic

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 Object
implements AsyncEntityProducer

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

Modifier and Type	Class	Description
private static enum	AbstractClassicEntityProducer.State

Field Summary

Fields

Modifier and Type	Field	Description
private final SharedOutputBuffer	buffer
private final ContentType	contentType
private final AtomicReference<Exception>	exception
private final Executor	executor
private final AtomicReference<AbstractClassicEntityProducer.State>	state

Constructor Summary

Constructors

Constructor	Description
AbstractClassicEntityProducer(int initialBufferSize, ContentType contentType, Executor executor)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

buffer

private final SharedOutputBuffer buffer

contentType

private final ContentType contentType

executor

private final Executor executor

state

private final AtomicReference<AbstractClassicEntityProducer.State> state

exception

private final AtomicReference<Exception> 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 type

outputStream - 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 of ResourceHolder.releaseResources().

Specified by:

isRepeatable in interface AsyncEntityProducer

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 interface AsyncDataProducer

Returns:

the number of bytes immediately available for output

produce

public final 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

getContentLength

public final long getContentLength()

Description copied from interface: EntityDetails

Returns length of the entity, if known.

Specified by:

getContentLength in interface EntityDetails

getContentType

public final 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 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 interface EntityDetails

getTrailerNames

public final Set<String> getTrailerNames()

Description copied from interface: EntityDetails

Preliminary declaration of trailing headers.

Specified by:

getTrailerNames in interface EntityDetails

failed

public final 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.

getException

public final Exception getException()

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder