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
AJP Processor implementation.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classThis class is an input buffer which will read its data from an input stream.protected classThis class is an output buffer which will write data to an output stream.
- 
Field SummaryFields inherited from class org.apache.coyote.AbstractProcessoradapter, asyncStateMachine, request, response, socketWrapper, sslSupport, userDataHelper
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected 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 voidPerform any necessary processing for a non-blocking read before dispatching to the adapter.protected final voidFinish AJP response.protected final voidflush()Callback to write data from the buffer.protected booleanFlush any pending writes.protected LoggetLog()protected final booleanProcessors that populate request attributes directly (e.g.protected ServletConnectionProtocols must override this method and return an appropriate ServletConnection instanceprotected final booleanprotected final booleanprotected booleanvoidpause()Informs the processor that the underlying I/O layer has stopped accepting new connections.protected voidCalled when a host header is not present in the request (e.g.protected voidCalled when a host header is not present or is empty in the request (e.g.protected final voidPopulate the remote host request attribute.protected final voidPopulate the TLS related request attributes from theSSLSupportinstance associated with this processor.protected final voidWhen 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 final voidservice(SocketWrapperBase<?> socket) Service a 'standard' HTTP request.protected final voidsetRequestBody(ByteChunk body) protected final voidMethods inherited from class org.apache.coyote.AbstractProcessoraction, asyncPostProcess, checkAsyncTimeoutGeneration, dispatch, doHttpUpgrade, doPush, execute, executeDispatches, getAdapter, getAsyncTimeout, getErrorState, getLeftoverInput, getProtocolRequestId, getRequest, getSocketWrapper, getUpgradeToken, isAsync, isPushSupported, isReadyForRead, isTrailerFieldsSupported, isUpgrade, logAccess, parseHost, processSocketEvent, setAsyncTimeout, setErrorState, setSocketWrapper, setSslSupport, sslReHandShake, timeoutAsyncMethods inherited from class org.apache.coyote.AbstractProcessorLightaddDispatch, clearDispatches, getIteratorAndClearDispatches, process
- 
Constructor Details- 
AjpProcessor
 
- 
- 
Method Details- 
flushBufferedWriteDescription 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 class- AbstractProcessor
- 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
 
- 
dispatchNonBlockingReadprotected void dispatchNonBlockingRead()Description copied from class:AbstractProcessorPerform any necessary processing for a non-blocking read before dispatching to the adapter.- Overrides:
- dispatchNonBlockingReadin class- AbstractProcessor
 
- 
dispatchEndRequestDescription 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 class- AbstractProcessor
- Returns:
- The state to return for the socket once the clean-up for the current request has completed
 
- 
serviceDescription 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 class- AbstractProcessorLight
- 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
 
- 
recyclepublic 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 interface- Processor
- Overrides:
- recyclein class- AbstractProcessor
 
- 
pausepublic 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.
- 
refillReadBufferGet 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
 
- 
populateHostprotected 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 class- AbstractProcessor
 
- 
populatePortprotected 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 class- AbstractProcessor
 
- 
prepareResponseWhen committing the response, we have to validate the set of headers, as well as setup the response filters.- Specified by:
- prepareResponsein class- AbstractProcessor
- Throws:
- IOException
 
- 
flushCallback to write data from the buffer.- Specified by:
- flushin class- AbstractProcessor
- Throws:
- IOException
 
- 
finishResponseFinish AJP response.- Specified by:
- finishResponsein class- AbstractProcessor
- Throws:
- IOException
 
- 
ack- Specified by:
- ackin class- AbstractProcessor
 
- 
availableprotected final int available(boolean doRead) - Specified by:
- availablein class- AbstractProcessor
 
- 
setRequestBody- Specified by:
- setRequestBodyin class- AbstractProcessor
 
- 
setSwallowResponseprotected final void setSwallowResponse()- Specified by:
- setSwallowResponsein class- AbstractProcessor
 
- 
disableSwallowRequestprotected final void disableSwallowRequest()- Specified by:
- disableSwallowRequestin class- AbstractProcessor
 
- 
getPopulateRequestAttributesFromSocketprotected 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 class- AbstractProcessor
- Returns:
- trueif the SocketWrapper should be used to populate the request attributes, otherwise- false.
 
- 
populateRequestAttributeRemoteHostprotected 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 class- AbstractProcessor
 
- 
populateSslRequestAttributesprotected 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 class- AbstractProcessor
 
- 
isRequestBodyFullyReadprotected final boolean isRequestBodyFullyRead()- Specified by:
- isRequestBodyFullyReadin class- AbstractProcessor
 
- 
registerReadInterestprotected final void registerReadInterest()- Specified by:
- registerReadInterestin class- AbstractProcessor
 
- 
isReadyForWriteprotected final boolean isReadyForWrite()- Specified by:
- isReadyForWritein class- AbstractProcessor
 
- 
isTrailerFieldsReadyprotected boolean isTrailerFieldsReady()- Specified by:
- isTrailerFieldsReadyin class- AbstractProcessor
 
- 
getLog- Specified by:
- getLogin class- AbstractProcessorLight
 
- 
getServletConnectionDescription copied from class:AbstractProcessorProtocols must override this method and return an appropriate ServletConnection instance- Specified by:
- getServletConnectionin class- AbstractProcessor
- Returns:
- the ServletConnection instance associated with the current request.
 
 
-