Class InputStreamContentProvider

java.lang.Object

org.eclipse.jetty.client.util.InputStreamContentProvider

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ByteBuffer>, ContentProvider, Callback, Invocable

public class InputStreamContentProvider
extends Object
implements ContentProvider, Callback, Closeable

A ContentProvider for an InputStream.

The input stream is read once and therefore 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 onRead(byte[], int, int) to copy the content read from the stream to another location (for example a file), and be able to support multiple invocations 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.

It is possible to specify, at the constructor, a buffer size used to read content from the stream, by default 4096 bytes.

The InputStream passed to the constructor is by default closed when is it fully consumed (or when an exception is thrown while reading it), unless otherwise specified to the constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	InputStreamContentProvider.InputStreamContentProviderIterator	Iterating over an InputStream is tricky, because InputStreamContentProvider.InputStreamContentProviderIterator.hasNext() must return false if the stream reads -1.

Nested classes/interfaces inherited from interface Callback

Callback.Completable, Callback.Completing, Callback.InvocableCallback, Callback.Nested

Nested classes/interfaces inherited from interface ContentProvider

ContentProvider.Typed

Nested classes/interfaces inherited from interface Invocable

Invocable.InvocationType

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	autoClose
private final int	bufferSize
private final InputStreamContentProvider.InputStreamContentProviderIterator	iterator
private static final Logger	LOG
private final InputStream	stream

Fields inherited from interface Callback

NOOP

Fields inherited from interface Invocable

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
InputStreamContentProvider(InputStream stream)
InputStreamContentProvider(InputStream stream, int bufferSize)
InputStreamContentProvider(InputStream stream, int bufferSize, boolean autoClose)

Method Summary

Modifier and Type	Method	Description
void	close()
void	failed(Throwable failure)	Callback invoked when the operation fails.
long	getLength()
Iterator<ByteBuffer>	iterator()
protected ByteBuffer	onRead(byte[] buffer, int offset, int length)	Callback method invoked just after having read from the stream, but before returning the iteration element (a ByteBuffer to the caller.
protected void	onReadFailure(Throwable failure)	Callback method invoked when an exception is thrown while reading from the stream.

Methods inherited from class Object

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

Methods inherited from interface Callback

succeeded

Methods inherited from interface ContentProvider

isReproducible

Methods inherited from interface Invocable

getInvocationType

Methods inherited from interface Iterable

forEach, spliterator

Field Details

LOG

private static final Logger LOG

iterator

private final InputStreamContentProvider.InputStreamContentProviderIterator iterator

stream

private final InputStream stream

bufferSize

private final int bufferSize

autoClose

private final boolean autoClose

Constructor Details

InputStreamContentProvider

public InputStreamContentProvider(InputStream stream)

InputStreamContentProvider

public InputStreamContentProvider(InputStream stream,
 int bufferSize)

InputStreamContentProvider

public InputStreamContentProvider(InputStream stream,
 int bufferSize,
 boolean autoClose)

Method Details

getLength

public long getLength()

Specified by:

getLength in interface ContentProvider

Returns:

the content length, if known, or -1 if the content length is unknown

onRead

protected ByteBuffer onRead(byte[] buffer,
 int offset,
 int length)

Callback method invoked just after having read from the stream, but before returning the iteration element (a ByteBuffer to the caller.

Subclasses may override this method to copy the content read from the stream to another location (a file, or in memory if the content is known to fit).

Parameters:

buffer - the byte array containing the bytes read

offset - the offset from where bytes should be read

length - the length of the bytes read

Returns:

a ByteBuffer wrapping the byte array

onReadFailure

protected void onReadFailure(Throwable failure)

Callback method invoked when an exception is thrown while reading from the stream.

Parameters:

failure - the exception thrown while reading from the stream.

iterator

public Iterator<ByteBuffer> iterator()

Specified by:

iterator in interface Iterable<ByteBuffer>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

failed

public void failed(Throwable failure)

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback

Parameters:

failure - the reason for the operation failure