org.apache.jackrabbit.server.io
Class BoundedInputStream

java.lang.Object
  java.io.InputStream
      org.apache.jackrabbit.server.io.BoundedInputStream

All Implemented Interfaces:

java.io.Closeable

public class BoundedInputStream
extends java.io.InputStream

This is a stream that will only supply bytes up to a certain length - if its position goes above that, it will stop.

This is useful to wrap ServletInputStreams. The ServletInputStream will block if you try to read content from it that isn't there, because it doesn't know whether the content hasn't arrived yet or whether the content has finished. So, one of these, initialized with the Content-length sent in the ServletInputStream's header, will stop it blocking, providing it's been sent with a correct content length.

Author:

InigoSurguy

Constructor Summary

BoundedInputStream(java.io.InputStream in)

BoundedInputStream(java.io.InputStream in, long size)
Creates a new BoundedInputStream that wraps the given input stream and limits it to a certain size.

Method Summary

int	available()
void	close()
boolean	isPropagateClose()
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)
long	skip(long n)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedInputStream

public BoundedInputStream(java.io.InputStream in,
                          long size)

Creates a new BoundedInputStream that wraps the given input stream and limits it to a certain size.

Parameters:

in - The wrapped input stream

size - The maximum number of bytes to return

BoundedInputStream

public BoundedInputStream(java.io.InputStream in)

Method Detail

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)
         throws java.io.IOException

Overrides:

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

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

isPropagateClose

public boolean isPropagateClose()

setPropagateClose

public void setPropagateClose(boolean propagateClose)