Modifier and Type	Class and Description
private static enum	AbstractClassicServerExchangeHandler.State

Modifier and Type	Field and Description
private final AtomicReference<Exception>	exception
private final Executor	executor
private final int	initialBufferSize
private volatile SharedInputBuffer	inputBuffer
private volatile SharedOutputBuffer	outputBuffer
private final AtomicReference<AbstractClassicServerExchangeHandler.State>	state

Access	Constructor and Description
public	AbstractClassicServerExchangeHandler(final int initialBufferSize, final Executor executor)

Method Summary

Modifier and Type	Method and Description
public final int	available() Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available. Returns the number of bytes immediately available for output.
public final void	consume(final ByteBuffer data source. src) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. Triggered to pass incoming data to the data consumer.
public final void	failed(final Exception the cause of the failure. cause) Implements org.apache.hc.core5.http.nio.AsyncDataExchangeHandler.failed. Triggered to signal a failure in data processing.
public Exception	getException()
protected abstract void	handle(HttpRequest the incoming request request, InputStream the request stream if the request encloses an entity, `null` otherwise. requestStream, HttpResponse the outgoing response. response, OutputStream the response entity output stream. responseStream, HttpContext the actual execution context. context) Handles an incoming request optionally reading its entity content form the given input stream and generates a response optionally writing out its entity content into the given output stream.
public final void	handleRequest(final HttpRequest the actual request. request, final EntityDetails the request entity details or `null` if the request does not enclose an entity. entityDetails, final ResponseChannel the response channel. responseChannel, final HttpContext the actual execution context. context) Implements org.apache.hc.core5.http.nio.AsyncServerExchangeHandler.handleRequest. Processes the actual HTTP request.
public final void	produce(final DataStreamChannel the data channel capable to accepting more data. channel) Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce. Triggered to signal the ability of the underlying data channel to accept more data.
public void	releaseResources() Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources.
public final void	streamEnd(final List<? extends Header> data stream trailers. trailers) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Triggered to signal termination of the data stream.
public final void	updateCapacity(final CapacityChannel the channel for capacity updates. capacityChannel) Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. Triggered to signal ability of the underlying data stream to receive data capacity update.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

exception	back to summary
private final AtomicReference<Exception> exception

executor	back to summary
private final Executor executor

initialBufferSize	back to summary
private final int initialBufferSize

inputBuffer	back to summary
private volatile SharedInputBuffer inputBuffer

outputBuffer	back to summary
private volatile SharedOutputBuffer outputBuffer

state	back to summary
private final AtomicReference<AbstractClassicServerExchangeHandler.State> state

Constructor Detail

AbstractClassicServerExchangeHandler	back to summary
public AbstractClassicServerExchangeHandler(final int initialBufferSize, final Executor executor)

Method Detail

available	back to summary
public final int available() Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available. Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.available. 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. Returns:int the number of bytes immediately available for output Annotations @Override

available

back to summary

public final int available()

Implements org.apache.hc.core5.http.nio.AsyncDataProducer.available.

Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.available.

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.

Returns:int

the number of bytes immediately available for output

Annotations

@Override

consume	back to summary
public final void consume(final ByteBuffer src) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume. Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel. Parameters src:ByteBuffer data source. Annotations @Override

consume

back to summary

public final void consume(final ByteBuffer src) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.consume.

Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.

Parameters

src:ByteBuffer: data source.

Annotations

@Override

failed	back to summary
public final void failed(final Exception cause) Implements org.apache.hc.core5.http.nio.AsyncDataExchangeHandler.failed. Doc from org.apache.hc.core5.http.nio.AsyncDataExchangeHandler.failed. Triggered to signal a failure in data processing. Parameters cause:Exception the cause of the failure. Annotations @Override

failed

back to summary

public final void failed(final Exception cause)

Implements org.apache.hc.core5.http.nio.AsyncDataExchangeHandler.failed.

Doc from org.apache.hc.core5.http.nio.AsyncDataExchangeHandler.failed.

Triggered to signal a failure in data processing.

Parameters

cause:Exception: the cause of the failure.

Annotations

@Override

getException	back to summary
public Exception getException()

handle back to summary

handle	back to summary
protected abstract void handle(HttpRequest request, InputStream requestStream, HttpResponse response, OutputStream responseStream, HttpContext context) throws IOException, HttpException Handles an incoming request optionally reading its entity content form the given input stream and generates a response optionally writing out its entity content into the given output stream. Parameters request:HttpRequest the incoming request requestStream:InputStream the request stream if the request encloses an entity, `null` otherwise. response:HttpResponse the outgoing response. responseStream:OutputStream the response entity output stream. context:HttpContext the actual execution context.

protected abstract void handle(HttpRequest request, InputStream requestStream, HttpResponse response, OutputStream responseStream, HttpContext context) throws IOException, HttpException

Handles an incoming request optionally reading its entity content form the given input stream and generates a response optionally writing out its entity content into the given output stream.

Parameters

request:HttpRequest: the incoming request
requestStream:InputStream: the request stream if the request encloses an entity, null otherwise.
response:HttpResponse: the outgoing response.
responseStream:OutputStream: the response entity output stream.
context:HttpContext: the actual execution context.

handleRequest back to summary

handleRequest	back to summary
public final void handleRequest(final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException Implements org.apache.hc.core5.http.nio.AsyncServerExchangeHandler.handleRequest. Doc from org.apache.hc.core5.http.nio.AsyncServerExchangeHandler.handleRequest. Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point. Parameters request:HttpRequest the actual request. entityDetails:EntityDetails the request entity details or `null` if the request does not enclose an entity. responseChannel:ResponseChannel the response channel. context:HttpContext the actual execution context. Annotations @Override

public final void handleRequest(final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncServerExchangeHandler.handleRequest.

Doc from org.apache.hc.core5.http.nio.AsyncServerExchangeHandler.handleRequest.

Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.

Parameters

request:HttpRequest: the actual request.
entityDetails:EntityDetails: the request entity details or null if the request does not enclose an entity.
responseChannel:ResponseChannel: the response channel.
context:HttpContext: the actual execution context.

Annotations

@Override

produce	back to summary
public final void produce(final DataStreamChannel channel) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce. Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.produce. 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. Parameters channel:DataStreamChannel the data channel capable to accepting more data. Annotations @Override

produce

back to summary

public final void produce(final DataStreamChannel channel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataProducer.produce.

Doc from org.apache.hc.core5.http.nio.AsyncDataProducer.produce.

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.

Parameters

channel:DataStreamChannel: the data channel capable to accepting more data.

Annotations

@Override

releaseResources	back to summary
public void releaseResources() Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources. Annotations @Override

releaseResources

back to summary

public void releaseResources()

Implements org.apache.hc.core5.http.nio.ResourceHolder.releaseResources.

Annotations

@Override

streamEnd	back to summary
public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd. Triggered to signal termination of the data stream. Parameters trailers:List<? extends Header> data stream trailers. Annotations @Override

streamEnd

back to summary

public final void streamEnd(final List<? extends Header> trailers) throws HttpException, IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.streamEnd.

Triggered to signal termination of the data stream.

Parameters

trailers:List<? extends Header>: data stream trailers.

Annotations

@Override

updateCapacity	back to summary
public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity. Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point. Parameters capacityChannel:CapacityChannel the channel for capacity updates. Annotations @Override

updateCapacity

back to summary

public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException

Implements org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Doc from org.apache.hc.core5.http.nio.AsyncDataConsumer.updateCapacity.

Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.

Parameters

capacityChannel:CapacityChannel: the channel for capacity updates.

Annotations

@Override

org.apache.hc.core5.http.nio.support.classic back to summary

private final Enum AbstractClassicServerExchangeHandler.State

Class Inheritance

extends Enum<AbstractClassicServerExchangeHandler.State>

java.lang.Object
java.lang.Enum
org.apache.hc.core5.http.nio.support.classic.AbstractClassicServerExchangeHandler.State

Field Summary

Modifier and Type	Field and Description
public static final AbstractClassicServerExchangeHandler.State	ACTIVE
public static final AbstractClassicServerExchangeHandler.State	COMPLETED
public static final AbstractClassicServerExchangeHandler.State	IDLE

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractClassicServerExchangeHandler.State	valueOf(String name)
public static AbstractClassicServerExchangeHandler.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ACTIVE	back to summary
public static final AbstractClassicServerExchangeHandler.State ACTIVE

COMPLETED	back to summary
public static final AbstractClassicServerExchangeHandler.State COMPLETED

IDLE	back to summary
public static final AbstractClassicServerExchangeHandler.State IDLE

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static AbstractClassicServerExchangeHandler.State valueOf(String name)

values	back to summary
public static AbstractClassicServerExchangeHandler.State[] values()

public abstract Class AbstractClassicServerExchangeHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum AbstractClassicServerExchangeHandler.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail