Package com.nimbusds.jose.util

Class BoundedInputStream

java.lang.Object

java.io.InputStream

com.nimbusds.jose.util.BoundedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BoundedInputStream
extends InputStream

Size-bounded input stream. Adapted from Apache Commons IO. Throws an IOException if the input size limit is exceeded.

Version:

2016-11-28

Constructor Summary

Constructors

Constructor	Description
BoundedInputStream(InputStream in)	Creates a new unbounded input stream.
BoundedInputStream(InputStream in, long size)	Creates a new bounded input stream.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
long	getLimitBytes()	Returns the maximum number of bytes to return.
boolean	isPropagateClose()	Indicates whether the close() method should propagate to the underling InputStream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
void	setPropagateClose(boolean propagateClose)	Set whether the close() method should propagate to the underling InputStream.
long	skip(long n)
String	toString()

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

BoundedInputStream

public BoundedInputStream(InputStream in,
 long size)

Creates a new bounded input stream.

Parameters:

in - The input stream to wrap.

size - The maximum number of bytes to return, -1 if no limit.

BoundedInputStream

public BoundedInputStream(InputStream in)

Creates a new unbounded input stream.

Parameters:

in - The input stream to wrap.

Method Details

getLimitBytes

public long getLimitBytes()

Returns the maximum number of bytes to return.

Returns:

The maximum number of bytes to return, -1 if no limit.

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

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

isPropagateClose

public boolean isPropagateClose()

Indicates whether the close() method should propagate to the underling InputStream.

Returns:

true if calling close() propagates to the close() method of the underlying stream or false if it does not.

setPropagateClose

public void setPropagateClose(boolean propagateClose)

Set whether the close() method should propagate to the underling InputStream.

Parameters:

propagateClose - true if calling close() propagates to the close() method of the underlying stream or false if it does not.