Class HttpOutput

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.lang.Runnable

    @Deprecated(since="2021-05-27")
    public class HttpOutput
    extends ServletOutputStream
    implements java.lang.Runnable
    Deprecated.
    The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

    HttpOutput implements ServletOutputStream as required by the Servlet specification.

    HttpOutput buffers content written by the application until a further write will overflow the buffer, at which point it triggers a commit of the response.

    HttpOutput can be closed and reopened, to allow requests included via RequestDispatcher.include(ServletRequest, ServletResponse) to close the stream, to be reopened after the inclusion ends.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  HttpOutput.Interceptor
      Deprecated.
      The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    • Constructor Summary

      Constructors 
      Constructor Description
      HttpOutput​(HttpChannel channel)
      Deprecated.
       
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void close()
      Deprecated.
       
      void complete​(Callback callback)
      Deprecated.
       
      void completed​(java.lang.Throwable failure)
      Deprecated.
      Called to indicate that the request cycle has been completed.
      void flush()
      Deprecated.
       
      java.nio.ByteBuffer getBuffer()
      Deprecated.
       
      int getBufferSize()
      Deprecated.
       
      HttpChannel getHttpChannel()
      Deprecated.
       
      HttpOutput.Interceptor getInterceptor()
      Deprecated.
       
      long getWritten()
      Deprecated.
       
      boolean isAsync()
      Deprecated.
       
      boolean isClosed()
      Deprecated.
       
      boolean isReady()
      Deprecated.
      Checks if a non-blocking write will succeed.
      boolean isWritten()
      Deprecated.
       
      void onFlushed​(long bytes)
      Deprecated.
      Invoked when bytes have been flushed to the network.
      void print​(java.lang.String s)
      Deprecated.
      Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.
      void println​(boolean b)
      Deprecated.
      Writes a boolean value to the client, followed by a carriage return-line feed (CRLF).
      void println​(char c)
      Deprecated.
      Writes a character to the client, followed by a carriage return-line feed (CRLF).
      void println​(double d)
      Deprecated.
      Writes a double value to the client, followed by a carriage return-line feed (CRLF).
      void println​(float f)
      Deprecated.
      Writes a float value to the client, followed by a carriage return-line feed (CRLF).
      void println​(int i)
      Deprecated.
      Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
      void println​(long l)
      Deprecated.
      Writes a long value to the client, followed by a carriage return-line feed (CRLF).
      void println​(java.lang.String s)
      Deprecated.
      Writes a String to the client, followed by a carriage return-line feed (CRLF).
      void recycle()
      Deprecated.
       
      void reopen()
      Deprecated.
       
      void resetBuffer()
      Deprecated.
       
      void run()
      Deprecated.
       
      void sendContent​(java.io.InputStream in)
      Deprecated.
      Blocking send of stream content.
      void sendContent​(java.io.InputStream in, Callback callback)
      Deprecated.
      Asynchronous send of stream content.
      void sendContent​(java.nio.ByteBuffer content)
      Deprecated.
      Blocking send of whole content.
      void sendContent​(java.nio.ByteBuffer content, Callback callback)
      Deprecated.
      Asynchronous send of whole content.
      void sendContent​(java.nio.channels.ReadableByteChannel in)
      Deprecated.
      Blocking send of channel content.
      void sendContent​(java.nio.channels.ReadableByteChannel in, Callback callback)
      Deprecated.
      Asynchronous send of channel content.
      void sendContent​(HttpContent content)
      Deprecated.
      Blocking send of HTTP content.
      void sendContent​(HttpContent httpContent, Callback callback)
      Deprecated.
      Asynchronous send of HTTP content.
      void setBufferSize​(int size)
      Deprecated.
       
      void setInterceptor​(HttpOutput.Interceptor interceptor)
      Deprecated.
       
      void setWriteListener​(WriteListener writeListener)
      Deprecated.
      Sets the WriteListener for this ServletOutputStream and thereby switches to non-blocking IO.
      void softClose()
      Deprecated.
       
      java.lang.String toString()
      Deprecated.
       
      void write​(byte[] b, int off, int len)
      Deprecated.
       
      void write​(int b)
      Deprecated.
       
      void write​(java.nio.ByteBuffer buffer)
      Deprecated.
       
      • Methods inherited from class java.io.OutputStream

        nullOutputStream, write
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • HttpOutput

        public HttpOutput​(HttpChannel channel)
        Deprecated.
    • Method Detail

      • getHttpChannel

        public HttpChannel getHttpChannel()
        Deprecated.
      • isWritten

        public boolean isWritten()
        Deprecated.
      • getWritten

        public long getWritten()
        Deprecated.
      • reopen

        public void reopen()
        Deprecated.
      • softClose

        public void softClose()
        Deprecated.
      • complete

        public void complete​(Callback callback)
        Deprecated.
      • completed

        public void completed​(java.lang.Throwable failure)
        Deprecated.
        Called to indicate that the request cycle has been completed.
      • close

        public void close()
                   throws java.io.IOException
        Deprecated.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException
      • getBuffer

        public java.nio.ByteBuffer getBuffer()
        Deprecated.
      • isClosed

        public boolean isClosed()
        Deprecated.
      • isAsync

        public boolean isAsync()
        Deprecated.
      • flush

        public void flush()
                   throws java.io.IOException
        Deprecated.
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        Throws:
        java.io.IOException
      • write

        public void write​(byte[] b,
                          int off,
                          int len)
                   throws java.io.IOException
        Deprecated.
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException
      • write

        public void write​(java.nio.ByteBuffer buffer)
                   throws java.io.IOException
        Deprecated.
        Throws:
        java.io.IOException
      • write

        public void write​(int b)
                   throws java.io.IOException
        Deprecated.
        Specified by:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException
      • print

        public void print​(java.lang.String s)
                   throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.
        Overrides:
        print in class ServletOutputStream
        Parameters:
        s - the String to send to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(java.lang.String s)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a String to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        s - the String to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(boolean b)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a boolean value to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        b - the boolean value to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(char c)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a character to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        c - the character to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(int i)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
        Overrides:
        println in class ServletOutputStream
        Parameters:
        i - the int to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(long l)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a long value to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        l - the long value to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(float f)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a float value to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        f - the float value to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • println

        public void println​(double d)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: ServletOutputStream
        Writes a double value to the client, followed by a carriage return-line feed (CRLF).
        Overrides:
        println in class ServletOutputStream
        Parameters:
        d - the double value to write to the client
        Throws:
        java.io.IOException - if an input or output exception occurred
      • sendContent

        public void sendContent​(java.nio.ByteBuffer content)
                         throws java.io.IOException
        Deprecated.
        Blocking send of whole content.
        Parameters:
        content - The whole content to send
        Throws:
        java.io.IOException - if the send fails
      • sendContent

        public void sendContent​(java.io.InputStream in)
                         throws java.io.IOException
        Deprecated.
        Blocking send of stream content.
        Parameters:
        in - The stream content to send
        Throws:
        java.io.IOException - if the send fails
      • sendContent

        public void sendContent​(java.nio.channels.ReadableByteChannel in)
                         throws java.io.IOException
        Deprecated.
        Blocking send of channel content.
        Parameters:
        in - The channel content to send
        Throws:
        java.io.IOException - if the send fails
      • sendContent

        public void sendContent​(HttpContent content)
                         throws java.io.IOException
        Deprecated.
        Blocking send of HTTP content.
        Parameters:
        content - The HTTP content to send
        Throws:
        java.io.IOException - if the send fails
      • sendContent

        public void sendContent​(java.nio.ByteBuffer content,
                                Callback callback)
        Deprecated.
        Asynchronous send of whole content.
        Parameters:
        content - The whole content to send
        callback - The callback to use to notify success or failure
      • sendContent

        public void sendContent​(java.io.InputStream in,
                                Callback callback)
        Deprecated.
        Asynchronous send of stream content. The stream will be closed after reading all content.
        Parameters:
        in - The stream content to send
        callback - The callback to use to notify success or failure
      • sendContent

        public void sendContent​(java.nio.channels.ReadableByteChannel in,
                                Callback callback)
        Deprecated.
        Asynchronous send of channel content. The channel will be closed after reading all content.
        Parameters:
        in - The channel content to send
        callback - The callback to use to notify success or failure
      • sendContent

        public void sendContent​(HttpContent httpContent,
                                Callback callback)
        Deprecated.
        Asynchronous send of HTTP content.
        Parameters:
        httpContent - The HTTP content to send
        callback - The callback to use to notify success or failure
      • getBufferSize

        public int getBufferSize()
        Deprecated.
      • setBufferSize

        public void setBufferSize​(int size)
        Deprecated.
      • onFlushed

        public void onFlushed​(long bytes)
                       throws java.io.IOException
        Deprecated.

        Invoked when bytes have been flushed to the network.

        The number of flushed bytes may be different from the bytes written by the application if an HttpOutput.Interceptor changed them, for example by compressing them.

        Parameters:
        bytes - the number of bytes flushed
        Throws:
        java.io.IOException - if the minimum data rate, when set, is not respected
        See Also:
        WriteFlusher.Listener
      • recycle

        public void recycle()
        Deprecated.
      • resetBuffer

        public void resetBuffer()
        Deprecated.
      • run

        public void run()
        Deprecated.
        Specified by:
        run in interface java.lang.Runnable
      • toString

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