com.oreilly.servlet.multipart

Class PartInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.oreilly.servlet.multipart.PartInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class PartInputStream
extends java.io.FilterInputStream

A PartInputStream filters a ServletInputStream, providing access to a single MIME part contained with in which ends with the boundary specified. It uses buffering to provide maximum performance.

Note the readLine method of ServletInputStream has the annoying habit of adding a \r\n to the end of the last line. Since we want a byte-for-byte transfer, we have to cut those chars. This means that we must always maintain at least 2 characters in our buffer to allow us to trim when necessary.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes that can be read from this input stream without blocking.
void	close() Closes this input stream and releases any system resources associated with the stream.
int	read() See the general contract of the read method of InputStream.
int	read(byte[] b) See the general contract of the read method of InputStream.
int	read(byte[] b, int off, int len) See the general contract of the read method of InputStream.

Methods inherited from class java.io.FilterInputStream

mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Method Detail

read

public int read()
         throws java.io.IOException

See the general contract of the read method of InputStream.

Returns -1 (end of file) when the MIME boundary of this part is encountered.

Overrides:

read in class java.io.FilterInputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

Throws:

java.io.IOException - if an I/O error occurs.

read

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

See the general contract of the read method of InputStream.

Returns -1 (end of file) when the MIME boundary of this part is encountered.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if an I/O error occurs.

read

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

See the general contract of the read method of InputStream.

Returns -1 (end of file) when the MIME boundary of this part is encountered.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset of the data.

len - the maximum number of bytes read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if an I/O error occurs.

available

public int available()
              throws java.io.IOException

Returns the number of bytes that can be read from this input stream without blocking. This is a standard InputStream idiom to deal with buffering gracefully, and is not same as the length of the part arriving in this stream.

Overrides:

available in class java.io.FilterInputStream

Returns:

the number of bytes that can be read from the input stream without blocking.

Throws:

java.io.IOException - if an I/O error occurs.

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream.

This method will read any unread data in the MIME part so that the next part starts an an expected place in the parent InputStream. Note that if the client code forgets to call this method on error, MultipartParser will call it automatically if you call readNextPart().

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterInputStream

Throws:

java.io.IOException - if an I/O error occurs.