org.eclipse.jetty.server

Class HttpInput<T>

java.lang.Object

java.io.InputStream

javax.servlet.ServletInputStream

org.eclipse.jetty.server.HttpInput<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

HttpInputOverHTTP, QueuedHttpInput

public abstract class HttpInput<T>
extends ServletInputStream
implements 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 and Description
protected static class	HttpInput.State

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpInput()
protected	HttpInput(Object lock)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
protected abstract void	blockForContent() Blocks until some content or some end-of-file event arrives.
protected abstract void	consume(T item, int length) Consumes the given content.
boolean	consumeAll()
abstract void	content(T item) Adds some content to this input stream.
void	earlyEOF() This method should be called to signal that an EOF has been detected before all the expected content arrived.
void	failed(Throwable x)
protected abstract int	get(T item, byte[] buffer, int offset, int length) Copies the given content into the given byte buffer.
long	getContentRead()
protected T	getNextContent() A convenience method to call nextContent and to check the return value, which if null then the a check is made for EOF and the state changed accordingly.
void	init(HttpChannelState state)
boolean	isAsync()
boolean	isEarlyEOF()
boolean	isEOF()
boolean	isFinished()
boolean	isReady()
Object	lock()
void	messageComplete() This method should be called to signal that all the expected content arrived.
protected abstract T	nextContent() Access the next content to be consumed from.
protected boolean	onAsyncRead()
int	read()
int	read(byte[] b, int off, int len)
void	recycle()
protected abstract int	remaining(T item)
void	run()
void	setReadListener(ReadListener readListener)
String	toString()
protected void	unready()

Methods inherited from class javax.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

close, mark, markSupported, read, reset, skip

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

Constructor Detail

HttpInput

protected HttpInput()

HttpInput

protected HttpInput(Object lock)

Method Detail

init

public void init(HttpChannelState state)

lock

public final Object lock()

recycle

public void recycle()

available

public int available()

Overrides:

available in class InputStream

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

getNextContent

protected T getNextContent()
                    throws IOException

A convenience method to call nextContent and to check the return value, which if null then the a check is made for EOF and the state changed accordingly.

Returns:

Content or null if none available.

Throws:

IOException

See Also:

nextContent()

nextContent

protected abstract T nextContent()
                          throws IOException

Access the next content to be consumed from. Returning the next item does not consume it and it may be returned multiple times until it is consumed.

Calls to get(Object, byte[], int, int) or consume(Object, int) are required to consume data from the content.

Returns:

the content or null if none available.

Throws:

IOException - if retrieving the content fails

remaining

protected abstract int remaining(T item)

Parameters:

item - the content

Returns:

how many bytes remain in the given content

get

protected abstract int get(T item,
      byte[] buffer,
      int offset,
      int length)

Copies the given content into the given byte buffer.

Parameters:

item - 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

consume

protected abstract void consume(T item,
           int length)

Consumes the given content.

Parameters:

item - the content to consume

length - the number of bytes to consume

blockForContent

protected abstract void blockForContent()
                                 throws IOException

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

Throws:

IOException - if the wait is interrupted

content

public abstract void content(T item)

Adds some content to this input stream.

Parameters:

item - the content to add

onAsyncRead

protected boolean onAsyncRead()

getContentRead

public long getContentRead()

earlyEOF

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

isEarlyEOF

public boolean isEarlyEOF()

messageComplete

public void messageComplete()

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

consumeAll

public boolean consumeAll()

isAsync

public boolean isAsync()

isEOF

public boolean isEOF()

Returns:

whether an EOF has been detected, even though there may be content to consume.

isFinished

public boolean isFinished()

Specified by:

isFinished in class ServletInputStream

isReady

public boolean isReady()

Specified by:

isReady in class ServletInputStream

unready

protected void unready()

setReadListener

public void setReadListener(ReadListener readListener)

Specified by:

setReadListener in class ServletInputStream

failed

public void failed(Throwable x)

run

public void run()

Specified by:

run in interface Runnable

toString

public String toString()

Overrides:

toString in class Object