Package org.eclipse.jetty.server

Class HttpInput

java.lang.Object
java.io.InputStream
javax.servlet.ServletInputStream
org.eclipse.jetty.server.HttpInput
All Implemented Interfaces:
Closeable, AutoCloseable, Runnable
Direct Known Subclasses:
HttpInputOverHTTP
@Deprecated(since="2021-05-27") public class HttpInput extends ServletInputStream implements Runnable
Deprecated.
The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
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.

  • Constructor Details

  • Method Details

    • recycle

      public void recycle()
      Deprecated.

    • getInterceptor

      public HttpInput.Interceptor getInterceptor()
      Deprecated.
      Returns:
      The current Interceptor, or null if none set

    • setInterceptor

      public void setInterceptor(HttpInput.Interceptor interceptor)
      Deprecated.
      Set the interceptor.
      Parameters:
      interceptor - The interceptor to use.

    • addInterceptor

      public void addInterceptor(HttpInput.Interceptor interceptor)
      Deprecated.
      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()
      Deprecated.
      Overrides:
      available in class InputStream

    • read

      public int read() throws IOException
      Deprecated.
      Specified by:
      read in class InputStream
      Throws:
      IOException

    • read

      public int read(byte[] b, int off, int len) throws IOException
      Deprecated.
      Overrides:
      read in class InputStream
      Throws:
      IOException

    • asyncReadProduce

      public void asyncReadProduce() throws IOException
      Deprecated.
      Called by channel when asynchronous IO needs to produce more content
      Throws:
      IOException - if unable to produce content

    • addContent

      public boolean addContent(HttpInput.Content content)
      Deprecated.
      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()
      Deprecated.

    • unblock

      public void unblock()
      Deprecated.

    • getContentConsumed

      public long getContentConsumed()
      Deprecated.

    • getContentReceived

      public long getContentReceived()
      Deprecated.

    • earlyEOF

      public boolean earlyEOF()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.

    • isAsync

      public boolean isAsync()
      Deprecated.

    • isFinished

      public boolean isFinished()
      Deprecated.
      Description copied from class: ServletInputStream
      Has the end of this InputStream been reached?
      Specified by:
      isFinished in class ServletInputStream
      Returns:
      true if all the data has been read from the stream, else false

    • isReady

      public boolean isReady()
      Deprecated.
      Description copied from class: ServletInputStream
      Can data be read from this InputStream without blocking? Returns If this method is called and returns false, the container will invoke ReadListener.onDataAvailable() when data is available.
      Specified by:
      isReady in class ServletInputStream
      Returns:
      true if data can be read without blocking, else false

    • setReadListener

      public void setReadListener(ReadListener readListener)
      Deprecated.
      Description copied from class: ServletInputStream
      Sets the ReadListener for this ServletInputStream and thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.
      Specified by:
      setReadListener in class ServletInputStream
      Parameters:
      readListener - The non-blocking IO read listener

    • onIdleTimeout

      public boolean onIdleTimeout(Throwable x)
      Deprecated.

    • failed

      public boolean failed(Throwable x)
      Deprecated.

    • run

      public void run()
      Deprecated.
      Specified by:
      run in interface Runnable

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object