EE4J 10.0.0 · jakarta.servlet.ServletInputStream

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.

Access	Constructor and Description
protected	ServletInputStream() Does nothing, because this is an abstract class.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: `true` when all data for this particular request has been read, otherwise returns `false`. isFinished() Returns true when all the data from the stream has been read else it returns false.
public abstract boolean	Returns: `true` if data can be obtained without blocking, otherwise returns `false`. isReady() Returns true if data can be read without blocking else returns false.
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.
public abstract void	setReadListener(ReadListener the `ReadListener` that should be notified when it's possible to read. readListener) Instructs the `ServletInputStream` to invoke the provided `ReadListener` when it is possible to read

Inherited from java.io.InputStream:: available close mark markSupported nullInputStream read read read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Constructor Detail

ServletInputStream	back to summary
protected ServletInputStream() Does nothing, because this is an abstract class.

Method Detail

isFinished back to summary

isFinished	back to summary
public abstract boolean isFinished() Returns true when all the data from the stream has been read else it returns false. Returns:boolean `true` when all data for this particular request has been read, otherwise returns `false`. Since Servlet 3.1

public abstract boolean isFinished()

Returns true when all the data from the stream has been read else it returns false.

Returns:boolean: true when all data for this particular request has been read, otherwise returns false.
Since: Servlet 3.1

isReady back to summary

isReady	back to summary
public abstract boolean isReady() Returns true if data can be read without blocking else returns false. If this method returns false and a `ReadListener` has been set via `setReadListener(ReadListener)`, then the container will subsequently invoke `ReadListener#onDataAvailable()` (or `ReadListener#onAllDataRead()`) once data (or EOF) has become available. Other than the initial call, `ReadListener#onDataAvailable()` will only be called if and only if this method is called and returns false. Returns:boolean `true` if data can be obtained without blocking, otherwise returns `false`. Since Servlet 3.1 See Also `ReadListener`

public abstract boolean isReady()

Returns true if data can be read without blocking else returns false.

If this method returns false and a ReadListener has been set via setReadListener(ReadListener), then the container will subsequently invoke ReadListener#onDataAvailable() (or ReadListener#onAllDataRead()) once data (or EOF) has become available. Other than the initial call, ReadListener#onDataAvailable() will only be called if and only if this method is called and returns false.

Returns:boolean: true if data can be obtained without blocking, otherwise returns false.
Since: Servlet 3.1
See Also: ReadListener

readLine	back 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

readLine

back 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

setReadListener back to summary

setReadListener	back to summary
public abstract void setReadListener(ReadListener readListener) Instructs the `ServletInputStream` to invoke the provided `ReadListener` when it is possible to read Parameters readListener:ReadListener the `ReadListener` that should be notified when it's possible to read. Exceptions IllegalStateException: if one of the following conditions is true the associated request is neither upgraded nor the async started setReadListener is called more than once within the scope of the same request. NullPointerException: if readListener is null Since Servlet 3.1

public abstract void setReadListener(ReadListener readListener)

Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read

Parameters

readListener:ReadListener: the ReadListener that should be notified when it's possible to read.

Exceptions

IllegalStateException:

if one of the following conditions is true

the associated request is neither upgraded nor the async started
setReadListener is called more than once within the scope of the same request.

NullPointerException:

if readListener is null

Since

Servlet 3.1

public abstract Class ServletInputStream

Constructor Summary

Method Summary

Constructor Detail

Method Detail