org.bouncycastle.openpgp.api

Class DoubleBufferedInputStream<I extends java.io.InputStream>

java.lang.Object

java.io.InputStream

org.bouncycastle.openpgp.api.DoubleBufferedInputStream<I>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DoubleBufferedInputStream<I extends java.io.InputStream>
extends java.io.InputStream

Implementation of an InputStream that double-buffers data from an underlying input stream. Upon reaching the end of the underlying data stream, the underlying data stream is automatically closed. Any exceptions while reading from the underlying input stream cause the DoubleBufferedInputStream to withhold pending data. This is done in order to minimize the risk of emitting unauthenticated plaintext, while at the same time being somewhat resource-efficient. The minimum number of bytes to withhold can be configured (BUFFER_SIZE by default).

Constructor Summary

Constructors

Constructor and Description
DoubleBufferedInputStream(I in) Create a DoubleBufferedInputStream, which buffers twice 32MiB.
DoubleBufferedInputStream(I in, int bufferSize) Create a DoubleBufferedInputStream, which buffers twice the given buffer size in bytes.

Method Summary

Modifier and Type	Method and Description
void	close()
I	getInputStream() Return the underlying InputStream.
int	read()
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleBufferedInputStream

public DoubleBufferedInputStream(I in)

Create a DoubleBufferedInputStream, which buffers twice 32MiB.

Parameters:

in - input stream

DoubleBufferedInputStream

public DoubleBufferedInputStream(I in,
                                 int bufferSize)

Create a DoubleBufferedInputStream, which buffers twice the given buffer size in bytes.

Parameters:

in - input stream

bufferSize - buffer size

Method Detail

getInputStream

public I getInputStream()

Return the underlying InputStream.

Returns:

underlying input stream

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException