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
FieldsModifier and TypeFieldDescriptionprotected intMaximum timeout on uploads. 5 minutes as in Apache HTTPD server.protected booleanContent delimiter for the request (if false, the connection will be closed at the end of the request).protected booleanFlag to disable setting a different time-out on uploads.protected booleanHTTP/0.9 flag.protected booleanHTTP/1.1 flag.protected final Http11InputBufferInput.protected booleanKeep-alive.protected intMaximum number of Keep-Alive requests to honor.protected intMax saved post size.protected booleanFlag used to indicate that the socket should be kept open (e.g. for keep alive or send file).protected final Http11OutputBufferOutput.protected booleanFlag that indicates if the request headers have been completely read.protected PatternRegular expression that defines the restricted user agents.protected SendfileDataBaseSendfile data.protected UpgradeTokenInstance of the new protocol to use after the HTTP connection has been upgraded.Fields inherited from class org.apache.coyote.AbstractProcessor
adapter, asyncStateMachine, endpoint, hostNameC, request, response, socketWrapper, sslSupport, userDataHelper -
Constructor Summary
ConstructorsConstructorDescriptionHttp11Processor(AbstractHttp11Protocol<?> protocol, AbstractEndpoint<?, ?> endpoint) -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidack()protected final voidack(ContinueResponseTiming continueResponseTiming) protected final intavailable(boolean doRead) protected final voidprotected 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 final voidprotected final voidflush()protected booleanFlush any pending writes.Deprecated.intGet the upload timeout.booleanGet the flag that controls upload time-outs.Allows retrieving additional input during the upgrade process.protected LoggetLog()intGet the maximum number of Keep-Alive requests allowed.intReturn the maximum size of a POST which will be buffered in SSL mode.Generate an upgrade token.protected final booleanprotected final booleanbooleanProcessors 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 voidservice(SocketWrapperBase<?> socketWrapper) Service a 'standard' HTTP request.voidsetCompressableMimeTypes(String[] compressibleMimeTypes) Deprecated.voidsetCompressibleMimeTypes(String[] compressibleMimeTypes) Deprecated.voidsetCompression(String compression) Deprecated.voidsetCompressionMinSize(int compressionMinSize) Deprecated.voidsetConnectionUploadTimeout(int timeout) Set the upload timeout.voidsetDisableUploadTimeout(boolean isDisabled) Set the flag to control whether a separate connection timeout is used during upload of a request body.voidsetMaxKeepAliveRequests(int mkar) Set the maximum number of Keep-Alive requests to allow.voidsetMaxSavePostSize(int msps) Set the maximum size of a POST which will be buffered in SSL mode.voidsetNoCompressionUserAgents(String noCompressionUserAgents) Deprecated.protected final voidsetRequestBody(ByteChunk body) voidsetRestrictedUserAgents(String restrictedUserAgents) Set restricted user agent list (which will downgrade the connector to HTTP/1.0 mode).voidDeprecated.voidsetServerRemoveAppProvidedValues(boolean serverRemoveAppProvidedValues) Deprecated.protected final voidsetSocketWrapper(SocketWrapperBase<?> socketWrapper) Set the socket wrapper being used.protected final voidprotected 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, executeDispatches, getAdapter, getAsyncTimeout, getConnectionID, getErrorState, getExecutor, getPopulateRequestAttributesFromSocket, getRequest, getSocketWrapper, getStreamID, isAsync, isPushSupported, isReadyForRead, logAccess, parseHost, populateHost, populateRequestAttributeRemoteHost, populateSslRequestAttributes, processSocketEvent, setAdapter, setAsyncTimeout, setErrorState, setSslSupport, timeoutAsyncMethods inherited from class org.apache.coyote.AbstractProcessorLight
addDispatch, clearDispatches, getIteratorAndClearDispatches, process
-
Field Details
-
inputBuffer
Input. -
outputBuffer
Output. -
keepAlive
protected volatile boolean keepAliveKeep-alive. -
openSocket
protected volatile boolean openSocketFlag used to indicate that the socket should be kept open (e.g. for keep alive or send file). -
readComplete
protected volatile boolean readCompleteFlag that indicates if the request headers have been completely read. -
http11
protected boolean http11HTTP/1.1 flag. -
http09
protected boolean http09HTTP/0.9 flag. -
contentDelimitation
protected boolean contentDelimitationContent delimiter for the request (if false, the connection will be closed at the end of the request). -
restrictedUserAgents
Regular expression that defines the restricted user agents. -
maxKeepAliveRequests
protected int maxKeepAliveRequestsMaximum number of Keep-Alive requests to honor. -
connectionUploadTimeout
protected int connectionUploadTimeoutMaximum timeout on uploads. 5 minutes as in Apache HTTPD server. -
disableUploadTimeout
protected boolean disableUploadTimeoutFlag to disable setting a different time-out on uploads. -
maxSavePostSize
protected int maxSavePostSizeMax saved post size. -
upgradeToken
Instance of the new protocol to use after the HTTP connection has been upgraded. -
sendfileData
Sendfile data.
-
-
Constructor Details
-
Http11Processor
-
-
Method Details
-
setCompression
Deprecated.Set compression level.- Parameters:
compression- One ofon,force,offor the minimum compression size in bytes which implieson
-
setCompressionMinSize
Deprecated.Set Minimum size to trigger compression.- Parameters:
compressionMinSize- The minimum content length required for compression in bytes
-
setNoCompressionUserAgents
Deprecated.Set no compression user agent pattern. Regular expression as supported byPattern. e.g.:gorilla|desesplorer|tigrus.- Parameters:
noCompressionUserAgents- The regular expression for user agent strings for which compression should not be applied
-
setCompressableMimeTypes
Deprecated.- Parameters:
compressibleMimeTypes- SeesetCompressibleMimeTypes(String[])
-
setCompressibleMimeTypes
Deprecated.Set compressible mime-type list.- Parameters:
compressibleMimeTypes- MIME types for which compression should be enabled
-
getCompression
Deprecated.Return compression level.- Returns:
- The current compression level in string form (off/on/force)
-
setRestrictedUserAgents
Set restricted user agent list (which will downgrade the connector to HTTP/1.0 mode). Regular expression as supported byPattern.- Parameters:
restrictedUserAgents- The regular expression as supported byPatternfor the user agents e.g. "gorilla|desesplorer|tigrus"
-
setMaxKeepAliveRequests
public void setMaxKeepAliveRequests(int mkar) Set the maximum number of Keep-Alive requests to allow. This is to safeguard from DoS attacks. Setting to a negative value disables the limit.- Parameters:
mkar- The new maximum number of Keep-Alive requests allowed
-
getMaxKeepAliveRequests
public int getMaxKeepAliveRequests()Get the maximum number of Keep-Alive requests allowed. A negative value means there is no limit.- Returns:
- the number of Keep-Alive requests that we will allow.
-
setMaxSavePostSize
public void setMaxSavePostSize(int msps) Set the maximum size of a POST which will be buffered in SSL mode. When a POST is received where the security constraints require a client certificate, the POST body needs to be buffered while an SSL handshake takes place to obtain the certificate.- Parameters:
msps- The maximum size POST body to buffer in bytes
-
getMaxSavePostSize
public int getMaxSavePostSize()Return the maximum size of a POST which will be buffered in SSL mode.- Returns:
- The size in bytes
-
setDisableUploadTimeout
public void setDisableUploadTimeout(boolean isDisabled) Set the flag to control whether a separate connection timeout is used during upload of a request body.- Parameters:
isDisabled-trueif the separate upload timeout should be disabled
-
getDisableUploadTimeout
public boolean getDisableUploadTimeout()Get the flag that controls upload time-outs.- Returns:
trueif the separate upload timeout is disabled
-
setConnectionUploadTimeout
public void setConnectionUploadTimeout(int timeout) Set the upload timeout.- Parameters:
timeout- Upload timeout in milliseconds
-
getConnectionUploadTimeout
public int getConnectionUploadTimeout()Get the upload timeout.- Returns:
- Upload timeout in milliseconds
-
setServer
Deprecated.Set the server header name.- Parameters:
server- The new value to use for the server header
-
setServerRemoveAppProvidedValues
Deprecated. -
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
When 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
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
-
finishResponse
- Specified by:
finishResponsein classAbstractProcessor- Throws:
IOException
-
ack
protected final void ack()- Overrides:
ackin classAbstractProcessor
-
ack
- Specified by:
ackin classAbstractProcessor
-
flush
- Specified by:
flushin classAbstractProcessor- Throws:
IOException
-
available
protected final int available(boolean doRead) - Specified by:
availablein classAbstractProcessor
-
setRequestBody
- Specified by:
setRequestBodyin classAbstractProcessor
-
setSwallowResponse
protected final void setSwallowResponse()- Specified by:
setSwallowResponsein classAbstractProcessor
-
disableSwallowRequest
protected final void disableSwallowRequest()- 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
-
registerReadInterest
protected final void registerReadInterest()- Specified by:
registerReadInterestin classAbstractProcessor
-
isReadyForWrite
protected final boolean isReadyForWrite()- Specified by:
isReadyForWritein classAbstractProcessor
-
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
-
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.
-
AbstractHttp11Protocol.getCompression()