Top Description Constructors Methods
javax.servlet

public abstract Class ServletInputStream

extends InputStream
Class Inheritance
Imports
java.io.IOException, .InputStream

Provides an input stream for reading binary data from a client request, including an efficient readLine method for reading data one line at a time. With some protocols, such as HTTP POST and PUT, a ServletInputStream object can be used to read data sent from the client.

A ServletInputStream object is normally retrieved via the ServletRequest#getInputStream method.

This is an abstract class that a servlet container implements. Subclasses of this class must implement the java.io.InputStream.read() method.

Version
$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $
See Also
ServletRequest

Constructor Summary

AccessConstructor and Description
protected
ServletInputStream()

Does nothing, because this is an abstract class.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
readLine
(byte[]
an array of bytes into which data is read
b
,
int
an integer specifying the character at which this method begins reading
off
,
int
an integer specifying the maximum number of bytes to read
len
)

Reads the input stream, one line at a time.

Inherited from java.io.InputStream:
availableclosemarkmarkSupportednullInputStreamreadreadreadreadAllBytesreadNBytesreadNBytesresetskipskipNBytestransferTo

Constructor Detail

ServletInputStreamback to summary
protected ServletInputStream()

Does nothing, because this is an abstract class.

Method Detail

readLineback to summary
public int readLine(byte[] b, int off, int len) throws IOException

Reads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well.

This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes.

Parameters
b:byte[]

an array of bytes into which data is read

off:int

an integer specifying the character at which this method begins reading

len:int

an integer specifying the maximum number of bytes to read

Returns:int

an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached

Exceptions
IOException:
if an input or output exception has occurred