Package org.eclipse.jetty.server

Class HttpInput

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

org.eclipse.jetty.server.HttpInput

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable

Direct Known Subclasses:

HttpInputOverHTTP

public class HttpInput
extends javax.servlet.ServletInputStream
implements java.lang.Runnable

HttpInput provides an implementation of ServletInputStream for HttpChannel.

Content may arrive in patterns such as [content(), content(), messageComplete()] so that this class maintains two states: the content state that tells whether there is content to consume and the EOF state that tells whether an EOF has arrived. Only once the content has been consumed the content state is moved to the EOF state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpInput.ChainedInterceptor	An HttpInput.Interceptor that chains two other HttpInput.Interceptors together.
static class	HttpInput.Content
static class	HttpInput.EofContent
protected static class	HttpInput.EOFState
protected static class	HttpInput.ErrorState
static interface	HttpInput.Interceptor	An interceptor for HTTP Request input.
static class	HttpInput.SentinelContent	A Sentinel Content, which has zero length content but indicates some other event in the input stream (eg EOF)
protected static class	HttpInput.State

Field Summary

Fields

Modifier and Type	Field	Description
protected static HttpInput.State	AEOF
protected static HttpInput.State	ASYNC
protected static HttpInput.State	EARLY_EOF
protected static HttpInput.State	EOF
protected static HttpInput.State	STREAM

Constructor Summary

Constructors

Constructor	Description
HttpInput(HttpChannelState state)

Method Summary

Modifier and Type	Method	Description
boolean	addContent(HttpInput.Content content)	Adds some content to this input stream.
void	addInterceptor(HttpInput.Interceptor interceptor)	Set the HttpInput.Interceptor, using a HttpInput.ChainedInterceptor if an HttpInput.Interceptor is already set.
void	asyncReadProduce()	Called by channel when asynchronous IO needs to produce more content
int	available()
protected void	blockForContent()	Blocks until some content or some end-of-file event arrives.
boolean	consumeAll()	Consume all available content without blocking.
boolean	earlyEOF()	This method should be called to signal that an EOF has been detected before all the expected content arrived.
boolean	eof()	This method should be called to signal that all the expected content arrived.
boolean	failed(java.lang.Throwable x)
protected int	get(HttpInput.Content content, byte[] buffer, int offset, int length)	Copies the given content into the given byte buffer.
long	getContentConsumed()
long	getContentReceived()
protected HttpChannelState	getHttpChannelState()
HttpInput.Interceptor	getInterceptor()
boolean	hasContent()
boolean	isAsync()
boolean	isError()
boolean	isFinished()
boolean	isReady()
protected HttpInput.Content	nextContent()	Get the next content from the inputQ, calling produceContent() if need be.
protected HttpInput.Content	nextInterceptedContent()	Poll the inputQ for Content or EOF.
protected HttpInput.Content	nextNonSentinelContent()	Poll the inputQ for Content.
boolean	onIdleTimeout(java.lang.Throwable x)
protected void	produceContent()	Called when derived implementations should attempt to produce more Content and add it via addContent(Content).
protected HttpInput.Content	produceNextContent()	Get the next readable from the inputQ, calling produceContent() if need be.
int	read()
int	read(byte[] b, int off, int len)
void	recycle()
void	run()
void	setInterceptor(HttpInput.Interceptor interceptor)	Set the interceptor.
void	setReadListener(javax.servlet.ReadListener readListener)
java.lang.String	toString()
void	unblock()
protected void	wake()

Methods inherited from class javax.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

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

Methods inherited from class java.lang.Object

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

Field Detail

STREAM

protected static final HttpInput.State STREAM

ASYNC

protected static final HttpInput.State ASYNC

EARLY_EOF

protected static final HttpInput.State EARLY_EOF

EOF

protected static final HttpInput.State EOF

AEOF

protected static final HttpInput.State AEOF

Constructor Detail

HttpInput

public HttpInput(HttpChannelState state)

Method Detail

getHttpChannelState

protected HttpChannelState getHttpChannelState()

recycle

public void recycle()

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, using a HttpInput.ChainedInterceptor if an HttpInput.Interceptor is already set.

Parameters:

interceptor - the next HttpInput.Interceptor in a chain

available

public int available()

Overrides:

available in class java.io.InputStream

wake

protected void wake()

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

produceContent

protected void produceContent()
                       throws java.io.IOException

Called when derived implementations should attempt to produce more Content and add it via addContent(Content). For protocols that are constantly producing (eg HTTP2) this can be left as a noop;

Throws:

java.io.IOException - if unable to produce content

asyncReadProduce

public void asyncReadProduce()
                      throws java.io.IOException

Called by channel when asynchronous IO needs to produce more content

Throws:

java.io.IOException - if unable to produce content

nextContent

protected HttpInput.Content nextContent()
                                 throws java.io.IOException

Get the next content from the inputQ, calling produceContent() if need be. EOF is processed and state changed.

Returns:

the content or null if none available.

Throws:

java.io.IOException - if retrieving the content fails

nextNonSentinelContent

protected HttpInput.Content nextNonSentinelContent()
                                            throws java.io.IOException

Poll the inputQ for Content. Consumed buffers and HttpInput.SentinelContents are removed and EOF state updated if need be.

Returns:

Content or null

Throws:

java.io.IOException

produceNextContent

protected HttpInput.Content produceNextContent()
                                        throws java.io.IOException

Get the next readable from the inputQ, calling produceContent() if need be. EOF is NOT processed and state is not changed.

Returns:

the content or EOF or null if none available.

Throws:

java.io.IOException - if retrieving the content fails

nextInterceptedContent

protected HttpInput.Content nextInterceptedContent()
                                            throws java.io.IOException

Poll the inputQ for Content or EOF. Consumed buffers and non EOF HttpInput.SentinelContents are removed. EOF state is not updated. Interception is done within this method.

Returns:

Content with remaining, a HttpInput.SentinelContent, or null

Throws:

java.io.IOException

get

protected int get(HttpInput.Content content,
                  byte[] buffer,
                  int offset,
                  int length)

Copies the given content into the given byte buffer.

Parameters:

content - the content to copy from

buffer - the buffer to copy into

offset - the buffer offset to start copying from

length - the space available in the buffer

Returns:

the number of bytes actually copied

blockForContent

protected void blockForContent()
                        throws java.io.IOException

Blocks until some content or some end-of-file event arrives.

Throws:

java.io.IOException - if the wait is interrupted

addContent

public boolean addContent(HttpInput.Content content)

Adds some content to this input stream.

Parameters:

content - the content to add

Returns:

true if content channel woken for read

hasContent

public boolean hasContent()

unblock

public void unblock()

getContentConsumed

public long getContentConsumed()

getContentReceived

public long getContentReceived()

earlyEOF

public boolean earlyEOF()

This method should be called to signal that an EOF has been detected before all the expected content arrived.

Typically this will result in an EOFException being thrown from a subsequent read rather than a -1 return.

Returns:

true if content channel woken for read

eof

public boolean eof()

This method should be called to signal that all the expected content arrived.

Returns:

true if content channel woken for read

consumeAll

public boolean consumeAll()

Consume all available content without blocking. Raw content is counted in the getContentReceived() statistics, but is not intercepted nor counted in the getContentConsumed() statistics

Returns:

True if EOF was reached, false otherwise.

isError

public boolean isError()

isAsync

public boolean isAsync()

isFinished

public boolean isFinished()

Specified by:

isFinished in class javax.servlet.ServletInputStream

isReady

public boolean isReady()

Specified by:

isReady in class javax.servlet.ServletInputStream

setReadListener

public void setReadListener(javax.servlet.ReadListener readListener)

Specified by:

setReadListener in class javax.servlet.ServletInputStream

onIdleTimeout

public boolean onIdleTimeout(java.lang.Throwable x)

failed

public boolean failed(java.lang.Throwable x)

run

public void run()

Specified by:

run in interface java.lang.Runnable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object