org.everit.http.client.async

Class AutoCloseAsyncContentProvider

java.lang.Object

org.everit.http.client.async.AutoCloseAsyncContentProvider

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncContentProvider

public class AutoCloseAsyncContentProvider
extends Object
implements AsyncContentProvider

A wrapper around another AsyncContentProviders that closes the provider instance and the optionally specified additional Closeable objects when the reading from the provider is completed. Completion means either AsyncContentProvider.onSuccess(Runnable) or AsyncContentProvider.onError(java.util.function.Consumer) execution.

Please note that if there an exception during closing the provider in onSuccess, an ClosingProviderAutomaticallyException is received by the onError listener that the programmer might only want to log as the success and its listener ran successfully.

In case an exception is thrown during closing the provider and other resources in the onError listener, it is only logged out.

Constructor Summary

Constructors

Constructor and Description
AutoCloseAsyncContentProvider(AsyncContentProvider wrapped, Closeable... additionalCloseables) Constructor.

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 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCloseAsyncContentProvider

public AutoCloseAsyncContentProvider(AsyncContentProvider wrapped,
                                     Closeable... additionalCloseables)

Constructor.

Parameters:

wrapped - The instance of this wrapper copies the functionality of the wrapped provider and in the end of process (success or fail) closes the wrapped provider automatically.

additionalCloseables - Zero or more additional objects that implement Closeable interface and that should be closed in the end of processing the data of the wrapped provider (fail or success). In case of calling close() on the AutoCloseAsyncContentProvider also closes all passed additiona closeable objects.

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

getContentLength

public Optional<Long> getContentLength()

Description copied from interface: AsyncContentProvider

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

Specified by:

getContentLength in interface AsyncContentProvider

getContentType

public Optional<MediaType> getContentType()

Description copied from interface: AsyncContentProvider

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

Specified by:

getContentType in interface AsyncContentProvider

getFailure

public 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

isClosed

public boolean isClosed()

Description copied from interface: AsyncContentProvider

Returns whether this provider is closed or not.

Specified by:

isClosed in interface AsyncContentProvider

onContent

public 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 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 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.