| java.lang.Object
 java.io.InputStream
org.apache.cocoon.util.PostInputStream
| PostInputStream | | public class PostInputStream extends InputStream (Code) | | The class PostInputStream is a wrapper for InputStream associated with POST message.
It allows to control read operation, restricting the number of bytes read to the value returned by getContentLen() method.
author:
Kinga Dziembowski
version:
CVS $Id: PostInputStream.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| public synchronized int | available()
Returns the number of bytes available from this input stream that can be read without the stream blocking. | | protected void | checkOpen()
Checks to see if this stream is closed; if it is, an IOException is thrown. | | public synchronized void | close()
Closes this input stream by closing the underlying stream and marking this one as closed. | | public int | getContentLen()
Returns the post message body length. | | public InputStream | getInputStream()
Returns the underlying input stream. | | protected void | init(InputStream input, int len)
Sets the underlying input stream and contentLen value . | | public boolean | markSupported()
Tests if this input stream supports the mark
and reset methods. | | public synchronized int | read()
Reads the next byte from the input stream. | | public synchronized int | read(byte[] buffer, int offset, int len)
Reads bytes from this byte-input stream into the specified byte array,
starting at the given offset.
This method implements the general contract of the corresponding
InputStream.read(byte[]intint) read method of
the
InputStream class.
This method delegetes the read operation to the underlying InputStream implementation class but it
controlls the number of bytes read from the stream. | | public synchronized int | read(byte[] buffer)
| | public synchronized void | setInputStream(InputStream input, int len)
Sets the underlying input stream and contentLen value . | | public synchronized long | skip(long n)
See the general contract of the skip
method of InputStream.
Delegates execution to the underlying InputStream implementation class.
Checks to see if this stream is closed; if it is, an IOException is thrown.
Parameters:
n - the number of bytes to be skipped. | | public String | toString()
Returns a String representation of this. |
| m_bytesRead | | protected int m_bytesRead(Code) | | The number of bytes read
|
| PostInputStream | | public PostInputStream()(Code) | | Creates a PostInputStream
|
| PostInputStream | | public PostInputStream(InputStream input, int len) throws IllegalArgumentException(Code) | | Creates a PostInputStream based on a real InputStream object with the specified
post message body length. Saves its argument, the input stream
m_inputStream, for later use.
Parameters:
input - the underlying input stream.
Parameters:
len - the post message body length.
exception:
IllegalArgumentException - len <= 0. |
| available | | public synchronized int available() throws IOException(Code) | | Returns the number of bytes available from this input stream that can be read without the stream blocking.
Delegates execution to the underlying InputStream implementation class.
available the number of available bytes.
throws:
IOException - |
| checkOpen | | protected void checkOpen() throws IOException(Code) | | Checks to see if this stream is closed; if it is, an IOException is thrown.
throws:
IOException - |
| close | | public synchronized void close() throws IOException(Code) | | Closes this input stream by closing the underlying stream and marking this one as closed.
throws:
IOException - |
| getContentLen | | public int getContentLen()(Code) | | Returns the post message body length.
m_contentLen; |
| getInputStream | | public InputStream getInputStream()(Code) | | Returns the underlying input stream.
inputStream the underlying InputStream. |
| markSupported | | public boolean markSupported()(Code) | | Tests if this input stream supports the mark
and reset methods. The markSupported
method of BufferedInputStream returns
false.
a boolean indicating if this stream type supportsthe mark and reset methods.
See Also: java.io.InputStream.mark(int)
See Also: java.io.InputStream.reset |
| read | | public synchronized int read() throws IOException(Code) | | Reads the next byte from the input stream. If the end of the stream has been reached, this method returns -1.
the next byte or -1 if at the end of the stream.
throws:
IOException - |
| read | | public synchronized int read(byte[] buffer, int offset, int len) throws IOException(Code) | | Reads bytes from this byte-input stream into the specified byte array,
starting at the given offset.
This method implements the general contract of the corresponding
InputStream.read(byte[]intint) read method of
the
InputStream class.
This method delegetes the read operation to the underlying InputStream implementation class but it
controlls the number of bytes read from the stream. In the remote situation the underlying InputStream has no knowledge of
the length of the stream and the notion of the "end" is undefined. This wrapper class has a knowledge of the
length of data send by the requestor by the means of contentLength. This method returns the number of bytes read and
accumulates the total number of bytes read in m_bytesRead. When the m_bytesRead is equal to the specified contentLength
value the method returns returns -1 to signal the end of data.
Parameters:
buffer - the byte array to read into; can not be null.
Parameters:
offset - the starting offset in the byte array.
Parameters:
len - the maximum number of bytes to read. the number of bytes read, or -1 if the end ofthe stream has been reached.
exception:
IOException - if an I/O error occurs. |
| setInputStream | | public synchronized void setInputStream(InputStream input, int len) throws IOException(Code) | | Sets the underlying input stream and contentLen value .
Parameters:
input - the input stream; can not be null.
Parameters:
len - the post message body length.
throws:
IOException - |
| skip | | public synchronized long skip(long n) throws IOException(Code) | | See the general contract of the skip
method of InputStream.
Delegates execution to the underlying InputStream implementation class.
Checks to see if this stream is closed; if it is, an IOException is thrown.
Parameters:
n - the number of bytes to be skipped. the actual number of bytes skipped.
exception:
IOException - if an I/O error occurs. |
| toString | | public String toString()(Code) | | Returns a String representation of this.
string the String representation of this. |
|
|