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 and 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 and Description
protected boolean	ajpFlush Send AJP flush packet when flushing.

Fields inherited from class org.apache.coyote.AbstractProcessor

adapter, asyncStateMachine, endpoint, request, response, socketWrapper, sslSupport

Constructor Summary

Constructors

Constructor and Description
AjpProcessor(int packetSize, AbstractEndpoint<?> endpoint)

Method Summary

Modifier and Type	Method and Description
void	action(ActionCode actionCode, Object param) Send an action to the connector.
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 boolean	flushBufferedWrite() Flush any pending writes.
boolean	getAjpFlush()
String	getClientCertProvider()
int	getKeepAliveTimeout()
ByteBuffer	getLeftoverInput() Allows retrieving additional input during the upgrade process
protected Log	getLog()
boolean	getTomcatAuthentication()
boolean	getTomcatAuthorization()
UpgradeToken	getUpgradeToken()
boolean	isUpgrade()
void	pause() Informs the processor that the underlying I/O layer has stopped accepting new connections.
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.
AbstractEndpoint.Handler.SocketState	service(SocketWrapperBase<?> socket) Service a 'standard' HTTP request.
void	setAjpFlush(boolean ajpFlush)
void	setClientCertProvider(String clientCertProvider)
void	setKeepAliveTimeout(int timeout)
void	setRequiredSecret(String requiredSecret)
void	setTomcatAuthentication(boolean tomcatAuthentication)
void	setTomcatAuthorization(boolean tomcatAuthorization)

Methods inherited from class org.apache.coyote.AbstractProcessor

asyncPostProcess, dispatch, getAdapter, getAsyncTimeout, getErrorState, getExecutor, getRequest, getSocketWrapper, isAsync, setAdapter, setAsyncTimeout, setErrorState, setSocketWrapper, setSslSupport, timeoutAsync

Methods inherited from class org.apache.coyote.AbstractProcessorLight

addDispatch, clearDispatches, getIteratorAndClearDispatches, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

public void setRequiredSecret(String requiredSecret)

getClientCertProvider

public String getClientCertProvider()

setClientCertProvider

public void setClientCertProvider(String clientCertProvider)

action

public final void action(ActionCode actionCode,
                         Object param)

Description copied from interface: ActionHook

Send an action to the connector.

Parameters:

actionCode - Type of the action

param - Action parameter

flushBufferedWrite

protected boolean flushBufferedWrite()
                              throws 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 class AbstractProcessor

Returns:

true if 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: AbstractProcessor

Perform any necessary processing for a non-blocking read before dispatching to the adapter.

Overrides:

dispatchNonBlockingRead in class AbstractProcessor

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 class AbstractProcessor

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: 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 to AbstractProcessorLight.dispatch(SocketEvent). Requests may be pipe-lined.

Specified by:

service in 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

getUpgradeToken

public UpgradeToken getUpgradeToken()

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 interface Processor

Overrides:

recycle in class AbstractProcessor

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.

isUpgrade

public final boolean isUpgrade()

getLeftoverInput

public ByteBuffer getLeftoverInput()

Description copied from interface: Processor

Allows retrieving additional input during the upgrade process

Returns:

leftover bytes

refillReadBuffer

protected boolean refillReadBuffer(boolean block)
                            throws 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:

IOException - An IO error occurred

getLog

protected Log getLog()

Specified by:

getLog in class AbstractProcessorLight