Class AbstractClassicServerExchangeHandler
- java.lang.Object
-
- org.apache.hc.core5.http.nio.support.classic.AbstractClassicServerExchangeHandler
-
- All Implemented Interfaces:
AsyncDataConsumer
,AsyncDataExchangeHandler
,AsyncDataProducer
,AsyncServerExchangeHandler
,ResourceHolder
public abstract class AbstractClassicServerExchangeHandler extends java.lang.Object implements AsyncServerExchangeHandler
AsyncServerExchangeHandler
implementation that acts as a compatibility layer for classicInputStream
/OutputStream
based interfaces. Blocking input / output processing is executed through anExecutor
.- Since:
- 5.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
AbstractClassicServerExchangeHandler.State
-
Field Summary
Fields Modifier and Type Field Description private java.util.concurrent.atomic.AtomicReference<java.lang.Exception>
exception
private java.util.concurrent.Executor
executor
private int
initialBufferSize
private SharedInputBuffer
inputBuffer
private SharedOutputBuffer
outputBuffer
private java.util.concurrent.atomic.AtomicReference<AbstractClassicServerExchangeHandler.State>
state
-
Constructor Summary
Constructors Constructor Description AbstractClassicServerExchangeHandler(int initialBufferSize, 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
consume(java.nio.ByteBuffer src)
Triggered to pass incoming data to the data consumer.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data processing.java.lang.Exception
getException()
protected abstract void
handle(HttpRequest request, java.io.InputStream requestStream, HttpResponse response, java.io.OutputStream responseStream, HttpContext 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.void
handleRequest(HttpRequest request, EntityDetails entityDetails, ResponseChannel responseChannel, HttpContext context)
Processes the actual HTTP request.void
produce(DataStreamChannel channel)
Triggered to signal the ability of the underlying data channel to accept more data.void
releaseResources()
void
streamEnd(java.util.List<? extends Header> trailers)
Triggered to signal termination of the data stream.void
updateCapacity(CapacityChannel capacityChannel)
Triggered to signal ability of the underlying data stream to receive data capacity update.
-
-
-
Field Detail
-
initialBufferSize
private final int initialBufferSize
-
executor
private final java.util.concurrent.Executor executor
-
state
private final java.util.concurrent.atomic.AtomicReference<AbstractClassicServerExchangeHandler.State> state
-
exception
private final java.util.concurrent.atomic.AtomicReference<java.lang.Exception> exception
-
inputBuffer
private volatile SharedInputBuffer inputBuffer
-
outputBuffer
private volatile SharedOutputBuffer outputBuffer
-
-
Method Detail
-
handle
protected abstract void handle(HttpRequest request, java.io.InputStream requestStream, HttpResponse response, java.io.OutputStream responseStream, HttpContext context) throws java.io.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
- the incoming requestrequestStream
- the request stream if the request encloses an entity,null
otherwise.response
- the outgoing response.responseStream
- the response entity output stream.context
- the actual execution context.- Throws:
java.io.IOException
HttpException
-
getException
public java.lang.Exception getException()
-
handleRequest
public final void handleRequest(HttpRequest request, EntityDetails entityDetails, ResponseChannel responseChannel, HttpContext context) throws HttpException, java.io.IOException
Description copied from interface:AsyncServerExchangeHandler
Processes the actual HTTP request. The handler can choose to send response messages immediately inside the call or asynchronously at some later point.- Specified by:
handleRequest
in interfaceAsyncServerExchangeHandler
- Parameters:
request
- the actual request.entityDetails
- the request entity details ornull
if the request does not enclose an entity.responseChannel
- the response channel.context
- the actual execution context.- Throws:
HttpException
java.io.IOException
-
updateCapacity
public final void updateCapacity(CapacityChannel capacityChannel) throws java.io.IOException
Description copied from interface:AsyncDataConsumer
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.- Specified by:
updateCapacity
in interfaceAsyncDataConsumer
- Parameters:
capacityChannel
- the channel for capacity updates.- Throws:
java.io.IOException
-
consume
public final void consume(java.nio.ByteBuffer src) throws java.io.IOException
Description copied from interface:AsyncDataConsumer
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.- Specified by:
consume
in interfaceAsyncDataConsumer
- Parameters:
src
- data source.- Throws:
java.io.IOException
-
streamEnd
public final void streamEnd(java.util.List<? extends Header> trailers) throws HttpException, java.io.IOException
Description copied from interface:AsyncDataConsumer
Triggered to signal termination of the data stream.- Specified by:
streamEnd
in interfaceAsyncDataConsumer
- Parameters:
trailers
- data stream trailers.- Throws:
HttpException
java.io.IOException
-
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
-
failed
public final void failed(java.lang.Exception cause)
Description copied from interface:AsyncDataExchangeHandler
Triggered to signal a failure in data processing.- Specified by:
failed
in interfaceAsyncDataExchangeHandler
- Parameters:
cause
- the cause of the failure.
-
releaseResources
public void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
-