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 class
AjpProcessor.SocketInputBuffer
This class is an input buffer which will read its data from an input stream.protected class
AjpProcessor.SocketOutputBuffer
This class is an output buffer which will write data to an output stream.
-
Field Summary
Fields Modifier and Type Field Description protected boolean
ajpFlush
Send 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 void
ack(ContinueResponseTiming continueResponseTiming)
protected int
available(boolean doRead)
protected void
disableSwallowRequest()
protected AbstractEndpoint.Handler.SocketState
dispatchEndRequest()
Perform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.protected void
dispatchNonBlockingRead()
Perform any necessary processing for a non-blocking read before dispatching to the adapter.protected void
finishResponse()
Finish AJP response.protected void
flush()
Callback to write data from the buffer.protected boolean
flushBufferedWrite()
Flush any pending writes.boolean
getAjpFlush()
java.lang.String
getClientCertProvider()
int
getKeepAliveTimeout()
protected Log
getLog()
protected boolean
getPopulateRequestAttributesFromSocket()
Processors that populate request attributes directly (e.g.boolean
getTomcatAuthentication()
boolean
getTomcatAuthorization()
protected boolean
isReadyForWrite()
protected boolean
isRequestBodyFullyRead()
void
pause()
Informs the processor that the underlying I/O layer has stopped accepting new connections.protected void
populateHost()
Called when a host header is not present in the request (e.g.protected void
populatePort()
Called when a host header is not present or is empty in the request (e.g.protected void
populateRequestAttributeRemoteHost()
Populate the remote host request attribute.protected void
populateSslRequestAttributes()
Populate the TLS related request attributes from theSSLSupport
instance associated with this processor.protected void
prepareResponse()
When committing the response, we have to validate the set of headers, as well as setup the response filters.void
recycle()
Recycle the processor, ready for the next request which may be on the same connection or a different connection.protected boolean
refillReadBuffer(boolean block)
Get more request body data from the web server and store it in the internal buffer.protected void
registerReadInterest()
AbstractEndpoint.Handler.SocketState
service(SocketWrapperBase<?> socket)
Service a 'standard' HTTP request.void
setAjpFlush(boolean ajpFlush)
void
setAllowedRequestAttributesPattern(java.util.regex.Pattern allowedRequestAttributesPattern)
void
setClientCertProvider(java.lang.String clientCertProvider)
void
setKeepAliveTimeout(int timeout)
protected void
setRequestBody(ByteChunk body)
void
setRequiredSecret(java.lang.String requiredSecret)
Deprecated.void
setSecret(java.lang.String secret)
protected void
setSwallowResponse()
void
setTomcatAuthentication(boolean tomcatAuthentication)
void
setTomcatAuthorization(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(java.lang.String requiredSecret)
Deprecated.
-
setSecret
public void setSecret(java.lang.String secret)
-
getClientCertProvider
public java.lang.String getClientCertProvider()
-
setClientCertProvider
public void setClientCertProvider(java.lang.String clientCertProvider)
-
setAllowedRequestAttributesPattern
public void setAllowedRequestAttributesPattern(java.util.regex.Pattern allowedRequestAttributesPattern)
-
flushBufferedWrite
protected boolean flushBufferedWrite() throws java.io.IOException
Description copied from class:AbstractProcessor
Flush any pending writes. Used during non-blocking writes to flush any remaining data from a previous incomplete write.- Specified by:
flushBufferedWrite
in classAbstractProcessor
- Returns:
true
if data remains to be flushed at the end of method- Throws:
java.io.IOException
- If an I/O error occurs while attempting to flush the data
-
dispatchNonBlockingRead
protected void dispatchNonBlockingRead()
Description copied from class:AbstractProcessor
Perform any necessary processing for a non-blocking read before dispatching to the adapter.- Overrides:
dispatchNonBlockingRead
in classAbstractProcessor
-
dispatchEndRequest
protected AbstractEndpoint.Handler.SocketState dispatchEndRequest()
Description copied from class:AbstractProcessor
Perform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.- Specified by:
dispatchEndRequest
in 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 java.io.IOException
Description copied from class:AbstractProcessorLight
Service 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:
service
in classAbstractProcessorLight
- Parameters:
socket
- The connection to process- Returns:
- The state the caller should put the socket in when this method returns
- Throws:
java.io.IOException
- If an I/O error occurs during the processing of the request
-
recycle
public void recycle()
Description copied from interface:Processor
Recycle the processor, ready for the next request which may be on the same connection or a different connection.- Specified by:
recycle
in interfaceProcessor
- Overrides:
recycle
in classAbstractProcessor
-
pause
public void pause()
Description copied from interface:Processor
Informs 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 java.io.IOException
Get more request body data from the web server and store it in the internal buffer.- Parameters:
block
-true
if this is blocking IO- Returns:
true
if there is more data,false
if not.- Throws:
java.io.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:
populateHost
in 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:
populatePort
in classAbstractProcessor
-
prepareResponse
protected final void prepareResponse() throws java.io.IOException
When committing the response, we have to validate the set of headers, as well as setup the response filters.- Specified by:
prepareResponse
in classAbstractProcessor
- Throws:
java.io.IOException
-
flush
protected final void flush() throws java.io.IOException
Callback to write data from the buffer.- Specified by:
flush
in classAbstractProcessor
- Throws:
java.io.IOException
-
finishResponse
protected final void finishResponse() throws java.io.IOException
Finish AJP response.- Specified by:
finishResponse
in classAbstractProcessor
- Throws:
java.io.IOException
-
ack
protected final void ack(ContinueResponseTiming continueResponseTiming)
- Specified by:
ack
in classAbstractProcessor
-
available
protected final int available(boolean doRead)
- Specified by:
available
in classAbstractProcessor
-
setRequestBody
protected final void setRequestBody(ByteChunk body)
- Specified by:
setRequestBody
in classAbstractProcessor
-
setSwallowResponse
protected final void setSwallowResponse()
- Specified by:
setSwallowResponse
in classAbstractProcessor
-
disableSwallowRequest
protected final void disableSwallowRequest()
- Specified by:
disableSwallowRequest
in classAbstractProcessor
-
getPopulateRequestAttributesFromSocket
protected final boolean getPopulateRequestAttributesFromSocket()
Description copied from class:AbstractProcessor
Processors that populate request attributes directly (e.g. AJP) should over-ride this method and returnfalse
.- Overrides:
getPopulateRequestAttributesFromSocket
in classAbstractProcessor
- Returns:
true
if the SocketWrapper should be used to populate the request attributes, otherwisefalse
.
-
populateRequestAttributeRemoteHost
protected final void populateRequestAttributeRemoteHost()
Description copied from class:AbstractProcessor
Populate the remote host request attribute. Processors (e.g. AJP) that populate this from an alternative source should override this method.- Overrides:
populateRequestAttributeRemoteHost
in classAbstractProcessor
-
populateSslRequestAttributes
protected final void populateSslRequestAttributes()
Description copied from class:AbstractProcessor
Populate the TLS related request attributes from theSSLSupport
instance associated with this processor. Protocols that populate TLS attributes from a different source (e.g. AJP) should override this method.- Overrides:
populateSslRequestAttributes
in classAbstractProcessor
-
isRequestBodyFullyRead
protected final boolean isRequestBodyFullyRead()
- Specified by:
isRequestBodyFullyRead
in classAbstractProcessor
-
registerReadInterest
protected final void registerReadInterest()
- Specified by:
registerReadInterest
in classAbstractProcessor
-
isReadyForWrite
protected final boolean isReadyForWrite()
- Specified by:
isReadyForWrite
in classAbstractProcessor
-
getLog
protected Log getLog()
- Specified by:
getLog
in classAbstractProcessorLight
-
-