public class DeferredContentProvider extends Object implements AsyncContentProvider, Callback, Closeable
ContentProvider that allows to add content after Request.send(Response.CompleteListener)
has been called, therefore providing the request content at a later time.
DeferredContentProvider can only be used in conjunction with
Request.send(Response.CompleteListener) (and not with its blocking counterpart Request.send())
because it provides content asynchronously.
The deferred content is provided once and then fully consumed.
Invocations to the iterator() method after the first will return an "empty" iterator
because the stream has been consumed on the first invocation.
However, it is possible for subclasses to override offer(ByteBuffer) and close() to copy
the content to another location (for example a file) and be able to support multiple invocations
of of iterator() returning the iterator provided by this
class on the first invocation, and an iterator on the bytes copied to the other location
for subsequent invocations.
Typical usage of DeferredContentProvider is in asynchronous proxies, where HTTP headers arrive
separately from HTTP content chunks.
The deferred content must be provided through offer(ByteBuffer), which can be invoked multiple
times, and when all content has been provided it must be signaled with a call to close().
Example usage:
HttpClient httpClient = ...;
// Use try-with-resources to autoclose DeferredContentProvider
try (DeferredContentProvider content = new DeferredContentProvider())
{
httpClient.newRequest("localhost", 8080)
.content(content)
.send(new Response.CompleteListener()
{
@Override
public void onComplete(Result result)
{
// Your logic here
}
});
// At a later time...
content.offer(ByteBuffer.wrap("some content".getBytes()));
}
| Modifier and Type | Class and Description |
|---|---|
static class |
DeferredContentProvider.Chunk |
AsyncContentProvider.ListenerContentProvider.TypedCallback.Adapter| Constructor and Description |
|---|
DeferredContentProvider(ByteBuffer... buffers)
Creates a new
DeferredContentProvider with the given initial content |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
No more content will be added to this content provider
and notifies the listener that no more content is available.
|
void |
failed(Throwable failure) |
void |
flush() |
long |
getLength() |
boolean |
isClosed() |
Iterator<ByteBuffer> |
iterator() |
boolean |
offer(ByteBuffer buffer)
Adds the given content buffer to this content provider
and notifies the listener that content is available.
|
boolean |
offer(ByteBuffer buffer,
Callback callback) |
void |
setListener(AsyncContentProvider.Listener listener) |
void |
succeeded() |
public DeferredContentProvider(ByteBuffer... buffers)
DeferredContentProvider with the given initial contentbuffers - the initial contentpublic void setListener(AsyncContentProvider.Listener listener)
setListener in interface AsyncContentProviderlistener - the listener to be notified of content availabilitypublic long getLength()
getLength in interface ContentProviderpublic boolean offer(ByteBuffer buffer)
buffer - the content to addpublic boolean offer(ByteBuffer buffer, Callback callback)
public void flush()
throws IOException
IOExceptionpublic void close()
close in interface Closeableclose in interface AutoCloseablepublic boolean isClosed()
public Iterator<ByteBuffer> iterator()
iterator in interface Iterable<ByteBuffer>Copyright © 1995-2017 Webtide. All Rights Reserved.