Package org.apache.coyote.http11
Class Http11OutputBuffer
- java.lang.Object
-
- org.apache.coyote.http11.Http11OutputBuffer
-
- All Implemented Interfaces:
HttpOutputBuffer,OutputBuffer
public class Http11OutputBuffer extends Object implements HttpOutputBuffer
Provides buffering for the HTTP headers (allowing responses to be reset before they have been committed) and the link to the Socket for writing the headers (once committed) and the response body. Note that buffering of the response body happens at a higher level.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classHttp11OutputBuffer.SocketOutputBufferThis class is an output buffer which will write data to a socket.
-
Field Summary
Fields Modifier and Type Field Description protected OutputFilter[]activeFiltersActive filters for the current request.protected longbyteCountBytes written to client for the current requestprotected OutputFilter[]filterLibraryFilter library for processing the response body.protected ByteBufferheaderBufferThe buffer used for header composition.protected intlastActiveFilterIndex of the last active filter.protected HttpOutputBufferoutputStreamOutputBufferUnderlying output buffer.protected ResponseresponseAssociated Coyote response.protected booleanresponseFinishedFinished flag.protected static StringManagersmThe string manager for this package.protected SocketWrapperBase<?>socketWrapperWrapper for socket where data will be written to.
-
Constructor Summary
Constructors Modifier Constructor Description protectedHttp11OutputBuffer(Response response, int headerBufferSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddActiveFilter(OutputFilter filter)Add an output filter to the active filters for the current response.voidaddFilter(OutputFilter filter)Add an output filter to the filter library.protected voidcommit()Commit the response.intdoWrite(ByteBuffer chunk)Write the given data to the response.voidend()Finish writing the current response.voidendHeaders()End the header block.voidflush()Flush the response.protected booleanflushBuffer(boolean block)Writes any remaining buffered data.longgetBytesWritten()Bytes written to the underlying socket.OutputFilter[]getFilters()Get filters.booleanhasDataToWrite()voidinit(SocketWrapperBase<?> socketWrapper)protected booleanisBlocking()Is standard Servlet blocking IO being used for output?protected booleanisReady()voidnextRequest()End processing of current HTTP request.voidrecycle()Recycle the output buffer.voidregisterWriteInterest()voidsendAck()voidsendHeader(MessageBytes name, MessageBytes value)Send a header.voidsendStatus()Send the response status line.voidwrite(byte[] b)This method will write the contents of the specified byte buffer to the output stream, without filtering.
-
-
-
Field Detail
-
sm
protected static final StringManager sm
The string manager for this package.
-
response
protected final Response response
Associated Coyote response.
-
responseFinished
protected boolean responseFinished
Finished flag.
-
headerBuffer
protected final ByteBuffer headerBuffer
The buffer used for header composition.
-
filterLibrary
protected OutputFilter[] filterLibrary
Filter library for processing the response body.
-
activeFilters
protected OutputFilter[] activeFilters
Active filters for the current request.
-
lastActiveFilter
protected int lastActiveFilter
Index of the last active filter.
-
outputStreamOutputBuffer
protected HttpOutputBuffer outputStreamOutputBuffer
Underlying output buffer.
-
socketWrapper
protected SocketWrapperBase<?> socketWrapper
Wrapper for socket where data will be written to.
-
byteCount
protected long byteCount
Bytes written to client for the current request
-
-
Constructor Detail
-
Http11OutputBuffer
protected Http11OutputBuffer(Response response, int headerBufferSize)
-
-
Method Detail
-
addFilter
public void addFilter(OutputFilter filter)
Add an output filter to the filter library. Note that calling this method resets the currently active filters to none.- Parameters:
filter- The filter to add
-
getFilters
public OutputFilter[] getFilters()
Get filters.- Returns:
- The current filter library containing all possible filters
-
addActiveFilter
public void addActiveFilter(OutputFilter filter)
Add an output filter to the active filters for the current response.The filter does not have to be present in
getFilters().A filter can only be added to a response once. If the filter has already been added to this response then this method will be a NO-OP.
- Parameters:
filter- The filter to add
-
doWrite
public int doWrite(ByteBuffer chunk) throws IOException
Description copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
doWritein interfaceOutputBuffer- Parameters:
chunk- data to write- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
IOException- an underlying I/O error occurred
-
getBytesWritten
public long getBytesWritten()
Description copied from interface:OutputBufferBytes written to the underlying socket. This includes the effects of chunking, compression, etc.- Specified by:
getBytesWrittenin interfaceOutputBuffer- Returns:
- Bytes written for the current request
-
flush
public void flush() throws IOExceptionFlush the response.- Specified by:
flushin interfaceHttpOutputBuffer- Throws:
IOException- an underlying I/O error occurred
-
end
public void end() throws IOExceptionDescription copied from interface:HttpOutputBufferFinish writing the current response. It is acceptable to write extra bytes usingOutputBuffer.doWrite(java.nio.ByteBuffer)during the execution of this method.- Specified by:
endin interfaceHttpOutputBuffer- Throws:
IOException- If an I/O error occurs while writing to the client
-
recycle
public void recycle()
Recycle the output buffer. This should be called when closing the connection.
-
nextRequest
public void nextRequest()
End processing of current HTTP request. Note: All bytes of the current request should have been already consumed. This method only resets all the pointers so that we are ready to parse the next HTTP request.
-
init
public void init(SocketWrapperBase<?> socketWrapper)
-
sendAck
public void sendAck() throws IOException- Throws:
IOException
-
commit
protected void commit() throws IOExceptionCommit the response.- Throws:
IOException- an underlying I/O error occurred
-
sendStatus
public void sendStatus()
Send the response status line.
-
sendHeader
public void sendHeader(MessageBytes name, MessageBytes value)
Send a header.- Parameters:
name- Header namevalue- Header value
-
endHeaders
public void endHeaders()
End the header block.
-
write
public void write(byte[] b)
This method will write the contents of the specified byte buffer to the output stream, without filtering. This method is meant to be used to write the response header.- Parameters:
b- data to be written
-
flushBuffer
protected boolean flushBuffer(boolean block) throws IOExceptionWrites any remaining buffered data.- Parameters:
block- Should this method block until the buffer is empty- Returns:
trueif data remains in the buffer (which can only happen in non-blocking mode) elsefalse.- Throws:
IOException- Error writing data
-
isBlocking
protected final boolean isBlocking()
Is standard Servlet blocking IO being used for output?- Returns:
trueif this is blocking IO
-
isReady
protected final boolean isReady()
-
hasDataToWrite
public boolean hasDataToWrite()
-
registerWriteInterest
public void registerWriteInterest()
-
-