com.github.robtimus.io.stream

Class CapturingInputStream

java.lang.Object

java.io.InputStream

com.github.robtimus.io.stream.CapturingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class CapturingInputStream
extends InputStream

An input stream that captures the content it reads. This can be useful for input streams that are handed over to other code, where it is unknown when the input stream is consumed. Using callbacks this class allows code to be executed when the stream has been fully consumed.

An example use for this class can be logging in an HTTP filter or HTTP client. Instead of copying the contents of an input stream to memory, logging the contents, and then passing a ByteArrayInputStream with the copied contents, you can create a capturing input stream with a callback that performs the logging.

CapturingInputStream supports mark(int) and reset() if its backing input stream does. When reset() is called, it will "uncapture" any contents up to the previous mark. It will still only once call any of the callbacks.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapturingInputStream.Config Configuration for capturing input streams.

Constructor Summary

Constructors

Constructor and Description
CapturingInputStream(InputStream input, CapturingInputStream.Config config) Creates a new capturing input stream.

Method Summary

Modifier and Type	Method and Description
byte[]	captured() Returns the contents that have been captured.
String	captured(Charset charset) Returns the contents that have been captured, as a string.
void	close()
static CapturingInputStream.Config.Builder	config() Creates a builder for capturing input stream configurations.
boolean	isClosed() Returns whether or not this input stream has been closed.
boolean	isConsumed() Returns whether or not this input stream has been fully consumed.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	totalBytes() Returns the total number of bytes that have been read.

Methods inherited from class java.io.InputStream

available, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

CapturingInputStream

public CapturingInputStream(InputStream input,
                            CapturingInputStream.Config config)

Creates a new capturing input stream.

Parameters:

input - The input stream to capture from.

config - The configuration to use.

Throws:

NullPointerException - If the given input stream or config is null.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

captured

public byte[] captured()

Returns the contents that have been captured.

Returns:

An array with the bytes that have been captured.

captured

public String captured(Charset charset)

Returns the contents that have been captured, as a string.

Parameters:

charset - The charset to use.

Returns:

A string representing the contents that have been captured.

totalBytes

public long totalBytes()

Returns the total number of bytes that have been read.

Returns:

The total number of bytes that have been read.

isConsumed

public boolean isConsumed()

Returns whether or not this input stream has been fully consumed. In other words, returns whether or not one of the read methods has been called and returned -1.

Returns:

true if this input stream has been fully consumed, or false otherwise.

isClosed

public boolean isClosed()

Returns whether or not this input stream has been closed.

Returns:

true if this input stream has been closed, or false otherwise.

config

public static CapturingInputStream.Config.Builder config()

Creates a builder for capturing input stream configurations.

Returns:

The created builder.