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

@Deprecated
public abstract class AbstractClassicEntityProducer
extends java.lang.Object
implements AsyncEntityProducer

Deprecated.

Use ClassicToAsyncRequestProducer.

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 class	AbstractClassicEntityProducer.State	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
private SharedOutputBuffer	buffer	Deprecated.
private ContentType	contentType	Deprecated.
private java.util.concurrent.atomic.AtomicReference<java.lang.Exception>	exception	Deprecated.
private java.util.concurrent.Executor	executor	Deprecated.
private java.util.concurrent.atomic.AtomicReference<AbstractClassicEntityProducer.State>	state	Deprecated.

Constructor Summary

Constructors

Constructor	Description
AbstractClassicEntityProducer(int initialBufferSize, ContentType contentType, java.util.concurrent.Executor executor)	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	available()	Deprecated. Returns the number of bytes immediately available for output.
void	failed(java.lang.Exception cause)	Deprecated. Triggered to signal a failure in data generation.
java.lang.String	getContentEncoding()	Deprecated. Gets content encoding of this entity, if known.
long	getContentLength()	Deprecated. Gets length of this entity, if known.
java.lang.String	getContentType()	Deprecated. Gets content type of this entity, if known.
java.lang.Exception	getException()	Deprecated.
java.util.Set<java.lang.String>	getTrailerNames()	Deprecated. Gets the preliminary declaration of trailing headers.
boolean	isChunked()	Deprecated. Tests the chunked transfer hint for this entity.
boolean	isRepeatable()	Deprecated. Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().
void	produce(DataStreamChannel channel)	Deprecated. Triggered to signal the ability of the underlying data channel to accept more data.
protected abstract void	produceData(ContentType contentType, java.io.OutputStream outputStream)	Deprecated. Writes out entity data into the given stream.
void	releaseResources()	Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private final SharedOutputBuffer buffer

Deprecated.

contentType

private final ContentType contentType

Deprecated.

executor

private final java.util.concurrent.Executor executor

Deprecated.

state

private final java.util.concurrent.atomic.AtomicReference<AbstractClassicEntityProducer.State> state

Deprecated.

exception

private final java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exception

Deprecated.

Constructor Detail

AbstractClassicEntityProducer

public AbstractClassicEntityProducer(int initialBufferSize,
                                     ContentType contentType,
                                     java.util.concurrent.Executor executor)

Deprecated.

Method Detail

produceData

protected abstract void produceData(ContentType contentType,
                                    java.io.OutputStream outputStream)
                             throws java.io.IOException

Deprecated.

Writes out entity data into the given stream.

Parameters:

contentType - the entity content type

outputStream - the output stream

Throws:

java.io.IOException - in case of an I/O error.

isRepeatable

public final boolean isRepeatable()

Deprecated.

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()

Deprecated.

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.

Please note this method should return zero if the data producer is unable to produce any more data, in which case AsyncDataProducer.produce(DataStreamChannel) method will not get triggered. The producer can resume writing out data asynchronously once more data becomes available or request output readiness events with DataStreamChannel.requestOutput().

Specified by:

available in interface AsyncDataProducer

Returns:

the number of bytes immediately available for output

See Also:

AsyncDataProducer.produce(DataStreamChannel), DataStreamChannel.requestOutput()

produce

public final void produce(DataStreamChannel channel)
                   throws java.io.IOException

Deprecated.

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.

Please note this method gets triggered only if AsyncDataProducer.available() returns a positive value.

Specified by:

produce in interface AsyncDataProducer

Parameters:

channel - the data channel capable of accepting more data.

Throws:

java.io.IOException - in case of an I/O error.

See Also:

AsyncDataProducer.available()

getContentLength

public final long getContentLength()

Deprecated.

Description copied from interface: EntityDetails

Gets length of this entity, if known.

Specified by:

getContentLength in interface EntityDetails

Returns:

the length of this entity, may be 0.

getContentType

public final java.lang.String getContentType()

Deprecated.

Description copied from interface: EntityDetails

Gets content type of this entity, if known.

Specified by:

getContentType in interface EntityDetails

Returns:

the content type of this entity, may be null.

getContentEncoding

public java.lang.String getContentEncoding()

Deprecated.

Description copied from interface: EntityDetails

Gets content encoding of this entity, if known.

Specified by:

getContentEncoding in interface EntityDetails

Returns:

the content encoding of this entity, may be null.

isChunked

public final boolean isChunked()

Deprecated.

Description copied from interface: EntityDetails

Tests the 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

Returns:

the chunked transfer hint for this entity.

getTrailerNames

public final java.util.Set<java.lang.String> getTrailerNames()

Deprecated.

Description copied from interface: EntityDetails

Gets the preliminary declaration of trailing headers.

Specified by:

getTrailerNames in interface EntityDetails

Returns:

the preliminary declaration of trailing headers.

failed

public final void failed(java.lang.Exception cause)

Deprecated.

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 java.lang.Exception getException()

Deprecated.

releaseResources

public void releaseResources()

Deprecated.

Specified by:

releaseResources in interface ResourceHolder