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
public class Http11Processor extends AbstractProcessor
-
-
Field Summary
-
Fields inherited from class org.apache.coyote.AbstractProcessor
adapter, asyncStateMachine, request, response, socketWrapper, sslSupport, userDataHelper
-
-
Constructor Summary
Constructors Constructor Description Http11Processor(AbstractHttp11Protocol<?> protocol, Adapter adapter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidack(ContinueResponseTiming continueResponseTiming)protected intavailable(boolean doRead)protected voiddisableSwallowRequest()protected AbstractEndpoint.Handler.SocketStatedispatchEndRequest()Perform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.protected voiddoHttpUpgrade(UpgradeToken upgradeToken)Process an HTTP upgrade.protected voidfinishResponse()protected voidflush()protected booleanflushBufferedWrite()Flush any pending writes.ByteBuffergetLeftoverInput()Allows retrieving additional input during the upgrade process.protected LoggetLog()UpgradeTokengetUpgradeToken()Generate an upgrade token.protected booleanisReadyForWrite()protected booleanisRequestBodyFullyRead()protected booleanisTrailerFieldsReady()protected booleanisTrailerFieldsSupported()Protocols that support trailer fields should override this method and returntrue.booleanisUpgrade()Processors that implement HTTP upgrade must override this method.voidpause()Informs the processor that the underlying I/O layer has stopped accepting new connections.protected voidpopulatePort()Called when a host header is not present or is empty in the request (e.g.protected voidprepareResponse()When committing the response, we have to validate the set of headers, as well as setup the response filters.voidrecycle()Recycle the processor, ready for the next request which may be on the same connection or a different connection.protected voidregisterReadInterest()AbstractEndpoint.Handler.SocketStateservice(SocketWrapperBase<?> socketWrapper)Service a 'standard' HTTP request.protected voidsetRequestBody(ByteChunk body)protected voidsetSocketWrapper(SocketWrapperBase<?> socketWrapper)Set the socket wrapper being used.protected voidsetSwallowResponse()protected voidsslReHandShake()Processors 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, getConnectionID, getErrorState, getPopulateRequestAttributesFromSocket, getRequest, getSocketWrapper, getStreamID, isAsync, isPushSupported, isReadyForRead, logAccess, parseHost, populateHost, populateRequestAttributeRemoteHost, populateSslRequestAttributes, processSocketEvent, setAsyncTimeout, setErrorState, setSslSupport, timeoutAsync
-
Methods inherited from class org.apache.coyote.AbstractProcessorLight
addDispatch, clearDispatches, getIteratorAndClearDispatches, process
-
-
-
-
Constructor Detail
-
Http11Processor
public Http11Processor(AbstractHttp11Protocol<?> protocol, Adapter adapter)
-
-
Method Detail
-
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
protected final void setSocketWrapper(SocketWrapperBase<?> socketWrapper)
Description copied from class:AbstractProcessorSet the socket wrapper being used.- Overrides:
setSocketWrapperin classAbstractProcessor- Parameters:
socketWrapper- The socket wrapper
-
prepareResponse
protected final void prepareResponse() throws IOExceptionWhen committing the response, we have to validate the set of headers, as well as setup the response filters.- Specified by:
prepareResponsein classAbstractProcessor- Throws:
IOException
-
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
protected boolean flushBufferedWrite() throws IOExceptionDescription 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
protected AbstractEndpoint.Handler.SocketState 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
protected Log getLog()
- Specified by:
getLogin classAbstractProcessorLight
-
finishResponse
protected final void finishResponse() throws IOException- Specified by:
finishResponsein classAbstractProcessor- Throws:
IOException
-
ack
protected final void ack(ContinueResponseTiming continueResponseTiming)
- Specified by:
ackin classAbstractProcessor
-
flush
protected final void flush() throws IOException- Specified by:
flushin classAbstractProcessor- Throws:
IOException
-
available
protected final int available(boolean doRead)
- Specified by:
availablein classAbstractProcessor
-
setRequestBody
protected final void setRequestBody(ByteChunk body)
- Specified by:
setRequestBodyin classAbstractProcessor
-
setSwallowResponse
protected final void setSwallowResponse()
- Specified by:
setSwallowResponsein classAbstractProcessor
-
disableSwallowRequest
protected final void disableSwallowRequest()
- Specified by:
disableSwallowRequestin classAbstractProcessor
-
sslReHandShake
protected final void sslReHandShake() throws IOExceptionDescription 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
-
registerReadInterest
protected final void registerReadInterest()
- Specified by:
registerReadInterestin classAbstractProcessor
-
isReadyForWrite
protected final boolean isReadyForWrite()
- Specified by:
isReadyForWritein classAbstractProcessor
-
getUpgradeToken
public UpgradeToken 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
protected final void doHttpUpgrade(UpgradeToken upgradeToken)
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
public ByteBuffer 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.
-
-