org.everit.http.client.async

Class AbstractAsyncContentProvider

java.lang.Object

org.everit.http.client.async.AbstractAsyncContentProvider

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncContentProvider

Direct Known Subclasses:

ByteArrayAsyncContentProvider, ConcatenatedAsyncContentProvider, InputStreamAsyncContentProvider, ReadableByteChannelAsyncContentProvider

public abstract class AbstractAsyncContentProvider
extends Object
implements AsyncContentProvider

Helper class that makes it easier to implement Async content providers by having the complete and error handling functionality. Subclasses of this class should call handleErrorFromInput(Throwable) in case an error happened during reading from the dataSource and call handleSuccess() when the end of the stream is reached successfully.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractAsyncContentProvider.OnlyProcessedHandlingAsyncContentListener Helper interface to ease the implementation of an AsyncContentProvider.

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncContentProvider()

Method Summary

Modifier and Type	Method and Description
void	close() Closing the content provider.
protected abstract void	doClose()
Optional<Throwable>	getFailure() Returns the error that has happened during processing the content of this provider or Optional.empty() if there was no failure.
protected void	handleErrorFromInput(Throwable failure)
protected void	handleSuccess()
boolean	isClosed() Returns whether this provider is closed or not.
AsyncContentProvider	onContent(AsyncContentListener listener) Registering a listener that will be notified if new content is available.
AsyncContentProvider	onError(Consumer<Throwable> action) Registering a listener that is called if there is an error delivering the data or processing of the data is failed either via AsyncCallback.failed(Throwable) call or via an error during calling the registered listener of AsyncContentProvider.onContent(AsyncContentListener) or AsyncContentProvider.onSuccess(Runnable) functions.
AsyncContentProvider	onSuccess(Runnable action) Registering an action that will be called when all of the chunks are delivered.
protected abstract void	provideNextChunk(Consumer<ByteBuffer> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.everit.http.client.async.AsyncContentProvider

getContentLength, getContentType

Constructor Detail

AbstractAsyncContentProvider

public AbstractAsyncContentProvider()

Method Detail

close

public void close()

Description copied from interface: AsyncContentProvider

Closing the content provider. If already closed, nothing happens.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AsyncContentProvider

doClose

protected abstract void doClose()

getFailure

public final Optional<Throwable> getFailure()

Description copied from interface: AsyncContentProvider

Returns the error that has happened during processing the content of this provider or Optional.empty() if there was no failure.

Specified by:

getFailure in interface AsyncContentProvider

handleErrorFromInput

protected void handleErrorFromInput(Throwable failure)

handleSuccess

protected void handleSuccess()

isClosed

public final boolean isClosed()

Description copied from interface: AsyncContentProvider

Returns whether this provider is closed or not.

Specified by:

isClosed in interface AsyncContentProvider

onContent

public final AsyncContentProvider onContent(AsyncContentListener listener)

Description copied from interface: AsyncContentProvider

Registering a listener that will be notified if new content is available.

Specified by:

onContent in interface AsyncContentProvider

Parameters:

listener - The listener that is called when new data chunk is available.

Returns:

The current AsyncContentProvider.

onError

public final AsyncContentProvider onError(Consumer<Throwable> action)

Description copied from interface: AsyncContentProvider

Registering a listener that is called if there is an error delivering the data or processing of the data is failed either via AsyncCallback.failed(Throwable) call or via an error during calling the registered listener of AsyncContentProvider.onContent(AsyncContentListener) or AsyncContentProvider.onSuccess(Runnable) functions.

Specified by:

onError in interface AsyncContentProvider

Parameters:

action - The action that must be executed if there is an error.

Returns:

The current AsyncContentProvider.

onSuccess

public final AsyncContentProvider onSuccess(Runnable action)

Description copied from interface: AsyncContentProvider

Registering an action that will be called when all of the chunks are delivered. In case of error, this method is not called. If the action throws an error, the listener registered via AsyncContentProvider.onError(Consumer) is called with that exception.

Specified by:

onSuccess in interface AsyncContentProvider

Parameters:

action - The action that is called when all of the data chunks are delivered.

Returns:

The current AsyncContentProvider.

provideNextChunk

protected abstract void provideNextChunk(Consumer<ByteBuffer> callback)