Package org.glassfish.grizzly.servlet

Class ServletInputStreamImpl

java.lang.Object

java.io.InputStream

jakarta.servlet.ServletInputStream

org.glassfish.grizzly.servlet.ServletInputStreamImpl

All Implemented Interfaces:

Closeable, AutoCloseable

public class ServletInputStreamImpl
extends ServletInputStream

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletInputStreamImpl(HttpServletRequestImpl servletRequest)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()	Close the stream Since we re-cycle, we can't allow the call to super.close() which would permanently disable us.
void	initialize()
boolean	isFinished()	Returns true when all the data from the stream has been read else it returns false.
boolean	isReady()	Returns true if data can be read without blocking else returns false.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
void	setReadListener(ReadListener readListener)	Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read
long	skip(long n)

Methods inherited from class jakarta.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ServletInputStreamImpl

protected ServletInputStreamImpl(HttpServletRequestImpl servletRequest)

Method Details

initialize

public void initialize()
                throws IOException

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

close

public void close()
           throws IOException

Close the stream Since we re-cycle, we can't allow the call to super.close() which would permanently disable us.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

isFinished

public boolean isFinished()

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

Specified by:

isFinished in class ServletInputStream

Returns:

true when all data for this particular request has been read, otherwise returns false.

isReady

public 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 ServletInputStream.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.

Specified by:

isReady in class ServletInputStream

Returns:

true if data can be obtained without blocking, otherwise returns false.

See Also:

• ReadListener

setReadListener

public void setReadListener(ReadListener readListener)

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

Specified by:

setReadListener in class ServletInputStream

Parameters:

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