Class BasicResponseProducer
- java.lang.Object
-
- org.apache.hc.core5.http.nio.support.BasicResponseProducer
-
- All Implemented Interfaces:
AsyncDataProducer
,AsyncResponseProducer
,ResourceHolder
public class BasicResponseProducer extends java.lang.Object implements AsyncResponseProducer
Basic implementation ofAsyncResponseProducer
that produces one fixed response and relies on aAsyncEntityProducer
to generate response entity stream.- Since:
- 5.0
-
-
Field Summary
Fields Modifier and Type Field Description private AsyncEntityProducer
dataProducer
private HttpResponse
response
-
Constructor Summary
Constructors Constructor Description BasicResponseProducer(int code, java.lang.String message)
BasicResponseProducer(int code, java.lang.String message, ContentType contentType)
BasicResponseProducer(int code, AsyncEntityProducer dataProducer)
BasicResponseProducer(HttpResponse response)
BasicResponseProducer(HttpResponse response, java.lang.String message)
BasicResponseProducer(HttpResponse response, java.lang.String message, ContentType contentType)
BasicResponseProducer(HttpResponse response, AsyncEntityProducer dataProducer)
BasicResponseProducer(AsyncEntityProducer dataProducer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
available()
Returns the number of bytes immediately available for output.void
failed(java.lang.Exception cause)
Triggered to signal a failure in data generation.void
produce(DataStreamChannel channel)
Triggered to signal the ability of the underlying data channel to accept more data.void
releaseResources()
void
sendResponse(ResponseChannel responseChannel, HttpContext httpContext)
Triggered to signal the ability of the underlying response channel to accept response messages.
-
-
-
Field Detail
-
response
private final HttpResponse response
-
dataProducer
private final AsyncEntityProducer dataProducer
-
-
Constructor Detail
-
BasicResponseProducer
public BasicResponseProducer(HttpResponse response, AsyncEntityProducer dataProducer)
-
BasicResponseProducer
public BasicResponseProducer(HttpResponse response)
-
BasicResponseProducer
public BasicResponseProducer(int code, AsyncEntityProducer dataProducer)
-
BasicResponseProducer
public BasicResponseProducer(HttpResponse response, java.lang.String message, ContentType contentType)
-
BasicResponseProducer
public BasicResponseProducer(HttpResponse response, java.lang.String message)
-
BasicResponseProducer
public BasicResponseProducer(int code, java.lang.String message, ContentType contentType)
-
BasicResponseProducer
public BasicResponseProducer(int code, java.lang.String message)
-
BasicResponseProducer
public BasicResponseProducer(AsyncEntityProducer dataProducer)
-
-
Method Detail
-
sendResponse
public void sendResponse(ResponseChannel responseChannel, HttpContext httpContext) throws HttpException, java.io.IOException
Description copied from interface:AsyncResponseProducer
Triggered to signal the ability of the underlying response channel to accept response messages. The data producer can choose to send response messages immediately inside the call or asynchronously at some later point.- Specified by:
sendResponse
in interfaceAsyncResponseProducer
- Parameters:
responseChannel
- the response channel capable to accepting response messages.httpContext
- the actual execution context.- Throws:
HttpException
java.io.IOException
-
available
public 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 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 void failed(java.lang.Exception cause)
Description copied from interface:AsyncResponseProducer
Triggered to signal a failure in data generation.- Specified by:
failed
in interfaceAsyncResponseProducer
- Parameters:
cause
- the cause of the failure.
-
releaseResources
public void releaseResources()
- Specified by:
releaseResources
in interfaceResourceHolder
-
-