Package org.eclipse.jetty.server

Class HttpInput

java.lang.Object

java.io.InputStream

jakarta.servlet.ServletInputStream

org.eclipse.jetty.server.HttpInput

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class HttpInput
extends jakarta.servlet.ServletInputStream
implements Runnable

While this class is-a Runnable, it should never be dispatched in it's own thread. It is a runnable only so that the calling thread can use ContextHandler.handle(Runnable) to setup classloaders etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpInput.Content	A content represents the production of a HttpChannel returned by HttpChannel.produceContent().
static final class	HttpInput.EofContent	EOF special content.
static final class	HttpInput.ErrorContent	Error special content.
static interface	HttpInput.Interceptor	HttpInput.Content interceptor that can be registered using setInterceptor(Interceptor) or addInterceptor(Interceptor).
static class	HttpInput.SpecialContent	Abstract class that implements the standard special content behavior.
static class	HttpInput.WrappingContent	Simple non-special content wrapper allow overriding the EOF flag.

Constructor Summary

Constructors

Constructor	Description
HttpInput(HttpChannelState state)

Method Summary

Modifier and Type	Method	Description
void	addInterceptor(HttpInput.Interceptor interceptor)	Set the HttpInput.Interceptor, chaining it to the existing one if an HttpInput.Interceptor is already set.
int	available()
boolean	consumeAll()
long	getContentConsumed()
long	getContentReceived()
HttpInput.Interceptor	getInterceptor()
boolean	hasContent()	Check if this HttpInput instance has content stored internally, without fetching/parsing anything from the underlying channel.
boolean	isAsync()
boolean	isError()
boolean	isFinished()
boolean	isReady()
boolean	onContentProducible()
int	read()
int	read(byte[] b, int off, int len)
int	read(ByteBuffer buffer)
void	recycle()
void	reopen()
void	run()
void	setInterceptor(HttpInput.Interceptor interceptor)	Set the interceptor.
void	setReadListener(jakarta.servlet.ReadListener readListener)
String	toString()

Methods inherited from class jakarta.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

close, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

HttpInput

public HttpInput(HttpChannelState state)

Method Details

recycle

public void recycle()

reopen

public void reopen()

getInterceptor

public HttpInput.Interceptor getInterceptor()

Returns:

The current Interceptor, or null if none set

setInterceptor

public void setInterceptor(HttpInput.Interceptor interceptor)

Set the interceptor.

Parameters:

interceptor - The interceptor to use.

addInterceptor

public void addInterceptor(HttpInput.Interceptor interceptor)

Set the HttpInput.Interceptor, chaining it to the existing one if an HttpInput.Interceptor is already set.

Parameters:

interceptor - the next HttpInput.Interceptor in a chain

getContentConsumed

public long getContentConsumed()

getContentReceived

public long getContentReceived()

consumeAll

public boolean consumeAll()

isError

public boolean isError()

isAsync

public boolean isAsync()

isFinished

public boolean isFinished()

Specified by:

isFinished in class jakarta.servlet.ServletInputStream

isReady

public boolean isReady()

Specified by:

isReady in class jakarta.servlet.ServletInputStream

setReadListener

public void setReadListener(jakarta.servlet.ReadListener readListener)

Specified by:

setReadListener in class jakarta.servlet.ServletInputStream

onContentProducible

public boolean onContentProducible()

read

public int read()
         throws IOException

Specified by:

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

read

public int read(ByteBuffer buffer)
         throws IOException

Throws:

IOException

hasContent

public boolean hasContent()

Check if this HttpInput instance has content stored internally, without fetching/parsing anything from the underlying channel.

Returns:

true if the input contains content, false otherwise.

available

public int available()

Overrides:

available in class InputStream

run

public void run()

Specified by:

run in interface Runnable

toString

public String toString()

Overrides:

toString in class Object