Package org.apache.coyote.http11
Class Http11Processor
java.lang.Object
org.apache.coyote.AbstractProcessorLight
org.apache.coyote.AbstractProcessor
org.apache.coyote.http11.Http11Processor
- All Implemented Interfaces:
ActionHook,Processor
-
Field Summary
Fields inherited from class org.apache.coyote.AbstractProcessor
adapter, asyncStateMachine, request, response, socketWrapper, sslSupport, userDataHelper -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidack(ContinueResponseTiming continueResponseTiming) Process acknowledgment of the request.protected final intavailable(boolean doRead) Queries if bytes are available in buffers.protected final voidSwallowing bytes is required for pipelining requests, so this allows to avoid doing extra operations in case an error occurs and the connection is to be closed instead.protected AbstractEndpoint.Handler.SocketStatePerform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.protected final voiddoHttpUpgrade(UpgradeToken upgradeToken) Process an HTTP upgrade.protected voidprotected final voidFinish the current response.protected final voidflush()Callback to write data from the buffer.protected booleanFlush any pending writes.Allows retrieving additional input during the upgrade process.protected LoggetLog()protected ServletConnectionProtocols must override this method and return an appropriate ServletConnection instanceGenerate an upgrade token.protected final booleanprotected final booleanprotected booleanprotected booleanProtocols that support trailer fields should override this method and returntrue.booleanProcessors that implement HTTP upgrade must override this method.voidpause()Informs the processor that the underlying I/O layer has stopped accepting new connections.protected voidCalled when a host header is not present or is empty in the request (e.g.protected final voidWhen committing the response, we have to validate the set of headers, as well as setup the response filters.final voidrecycle()Recycle the processor, ready for the next request which may be on the same connection or a different connection.protected final voidWhen using non blocking IO, register to get a callback when polling determines that bytes are available for reading.service(SocketWrapperBase<?> socketWrapper) Service a 'standard' HTTP request.protected final voidsetRequestBody(ByteChunk body) Set the specified byte chunk as the request body that will be read.protected final voidsetSocketWrapper(SocketWrapperBase<?> socketWrapper) Set the socket wrapper being used.protected final voidThe response is finished and no additional bytes need to be sent to the client.protected final voidProcessors that can perform a TLS re-handshake (e.g.Methods inherited from class org.apache.coyote.AbstractProcessor
action, asyncPostProcess, checkAsyncTimeoutGeneration, dispatch, dispatchNonBlockingRead, doPush, execute, executeDispatches, getAdapter, getAsyncTimeout, getErrorState, getPopulateRequestAttributesFromSocket, getProtocolRequestId, getRequest, getSocketWrapper, isAsync, isPushSupported, isReadyForRead, logAccess, parseHost, populateHost, populateRequestAttributeRemoteHost, populateSslRequestAttributes, processSocketEvent, setAsyncTimeout, setErrorState, setSslSupport, timeoutAsyncMethods inherited from class org.apache.coyote.AbstractProcessorLight
addDispatch, clearDispatches, getIteratorAndClearDispatches, process
-
Constructor Details
-
Http11Processor
-
-
Method Details
-
service
public AbstractEndpoint.Handler.SocketState service(SocketWrapperBase<?> socketWrapper) throws IOException Description copied from class:AbstractProcessorLightService a 'standard' HTTP request. This method is called for both new requests and for requests that have partially read the HTTP request line or HTTP headers. Once the headers have been fully read this method is not called again until there is a new HTTP request to process. Note that the request type may change during processing which may result in one or more calls toAbstractProcessorLight.dispatch(SocketEvent). Requests may be pipe-lined.- Specified by:
servicein classAbstractProcessorLight- Parameters:
socketWrapper- The connection to process- Returns:
- The state the caller should put the socket in when this method returns
- Throws:
IOException- If an I/O error occurs during the processing of the request
-
setSocketWrapper
Description copied from class:AbstractProcessorSet the socket wrapper being used.- Overrides:
setSocketWrapperin classAbstractProcessor- Parameters:
socketWrapper- The socket wrapper
-
prepareResponse
Description copied from class:AbstractProcessorWhen committing the response, we have to validate the set of headers, as well as setup the response filters.- Specified by:
prepareResponsein classAbstractProcessor- Throws:
IOException- IO exception during commit
-
populatePort
protected void populatePort()Called when a host header is not present or is empty in the request (e.g. HTTP/1.0). It populates the server port with appropriate information. The source is expected to vary by protocol.The default implementation is a NO-OP.
This implementation provides the server port from the local port.
- Overrides:
populatePortin classAbstractProcessor
-
flushBufferedWrite
Description copied from class:AbstractProcessorFlush any pending writes. Used during non-blocking writes to flush any remaining data from a previous incomplete write.- Specified by:
flushBufferedWritein classAbstractProcessor- Returns:
trueif data remains to be flushed at the end of method- Throws:
IOException- If an I/O error occurs while attempting to flush the data
-
dispatchEndRequest
Description copied from class:AbstractProcessorPerform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.- Specified by:
dispatchEndRequestin classAbstractProcessor- Returns:
- The state to return for the socket once the clean-up for the current request has completed
-
getLog
- Specified by:
getLogin classAbstractProcessorLight- Returns:
- the logger associated with this processor type
-
getServletConnection
Description copied from class:AbstractProcessorProtocols must override this method and return an appropriate ServletConnection instance- Specified by:
getServletConnectionin classAbstractProcessor- Returns:
- the ServletConnection instance associated with the current request.
-
finishResponse
Description copied from class:AbstractProcessorFinish the current response.- Specified by:
finishResponsein classAbstractProcessor- Throws:
IOException- IO exception during the write
-
ack
Description copied from class:AbstractProcessorProcess acknowledgment of the request.- Specified by:
ackin classAbstractProcessor- Parameters:
continueResponseTiming- specifies when an acknowledgment should be sent
-
earlyHints
- Specified by:
earlyHintsin classAbstractProcessor- Throws:
IOException
-
flush
Description copied from class:AbstractProcessorCallback to write data from the buffer.- Specified by:
flushin classAbstractProcessor- Throws:
IOException- IO exception during the write
-
available
protected final int available(boolean doRead) Description copied from class:AbstractProcessorQueries if bytes are available in buffers.- Specified by:
availablein classAbstractProcessor- Parameters:
doRead-trueto perform a read when no bytes are availble- Returns:
- the amount of bytes that are known to be available
-
setRequestBody
Description copied from class:AbstractProcessorSet the specified byte chunk as the request body that will be read. This allows saving and processing requests.- Specified by:
setRequestBodyin classAbstractProcessor- Parameters:
body- the byte chunk containing all the request bytes
-
setSwallowResponse
protected final void setSwallowResponse()Description copied from class:AbstractProcessorThe response is finished and no additional bytes need to be sent to the client.- Specified by:
setSwallowResponsein classAbstractProcessor
-
disableSwallowRequest
protected final void disableSwallowRequest()Description copied from class:AbstractProcessorSwallowing bytes is required for pipelining requests, so this allows to avoid doing extra operations in case an error occurs and the connection is to be closed instead.- Specified by:
disableSwallowRequestin classAbstractProcessor
-
sslReHandShake
Description copied from class:AbstractProcessorProcessors that can perform a TLS re-handshake (e.g. HTTP/1.1) should override this method and implement the re-handshake.- Overrides:
sslReHandShakein classAbstractProcessor- Throws:
IOException- If authentication is required then there will be I/O with the client and this exception will be thrown if that goes wrong
-
isRequestBodyFullyRead
protected final boolean isRequestBodyFullyRead()- Specified by:
isRequestBodyFullyReadin classAbstractProcessor- Returns:
trueif it is known that the request body has been fully read
-
registerReadInterest
protected final void registerReadInterest()Description copied from class:AbstractProcessorWhen using non blocking IO, register to get a callback when polling determines that bytes are available for reading.- Specified by:
registerReadInterestin classAbstractProcessor
-
isReadyForWrite
protected final boolean isReadyForWrite()- Specified by:
isReadyForWritein classAbstractProcessor- Returns:
trueif bytes can be written without blocking
-
getUpgradeToken
Description copied from class:AbstractProcessorGenerate an upgrade token. Processors that implement HTTP upgrade must override this method and provide the necessary token.- Specified by:
getUpgradeTokenin interfaceProcessor- Overrides:
getUpgradeTokenin classAbstractProcessor- Returns:
- An upgrade token encapsulating the information required to process the upgrade request
-
doHttpUpgrade
Description copied from class:AbstractProcessorProcess an HTTP upgrade. Processors that support HTTP upgrade should override this method and process the provided token.- Overrides:
doHttpUpgradein classAbstractProcessor- Parameters:
upgradeToken- Contains all the information necessary for the Processor to process the upgrade
-
getLeftoverInput
Description copied from class:AbstractProcessorAllows retrieving additional input during the upgrade process. Processors that implement HTTP upgrade must override this method.- Specified by:
getLeftoverInputin interfaceProcessor- Overrides:
getLeftoverInputin classAbstractProcessor- Returns:
- leftover bytes
-
isUpgrade
public boolean isUpgrade()Description copied from class:AbstractProcessorProcessors that implement HTTP upgrade must override this method.- Specified by:
isUpgradein interfaceProcessor- Overrides:
isUpgradein classAbstractProcessor- Returns:
trueif the Processor is currently processing an upgrade request, otherwisefalse
-
isTrailerFieldsReady
protected boolean isTrailerFieldsReady()- Specified by:
isTrailerFieldsReadyin classAbstractProcessor
-
isTrailerFieldsSupported
protected boolean isTrailerFieldsSupported()Description copied from class:AbstractProcessorProtocols that support trailer fields should override this method and returntrue.- Overrides:
isTrailerFieldsSupportedin classAbstractProcessor- Returns:
trueif trailer fields are supported by this processor, otherwisefalse.
-
recycle
public final void recycle()Description copied from interface:ProcessorRecycle the processor, ready for the next request which may be on the same connection or a different connection.- Specified by:
recyclein interfaceProcessor- Overrides:
recyclein classAbstractProcessor
-
pause
public void pause()Description copied from interface:ProcessorInforms the processor that the underlying I/O layer has stopped accepting new connections. This is primarily intended to enable processors that use multiplexed connections to prevent further 'streams' being added to an existing multiplexed connection.
-