Package org.apache.coyote.ajp
Class AjpProcessor
- java.lang.Object
-
- org.apache.coyote.AbstractProcessorLight
-
- org.apache.coyote.AbstractProcessor
-
- org.apache.coyote.ajp.AjpProcessor
-
- All Implemented Interfaces:
ActionHook,Processor
public class AjpProcessor extends AbstractProcessor
AJP Processor implementation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classAjpProcessor.SocketInputBufferThis class is an input buffer which will read its data from an input stream.protected classAjpProcessor.SocketOutputBufferThis class is an output buffer which will write data to an output stream.
-
Field Summary
Fields Modifier and Type Field Description protected booleanajpFlushSend AJP flush packet when flushing.-
Fields inherited from class org.apache.coyote.AbstractProcessor
adapter, asyncStateMachine, endpoint, hostNameC, request, response, socketWrapper, sslSupport, userDataHelper
-
-
Constructor Summary
Constructors Constructor Description AjpProcessor(int packetSize, AbstractEndpoint<?,?> endpoint)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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 voiddispatchNonBlockingRead()Perform any necessary processing for a non-blocking read before dispatching to the adapter.protected voidfinishResponse()Finish AJP response.protected voidflush()Callback to write data from the buffer.protected booleanflushBufferedWrite()Flush any pending writes.booleangetAjpFlush()StringgetClientCertProvider()intgetKeepAliveTimeout()protected LoggetLog()protected booleangetPopulateRequestAttributesFromSocket()Processors that populate request attributes directly (e.g.booleangetTomcatAuthentication()booleangetTomcatAuthorization()protected booleanisReadyForWrite()protected booleanisRequestBodyFullyRead()voidpause()Informs the processor that the underlying I/O layer has stopped accepting new connections.protected voidpopulateHost()Called when a host header is not present in the request (e.g.protected voidpopulatePort()Called when a host header is not present or is empty in the request (e.g.protected voidpopulateRequestAttributeRemoteHost()Populate the remote host request attribute.protected voidpopulateSslRequestAttributes()Populate the TLS related request attributes from theSSLSupportinstance associated with this processor.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 booleanrefillReadBuffer(boolean block)Get more request body data from the web server and store it in the internal buffer.protected voidregisterReadInterest()AbstractEndpoint.Handler.SocketStateservice(SocketWrapperBase<?> socket)Service a 'standard' HTTP request.voidsetAjpFlush(boolean ajpFlush)voidsetAllowedRequestAttributesPattern(Pattern allowedRequestAttributesPattern)voidsetClientCertProvider(String clientCertProvider)voidsetKeepAliveTimeout(int timeout)protected voidsetRequestBody(ByteChunk body)voidsetRequiredSecret(String requiredSecret)Deprecated.voidsetSecret(String secret)protected voidsetSwallowResponse()voidsetTomcatAuthentication(boolean tomcatAuthentication)voidsetTomcatAuthorization(boolean tomcatAuthorization)-
Methods inherited from class org.apache.coyote.AbstractProcessor
ack, action, asyncPostProcess, checkAsyncTimeoutGeneration, dispatch, doHttpUpgrade, doPush, executeDispatches, getAdapter, getAsyncTimeout, getConnectionID, getErrorState, getExecutor, getLeftoverInput, getRequest, getSocketWrapper, getStreamID, getUpgradeToken, isAsync, isPushSupported, isReadyForRead, isUpgrade, logAccess, parseHost, processSocketEvent, setAdapter, setAsyncTimeout, setErrorState, setSocketWrapper, setSslSupport, sslReHandShake, timeoutAsync
-
Methods inherited from class org.apache.coyote.AbstractProcessorLight
addDispatch, clearDispatches, getIteratorAndClearDispatches, process
-
-
-
-
Field Detail
-
ajpFlush
protected boolean ajpFlush
Send AJP flush packet when flushing. An flush packet is a zero byte AJP13 SEND_BODY_CHUNK packet. mod_jk and mod_proxy_ajp interprete this as a request to flush data to the client. AJP always does flush at the and of the response, so if it is not important, that the packets get streamed up to the client, do not use extra flush packets. For compatibility and to stay on the safe side, flush packets are enabled by default.
-
-
Constructor Detail
-
AjpProcessor
public AjpProcessor(int packetSize, AbstractEndpoint<?,?> endpoint)
-
-
Method Detail
-
getAjpFlush
public boolean getAjpFlush()
-
setAjpFlush
public void setAjpFlush(boolean ajpFlush)
-
getKeepAliveTimeout
public int getKeepAliveTimeout()
-
setKeepAliveTimeout
public void setKeepAliveTimeout(int timeout)
-
getTomcatAuthentication
public boolean getTomcatAuthentication()
-
setTomcatAuthentication
public void setTomcatAuthentication(boolean tomcatAuthentication)
-
getTomcatAuthorization
public boolean getTomcatAuthorization()
-
setTomcatAuthorization
public void setTomcatAuthorization(boolean tomcatAuthorization)
-
setRequiredSecret
@Deprecated public void setRequiredSecret(String requiredSecret)
Deprecated.
-
setSecret
public void setSecret(String secret)
-
getClientCertProvider
public String getClientCertProvider()
-
setClientCertProvider
public void setClientCertProvider(String clientCertProvider)
-
setAllowedRequestAttributesPattern
public void setAllowedRequestAttributesPattern(Pattern allowedRequestAttributesPattern)
-
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
-
dispatchNonBlockingRead
protected void dispatchNonBlockingRead()
Description copied from class:AbstractProcessorPerform any necessary processing for a non-blocking read before dispatching to the adapter.- Overrides:
dispatchNonBlockingReadin classAbstractProcessor
-
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
-
service
public AbstractEndpoint.Handler.SocketState service(SocketWrapperBase<?> socket) 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:
socket- 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
-
recycle
public 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.
-
refillReadBuffer
protected boolean refillReadBuffer(boolean block) throws IOExceptionGet more request body data from the web server and store it in the internal buffer.- Parameters:
block-trueif this is blocking IO- Returns:
trueif there is more data,falseif not.- Throws:
IOException- An IO error occurred
-
populateHost
protected void populateHost()
Called when a host header is not present in the request (e.g. HTTP/1.0). It populates the server name with appropriate information. The source is expected to vary by protocol.The default implementation is a NO-OP.
This implementation populates the server name from the local name provided by the AJP message.
- Overrides:
populateHostin classAbstractProcessor
-
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 populates the server port from the local port provided by the AJP message.
- Overrides:
populatePortin classAbstractProcessor
-
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
-
flush
protected final void flush() throws IOExceptionCallback to write data from the buffer.- Specified by:
flushin classAbstractProcessor- Throws:
IOException
-
finishResponse
protected final void finishResponse() throws IOExceptionFinish AJP response.- Specified by:
finishResponsein classAbstractProcessor- Throws:
IOException
-
ack
protected final void ack(ContinueResponseTiming continueResponseTiming)
- Specified by:
ackin classAbstractProcessor
-
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
-
getPopulateRequestAttributesFromSocket
protected final boolean getPopulateRequestAttributesFromSocket()
Description copied from class:AbstractProcessorProcessors that populate request attributes directly (e.g. AJP) should over-ride this method and returnfalse.- Overrides:
getPopulateRequestAttributesFromSocketin classAbstractProcessor- Returns:
trueif the SocketWrapper should be used to populate the request attributes, otherwisefalse.
-
populateRequestAttributeRemoteHost
protected final void populateRequestAttributeRemoteHost()
Description copied from class:AbstractProcessorPopulate the remote host request attribute. Processors (e.g. AJP) that populate this from an alternative source should override this method.- Overrides:
populateRequestAttributeRemoteHostin classAbstractProcessor
-
populateSslRequestAttributes
protected final void populateSslRequestAttributes()
Description copied from class:AbstractProcessorPopulate the TLS related request attributes from theSSLSupportinstance associated with this processor. Protocols that populate TLS attributes from a different source (e.g. AJP) should override this method.- Overrides:
populateSslRequestAttributesin classAbstractProcessor
-
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
-
getLog
protected Log getLog()
- Specified by:
getLogin classAbstractProcessorLight
-
-