Package org.apache.coyote.http11.filters

Class ChunkedInputFilter

    • Constructor Summary

      Constructors 
      Constructor Description
      ChunkedInputFilter​(Request request, int maxTrailerSize, java.util.Set<java.lang.String> allowedTrailerHeaders, int maxExtensionSize, int maxSwallowSize)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Obtain an estimate of the number of bytes that can be read without blocking.
      int doRead​(ApplicationBufferHandler handler)
      Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.
      long end()
      End the current request.
      void expand​(int size)
      Expand the byte buffer to at least the given size.
      boolean fillHeaderBuffer()
      Read more data into the header buffer.
      java.nio.ByteBuffer getByteBuffer()  
      ByteChunk getEncodingName()
      Get the name of the encoding handled by this filter.
      java.nio.ByteBuffer getHeaderByteBuffer()
      Obtain a reference to the buffer containing the header data.
      boolean isFinished()
      Has the request body been read fully?
      protected int readBytes()
      Read bytes from the previous buffer.
      void recycle()
      Make the filter ready to process the next request.
      void setBuffer​(InputBuffer buffer)
      Set the next buffer in the filter pipeline.
      void setByteBuffer​(java.nio.ByteBuffer buffer)
      Set the byte buffer.
      void setRequest​(Request request)
      Some filters need additional parameters from the request.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ENCODING

        protected static final ByteChunk ENCODING

      • buffer

        protected InputBuffer buffer
        Next buffer in the pipeline.

      • remaining

        protected int remaining
        Number of bytes remaining in the current chunk.

      • readChunk

        protected java.nio.ByteBuffer readChunk
        Byte chunk used to read bytes.

      • trailingHeaders

        protected final java.nio.ByteBuffer trailingHeaders
        Buffer used to store trailing headers. Is normally in read mode.

    • Constructor Detail

      • ChunkedInputFilter

        public ChunkedInputFilter​(Request request,
                          int maxTrailerSize,
                          java.util.Set<java.lang.String> allowedTrailerHeaders,
                          int maxExtensionSize,
                          int maxSwallowSize)

    • Method Detail

      • doRead

        public int doRead​(ApplicationBufferHandler handler)
           throws java.io.IOException
        Description copied from interface: InputBuffer
        Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler. IMPORTANT: the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.
        Specified by:
        doRead in interface InputBuffer
        Parameters:
        handler - ApplicationBufferHandler that provides the buffer to read data into.
        Returns:
        The number of bytes that have been added to the buffer or -1 for end of stream
        Throws:
        java.io.IOException - If an I/O error occurs reading from the input stream

      • setRequest

        public void setRequest​(Request request)
        Description copied from interface: InputFilter
        Some filters need additional parameters from the request.
        Specified by:
        setRequest in interface InputFilter
        Parameters:
        request - The request to be associated with this filter

      • end

        public long end()
         throws java.io.IOException
        Description copied from interface: InputFilter
        End the current request.
        Specified by:
        end in interface InputFilter
        Returns:
        0 is the expected return value. A positive value indicates that too many bytes were read. This method is allowed to use buffer.doRead to consume extra bytes. The result of this method can't be negative (if an error happens, an IOException should be thrown instead).
        Throws:
        java.io.IOException - If an error happens

      • available

        public int available()
        Description copied from interface: InputBuffer
        Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.
        Specified by:
        available in interface InputBuffer
        Returns:
        The number of bytes that can be read without blocking

      • setBuffer

        public void setBuffer​(InputBuffer buffer)
        Description copied from interface: InputFilter
        Set the next buffer in the filter pipeline.
        Specified by:
        setBuffer in interface InputFilter
        Parameters:
        buffer - The next buffer

      • recycle

        public void recycle()
        Description copied from interface: InputFilter
        Make the filter ready to process the next request.
        Specified by:
        recycle in interface InputFilter

      • getEncodingName

        public ByteChunk getEncodingName()
        Description copied from interface: InputFilter
        Get the name of the encoding handled by this filter.
        Specified by:
        getEncodingName in interface InputFilter
        Returns:
        The encoding name as a byte chunk to facilitate comparison with the value read from the HTTP headers which will also be a ByteChunk

      • isFinished

        public boolean isFinished()
        Description copied from interface: InputFilter
        Has the request body been read fully?
        Specified by:
        isFinished in interface InputFilter
        Returns:
        true if the request body has been fully read, otherwise false

      • readBytes

        protected int readBytes()
                 throws java.io.IOException
        Read bytes from the previous buffer.
        Returns:
        The byte count which has been read
        Throws:
        java.io.IOException - Read error

      • fillHeaderBuffer

        public boolean fillHeaderBuffer()
                         throws java.io.IOException
        Description copied from interface: HttpHeaderParser.HeaderDataSource
        Read more data into the header buffer. The implementation is expected to determine if blocking or not blocking IO should be used.
        Specified by:
        fillHeaderBuffer in interface HttpHeaderParser.HeaderDataSource
        Returns:
        true if more data was added to the buffer, otherwise false
        Throws:
        java.io.IOException - If an I/O error occurred while obtaining more header data

      • expand

        public void expand​(int size)
        Description copied from interface: ApplicationBufferHandler
        Expand the byte buffer to at least the given size. Some implementations may not implement this.
        Specified by:
        expand in interface ApplicationBufferHandler
        Parameters:
        size - the desired size