org.everit.http.client.async

Interface AsyncContentProvider

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractAsyncContentProvider, AutoCloseAsyncContentProvider, ByteArrayAsyncContentProvider, ConcatenatedAsyncContentProvider, FormUrlencodedAsyncContentProvider, InputStreamAsyncContentProvider, MultiPartAsyncContentProvider, ReadableByteChannelAsyncContentProvider

public interface AsyncContentProvider
extends Closeable

Provides content asynchronously. See the functions of AsyncContentUtil to create standard providers.

Method Summary

Modifier and Type	Method and Description
void	close() Closing the content provider.
Optional<Long>	getContentLength() The size of the data that is provided or Optional.empty() if the length is unknown in advance.
Optional<MediaType>	getContentType() The media type of the content or Optional.empty() if the media type is unknown.
Optional<Throwable>	getFailure() Returns the error that has happened during processing the content of this provider or Optional.empty() if there was no failure.
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 onContent(AsyncContentListener) or onSuccess(Runnable) functions.
AsyncContentProvider	onSuccess(Runnable action) Registering an action that will be called when all of the chunks are delivered.

Method Detail

close

void close()

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getContentLength

Optional<Long> getContentLength()

The size of the data that is provided or Optional.empty() if the length is unknown in advance.

getContentType

Optional<MediaType> getContentType()

The media type of the content or Optional.empty() if the media type is unknown.

getFailure

Optional<Throwable> getFailure()

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

isClosed

boolean isClosed()

Returns whether this provider is closed or not.

onContent

AsyncContentProvider onContent(AsyncContentListener listener)

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

Parameters:

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

Returns:

The current AsyncContentProvider.

onError

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 onContent(AsyncContentListener) or onSuccess(Runnable) functions.

Parameters:

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

Returns:

The current AsyncContentProvider.

onSuccess

AsyncContentProvider onSuccess(Runnable action)

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 onError(Consumer) is called with that exception.

Parameters:

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

Returns:

The current AsyncContentProvider.