Package org.apache.coyote.http11.filters
Class SavedRequestInputFilter
- java.lang.Object
- 
- org.apache.coyote.http11.filters.SavedRequestInputFilter
 
- 
- All Implemented Interfaces:
- InputFilter,- InputBuffer
 
 public class SavedRequestInputFilter extends java.lang.Object implements InputFilter Input filter responsible for replaying the request body when restoring the saved request after FORM authentication.
- 
- 
Constructor SummaryConstructors Constructor Description SavedRequestInputFilter(ByteChunk input)Create a new SavedRequestInputFilter.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intavailable()Amount of bytes still available in a buffer.intdoRead(ByteChunk chunk)Deprecated.Unused.intdoRead(ApplicationBufferHandler handler)Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.longend()End the current request (has no effect).ByteChunkgetEncodingName()Return the name of the associated encoding; here, the value is null.booleanisFinished()Has the request body been read fully?voidrecycle()Make the filter ready to process the next request.voidsetBuffer(InputBuffer buffer)Set the next buffer in the filter pipeline (has no effect).voidsetRequest(Request request)Set the content length on the request.
 
- 
- 
- 
Field Detail- 
inputprotected ByteChunk input The original request body.
 
- 
 - 
Constructor Detail- 
SavedRequestInputFilterpublic SavedRequestInputFilter(ByteChunk input) Create a new SavedRequestInputFilter.- Parameters:
- input- The saved request body to be replayed.
 
 
- 
 - 
Method Detail- 
doRead@Deprecated public int doRead(ByteChunk chunk) throws java.io.IOException Deprecated.Unused. Will be removed in Tomcat 9. UsedoRead(ApplicationBufferHandler)Description copied from interface:InputBufferRead from the input stream into the given buffer. IMPORTANT: the current model assumes that the protocol will 'own' the buffer and return a pointer to it in ByteChunk (i.e. the param will have chunk.getBytes()==null before call, and the result after the call).- Specified by:
- doReadin interface- InputBuffer
- Parameters:
- chunk- 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
 
 - 
doReadpublic int doRead(ApplicationBufferHandler handler) throws java.io.IOException Description copied from interface:InputBufferRead 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:
- doReadin 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
 
 - 
setRequestpublic void setRequest(Request request) Set the content length on the request.- Specified by:
- setRequestin interface- InputFilter
- Parameters:
- request- The request to be associated with this filter
 
 - 
recyclepublic void recycle() Make the filter ready to process the next request.- Specified by:
- recyclein interface- InputFilter
 
 - 
getEncodingNamepublic ByteChunk getEncodingName() Return the name of the associated encoding; here, the value is null.- Specified by:
- getEncodingNamein 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
 
 - 
setBufferpublic void setBuffer(InputBuffer buffer) Set the next buffer in the filter pipeline (has no effect).- Specified by:
- setBufferin interface- InputFilter
- Parameters:
- buffer- The next buffer
 
 - 
availablepublic int available() Amount of bytes still available in a buffer.- Specified by:
- availablein interface- InputBuffer
- Returns:
- The number of bytes that can be read without blocking
 
 - 
endpublic long end() throws java.io.IOExceptionEnd the current request (has no effect).- Specified by:
- endin 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
 
 - 
isFinishedpublic boolean isFinished() Description copied from interface:InputFilterHas the request body been read fully?- Specified by:
- isFinishedin interface- InputFilter
- Returns:
- trueif the request body has been fully read, otherwise- false
 
 
- 
 
-