Top Description Fields Constructors Methods
org.apache.hc.core5.http.nio.support

public abstract Class AbstractServerExchangeHandler<T>

extends Object
implements AsyncServerExchangeHandler
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.http.nio.AsyncServerExchangeHandler, org.apache.hc.core5.http.nio.AsyncDataExchangeHandler, org.apache.hc.core5.http.nio.AsyncDataProducer, org.apache.hc.core5.http.nio.ResourceHolder, org.apache.hc.core5.http.nio.AsyncDataConsumer
Known Direct Subclasses
org.apache.hc.core5.http.nio.support.BasicServerExchangeHandler
Imports
java.io.IOException, java.nio.ByteBuffer, java.util.List, java.util.concurrent.atomic.AtomicReference, org.apache.hc.core5.concurrent.FutureCallback, org.apache.hc.core5.http.EntityDetails, .Header, .HttpException, .HttpRequest, .HttpResponse, .HttpStatus, org.apache.hc.core5.http.nio.AsyncPushProducer, .AsyncRequestConsumer, .AsyncResponseProducer, .AsyncServerExchangeHandler, .AsyncServerRequestHandler, .CapacityChannel, .DataStreamChannel, .ResponseChannel, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.util.Asserts
Abstract server side message exchange handler.
Since
5.0

Field Summary

Modifier and TypeField and Description
private final AtomicReference<AsyncRequestConsumer<T>>
requestConsumerRef

private final AtomicReference<AsyncResponseProducer>
responseProducerRef

Constructor Summary

AccessConstructor and Description
public
AbstractServerExchangeHandler()

Method Summary

Modifier and TypeMethod 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.
protected abstract void
handle(T
the request message.
requestMessage, AsyncServerRequestHandler.ResponseTrigger
the response trigger.
responseTrigger, HttpContext
the actual execution context.
context)

Triggered to handles the request object produced by the AsyncRequestConsumer returned from the supplyConsumer(HttpRequest, EntityDetails, HttpContext) method.

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 final 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.
protected abstract AsyncRequestConsumer<T>

Returns:

the request consumer.
supplyConsumer(HttpRequest
the request message.
request, EntityDetails
the request entity details.
entityDetails, HttpContext
the actual execution context.
context)

Triggered to supply a request consumer to process the incoming request.

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:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

requestConsumerRefback to summary
private final AtomicReference<AsyncRequestConsumer<T>> requestConsumerRef
responseProducerRefback to summary
private final AtomicReference<AsyncResponseProducer> responseProducerRef

Constructor Detail

AbstractServerExchangeHandlerback to summary
public AbstractServerExchangeHandler()

Method Detail

availableback 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
consumeback 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
failedback 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
handleback to summary
protected abstract void handle(T requestMessage, AsyncServerRequestHandler.ResponseTrigger responseTrigger, HttpContext context) throws HttpException, IOException

Triggered to handles the request object produced by the AsyncRequestConsumer returned from the supplyConsumer(HttpRequest, EntityDetails, HttpContext) method. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.

Parameters
requestMessage:T

the request message.

responseTrigger:AsyncServerRequestHandler.ResponseTrigger

the response trigger.

context:HttpContext

the actual execution context.

handleRequestback 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
produceback 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
releaseResourcesback to summary
public final void releaseResources()

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

Annotations
@Override
streamEndback 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
supplyConsumerback to summary
protected abstract AsyncRequestConsumer<T> supplyConsumer(HttpRequest request, EntityDetails entityDetails, HttpContext context) throws HttpException

Triggered to supply a request consumer to process the incoming request.

Parameters
request:HttpRequest

the request message.

entityDetails:EntityDetails

the request entity details.

context:HttpContext

the actual execution context.

Returns:AsyncRequestConsumer<T>

the request consumer.

updateCapacityback 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