AbstractAjpProcessor (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.coyote.AbstractProcessor<S>
- - org.apache.coyote.ajp.AbstractAjpProcessor<S>

All Implemented Interfaces:

ActionHook, Processor<S>

Direct Known Subclasses:

AjpAprProcessor, AjpNio2Processor, AjpNioProcessor, AjpProcessor
```
public abstract class AbstractAjpProcessor<S>
extends AbstractProcessor<S>
```
Base class for AJP Processor implementations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractAjpProcessor.SocketInputBuffer` This class is an input buffer which will read its data from an input stream.
`protected class`	`AbstractAjpProcessor.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.
`protected MessageBytes`	`bodyBytes` Body message.
`protected AjpMessage`	`bodyMessage` Body message.
`protected long`	`bytesWritten` Bytes written to client for the current request.
`protected MessageBytes`	`certificates` Byte chunk for certs.
`protected java.lang.String`	`clientCertProvider` When client certificate information is presented in a form other than instances of `X509Certificate` it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion.
`protected boolean`	`empty` Request body empty flag.
`protected static byte[]`	`endAndCloseMessageArray`
`protected static byte[]`	`endMessageArray` End message array.
`protected boolean`	`endOfStream` End of stream flag.
`protected boolean`	`finished` Finished response.
`protected boolean`	`first` First read.
`protected static byte[]`	`flushMessageArray` Flush message array.
`protected byte[]`	`getBodyMessageArray` GetBody message array.
`protected int`	`keepAliveTimeout` The number of milliseconds Tomcat will wait for a subsequent request before closing the connection.
`protected static byte[]`	`pongMessageArray` Pong message array.
`protected boolean`	`replay` Replay read.
`protected AjpMessage`	`requestHeaderMessage` Header message.
`protected java.lang.String`	`requiredSecret` Required secret.
`protected AjpMessage`	`responseMessage` Message used for response composition.
`protected static StringManager`	`sm` The string manager for this package.
`protected MessageBytes`	`tmpMB` Temp message bytes used for processing.
`protected boolean`	`tomcatAuthentication` Use Tomcat authentication ?

Fields inherited from class org.apache.coyote.AbstractProcessor
adapter, asyncStateMachine, endpoint, hostNameC, request, response, socketWrapper, userDataHelper

Constructor Summary

Constructors
Constructor and Description

AbstractAjpProcessor(int packetSize, AbstractEndpoint<S> endpoint)

Constructors
Constructor and Description
`AbstractAjpProcessor(int packetSize, AbstractEndpoint<S> endpoint)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`action(ActionCode actionCode, java.lang.Object param)` Send an action to the connector.
`AbstractEndpoint.Handler.SocketState`	`asyncDispatch(SocketStatus status)` Process in-progress Servlet 3.0 Async requests.
`AbstractEndpoint.Handler.SocketState`	`event(SocketStatus status)` Process in-progress Comet requests.
`protected void`	`finish()` Finish AJP response.
`protected void`	`flush(boolean explicit)` Callback to write data from the buffer.
`boolean`	`getAjpFlush()`
`java.lang.String`	`getClientCertProvider()`
`int`	`getKeepAliveTimeout()`
`java.nio.ByteBuffer`	`getLeftoverInput()` Allows retrieving additional input during the upgrade process
`boolean`	`getTomcatAuthentication()`
`boolean`	`getTomcatAuthorization()`
`UpgradeToken`	`getUpgradeToken()`
`boolean`	`isComet()`
`boolean`	`isUpgrade()`
`protected abstract int`	`output(byte[] src, int offset, int length, boolean block)`
`protected void`	`populateHost()` Called when a host name is not present in the request (e.g.
`protected void`	`prepareRequest()` After reading the request headers, we have to setup the request filters.
`protected void`	`prepareResponse()` When committing the response, we have to validate the set of headers, as well as setup the response filters.
`AbstractEndpoint.Handler.SocketState`	`process(SocketWrapper<S> socket)` Process pipelined HTTP requests using the specified input and output streams.
`protected abstract boolean`	`read(byte[] buf, int pos, int n, boolean block)` Read at least the specified amount of bytes, and place them in the input buffer.
`protected boolean`	`readMessage(AjpMessage message, boolean block)` Read an AJP message.
`protected boolean`	`receive(boolean block)` Read an AJP body message.
`void`	`recycle(boolean socketClosing)` 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 abstract void`	`resetTimeouts()` Provides a mechanism for those connector implementations (currently only NIO) that need to reset timeouts from Async timeouts to standard HTTP timeouts once async processing completes.
`void`	`setAjpFlush(boolean ajpFlush)`
`void`	`setClientCertProvider(java.lang.String s)`
`void`	`setKeepAliveTimeout(int timeout)`
`void`	`setRequiredSecret(java.lang.String requiredSecret)`
`void`	`setSslSupport(SSLSupport sslSupport)`
`protected abstract void`	`setTimeout(SocketWrapper<S> socketWrapper, int timeout)`
`void`	`setTomcatAuthentication(boolean tomcatAuthentication)`
`void`	`setTomcatAuthorization(boolean tomcatAuthorization)`
`protected abstract void`	`setupSocket(SocketWrapper<S> socketWrapper)`
`AbstractEndpoint.Handler.SocketState`	`upgradeDispatch(SocketStatus status)` Processes data received on a connection that has been through an HTTP upgrade.

Methods inherited from class org.apache.coyote.AbstractProcessor
asyncPostProcess, errorDispatch, getAdapter, getEndpoint, getErrorState, getExecutor, getLog, getMaxCookieCount, getRequest, getSocketWrapper, isAsync, parseHost, registerForEvent, resetErrorState, setAdapter, setErrorState, setMaxCookieCount, setSocketWrapper

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
    The string manager for this package.
  - endMessageArray
```
protected static final byte[] endMessageArray
```
    End message array.
  - endAndCloseMessageArray
```
protected static final byte[] endAndCloseMessageArray
```
  - flushMessageArray
```
protected static final byte[] flushMessageArray
```
    Flush message array.
  - pongMessageArray
```
protected static final byte[] pongMessageArray
```
    Pong message array.
  - getBodyMessageArray
```
protected final byte[] getBodyMessageArray
```
    GetBody message array. Not static like the other message arrays since the message varies with packetSize and that can vary per connector.
  - requestHeaderMessage
```
protected final AjpMessage requestHeaderMessage
```
    Header message. Note that this header is merely the one used during the processing of the first message of a "request", so it might not be a request header. It will stay unchanged during the processing of the whole request.
  - responseMessage
```
protected final AjpMessage responseMessage
```
    Message used for response composition.
  - bodyMessage
```
protected final AjpMessage bodyMessage
```
    Body message.
  - bodyBytes
```
protected final MessageBytes bodyBytes
```
    Body message.
  - tmpMB
```
protected final MessageBytes tmpMB
```
    Temp message bytes used for processing.
  - certificates
```
protected final MessageBytes certificates
```
    Byte chunk for certs.
  - endOfStream
```
protected boolean endOfStream
```
    End of stream flag.
  - empty
```
protected boolean empty
```
    Request body empty flag.
  - first
```
protected boolean first
```
    First read.
  - replay
```
protected boolean replay
```
    Replay read.
  - finished
```
protected boolean finished
```
    Finished response.
  - bytesWritten
```
protected long bytesWritten
```
    Bytes written to client for the current request.
  - 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.
  - keepAliveTimeout
```
protected int keepAliveTimeout
```
    The number of milliseconds Tomcat will wait for a subsequent request before closing the connection. The default is -1 which is an infinite timeout.
  - tomcatAuthentication
```
protected boolean tomcatAuthentication
```
    Use Tomcat authentication ?
  - requiredSecret
```
protected java.lang.String requiredSecret
```
    Required secret.
  - clientCertProvider
```
protected java.lang.String clientCertProvider
```
    When client certificate information is presented in a form other than instances of X509Certificate it needs to be converted before it can be used and this property controls which JSSE provider is used to perform the conversion. For example it is used with the AJP connectors, the HTTP APR connector and with the SSLValve. If not specified, the default provider will be used.
- Constructor Detail
  - AbstractAjpProcessor
```
public AbstractAjpProcessor(int packetSize,
                    AbstractEndpoint<S> 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(java.lang.String requiredSecret)
```
  - getClientCertProvider
```
public java.lang.String getClientCertProvider()
```
  - setClientCertProvider
```
public void setClientCertProvider(java.lang.String s)
```
  - action
```
public final void action(ActionCode actionCode,
          java.lang.Object param)
```
    Send an action to the connector.
    
    Parameters:
    actionCode - Type of the action
    param - Action parameter
  - asyncDispatch
```
public AbstractEndpoint.Handler.SocketState asyncDispatch(SocketStatus status)
```
    Description copied from class: AbstractProcessor
    
    Process in-progress Servlet 3.0 Async requests. These will start as HTTP requests.
    
    Specified by:
    
    asyncDispatch in interface Processor<S>
    
    Specified by:
    
    asyncDispatch in class AbstractProcessor<S>
  - process
```
public AbstractEndpoint.Handler.SocketState process(SocketWrapper<S> socket)
                                             throws java.io.IOException
```
    Process pipelined HTTP requests using the specified input and output streams.
    
    Specified by:
    
    process in interface Processor<S>
    
    Specified by:
    
    process in class AbstractProcessor<S>
    
    Throws:
    
    java.io.IOException - error during an I/O operation
  - setSslSupport
```
public void setSslSupport(SSLSupport sslSupport)
```
  - event
```
public AbstractEndpoint.Handler.SocketState event(SocketStatus status)
                                           throws java.io.IOException
```
    Description copied from class: AbstractProcessor
    
    Process in-progress Comet requests. These will start as HTTP requests.
    
    Specified by:
    
    event in interface Processor<S>
    
    Specified by:
    
    event in class AbstractProcessor<S>
    
    Throws:
    
    java.io.IOException
  - upgradeDispatch
```
public AbstractEndpoint.Handler.SocketState upgradeDispatch(SocketStatus status)
                                                     throws java.io.IOException
```
    Description copied from class: AbstractProcessor
    
    Processes data received on a connection that has been through an HTTP upgrade.
    
    Specified by:
    
    upgradeDispatch in interface Processor<S>
    
    Specified by:
    
    upgradeDispatch in class AbstractProcessor<S>
    
    Throws:
    
    java.io.IOException
  - getUpgradeToken
```
public UpgradeToken getUpgradeToken()
```
    Specified by:
    
    getUpgradeToken in interface Processor<S>
    
    Specified by:
    
    getUpgradeToken in class AbstractProcessor<S>
  - recycle
```
public void recycle(boolean socketClosing)
```
    Recycle the processor, ready for the next request which may be on the same connection or a different connection.
    
    Parameters:
    socketClosing - Indicates if the socket is about to be closed allowing the processor to perform any additional clean-up that may be required
  - resetTimeouts
```
protected abstract void resetTimeouts()
```
    Provides a mechanism for those connector implementations (currently only NIO) that need to reset timeouts from Async timeouts to standard HTTP timeouts once async processing completes.
  - output
```
protected abstract int output(byte[] src,
         int offset,
         int length,
         boolean block)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setupSocket
```
protected abstract void setupSocket(SocketWrapper<S> socketWrapper)
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setTimeout
```
protected abstract void setTimeout(SocketWrapper<S> socketWrapper,
              int timeout)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - read
```
protected abstract boolean read(byte[] buf,
           int pos,
           int n,
           boolean block)
                         throws java.io.IOException
```
    Read at least the specified amount of bytes, and place them in the input buffer. Note that if any data is available to read then this method will always block until at least the specified number of bytes have been read.
    
    Parameters:
    buf - Buffer to read data into
    pos - Start position
    n - The minimum number of bytes to read
    block - If there is no data available to read when this method is called, should this call block until data becomes available?
    
    Returns:
    true if the requested number of bytes were read else false
    
    Throws:
    
    java.io.IOException
  - receive
```
protected boolean receive(boolean block)
                   throws java.io.IOException
```
    Read an AJP body message. Used to read both the 'special' packet in ajp13 and to receive the data after we send a GET_BODY packet.
    
    Parameters:
    block - If there is no data available to read when this method is called, should this call block until data becomes available?
    
    Returns:
    true if at least one body byte was read, otherwise false
    
    Throws:
    
    java.io.IOException
  - readMessage
```
protected boolean readMessage(AjpMessage message,
                  boolean block)
                       throws java.io.IOException
```
    Read an AJP message.
    
    Parameters:
    message - The message to populate
    block - If there is no data available to read when this method is called, should this call block until data becomes available?
    
    Returns:
    true if the message has been read, false if no data was read
    
    Throws:
    
    java.io.IOException - any other failure, including incomplete reads
  - isComet
```
public final boolean isComet()
```
    Specified by:
    
    isComet in interface Processor<S>
    
    Specified by:
    
    isComet in class AbstractProcessor<S>
  - isUpgrade
```
public final boolean isUpgrade()
```
    Specified by:
    
    isUpgrade in interface Processor<S>
    
    Specified by:
    
    isUpgrade in class AbstractProcessor<S>
  - getLeftoverInput
```
public java.nio.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 java.io.IOException
```
    Get more request body data from the web server and store it in the internal buffer.
    
    Returns:
    true if there is more data, false if not.
    
    Throws:
    
    java.io.IOException
  - prepareRequest
```
protected void prepareRequest()
```
    After reading the request headers, we have to setup the request filters.
  - populateHost
```
protected void populateHost()
```
    Called when a host name is not present in the request (e.g. HTTP/1.0). It populates the server name and port with appropriate information. The source is expected to vary by protocol.
    The default implementation is a NO-OP.
    This implementation populates the server name and port from the local name and port provided by the AJP message.
    
    Overrides:
    
    populateHost in class AbstractProcessor<S>
  - prepareResponse
```
protected 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.
    
    Throws:
    
    java.io.IOException
  - flush
```
protected void flush(boolean explicit)
              throws java.io.IOException
```
    Callback to write data from the buffer.
    
    Throws:
    
    java.io.IOException
  - finish
```
protected void finish()
               throws java.io.IOException
```
    Finish AJP response.
    
    Throws:
    
    java.io.IOException

Class AbstractAjpProcessor<S>

Nested Class Summary

Field Summary

Fields inherited from class org.apache.coyote.AbstractProcessor

Constructor Summary

Method Summary

Methods inherited from class org.apache.coyote.AbstractProcessor

Methods inherited from class java.lang.Object

Field Detail

sm

endMessageArray

endAndCloseMessageArray

flushMessageArray

pongMessageArray

getBodyMessageArray

requestHeaderMessage

responseMessage

bodyMessage

bodyBytes

tmpMB

certificates

endOfStream

empty

first

replay

finished

bytesWritten

ajpFlush

keepAliveTimeout

tomcatAuthentication

requiredSecret

clientCertProvider

Constructor Detail

AbstractAjpProcessor

Method Detail

getAjpFlush

setAjpFlush

getKeepAliveTimeout

setKeepAliveTimeout

getTomcatAuthentication

setTomcatAuthentication

getTomcatAuthorization

setTomcatAuthorization

setRequiredSecret

getClientCertProvider

setClientCertProvider

action

asyncDispatch

process

setSslSupport

event

upgradeDispatch

getUpgradeToken

recycle

resetTimeouts

output

setupSocket

setTimeout

read

receive

readMessage

isComet

isUpgrade

getLeftoverInput

refillReadBuffer

prepareRequest

populateHost

prepareResponse

flush

finish