AjpAprProcessor (Apache Tomcat 7.0.67 API Documentation)

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

All Implemented Interfaces:

ActionHook, Processor<java.lang.Long>
```
public class AjpAprProcessor
extends AbstractAjpProcessor<java.lang.Long>
```
Processes AJP requests.

Author:

Remy Maucherat, Henri Gomez, Dan Milstein, Keith Wannamaker, Kevin Seguin, Costin Manolache, Bill Barker

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.coyote.ajp.AbstractAjpProcessor
  AbstractAjpProcessor.SocketInputBuffer, AbstractAjpProcessor.SocketOutputBuffer

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.nio.ByteBuffer`	`inputBuffer` Direct buffer used for input.
`protected java.nio.ByteBuffer`	`outputBuffer` Direct buffer used for output.

Fields inherited from class org.apache.coyote.ajp.AbstractAjpProcessor
bodyBytes, bodyMessage, bytesWritten, certificates, clientCertProvider, empty, endAndCloseMessageArray, endMessageArray, endOfStream, finished, first, flushMessageArray, getBodyMessageArray, hostNameC, keepAliveTimeout, packetSize, pongMessageArray, replay, requestHeaderMessage, requiredSecret, responseMessage, sm, tmpMB, tomcatAuthentication

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

Constructor Summary

Constructors
Constructor and Description

AjpAprProcessor(int packetSize, AprEndpoint endpoint)

Constructors
Constructor and Description
`AjpAprProcessor(int packetSize, AprEndpoint endpoint)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`actionInternal(ActionCode actionCode, java.lang.Object param)` Send an action to the connector.
`protected Log`	`getLog()`
`protected void`	`output(byte[] src, int offset, int length)`
`AbstractEndpoint.Handler.SocketState`	`process(SocketWrapper<java.lang.Long> socket)` Process pipelined HTTP requests using the specified input and output streams.
`protected boolean`	`read(int n)` Read at least the specified amount of bytes, and place them in the input buffer.
`protected boolean`	`readMessage(AjpMessage message, boolean first, boolean useAvailableData)` Read an AJP message.
`protected boolean`	`readt(int n, boolean useAvailableData)` Read at least the specified amount of bytes, and place them in the input buffer.
`boolean`	`receive()` Receive a chunk of data.
`void`	`recycle(boolean socketClosing)` Recycle the processor.
`protected 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.

Methods inherited from class org.apache.coyote.ajp.AbstractAjpProcessor
action, asyncDispatch, event, finish, flush, getClientCertProvider, getHttpUpgradeHandler, getKeepAliveTimeout, getTomcatAuthentication, getTomcatAuthorization, getUpgradeInbound, isComet, isUpgrade, parseHost, prepareRequest, prepareResponse, refillReadBuffer, setClientCertProvider, setKeepAliveTimeout, setRequiredSecret, setSslSupport, setTomcatAuthentication, setTomcatAuthorization, upgradeDispatch, upgradeDispatch

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

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

- Field Detail
  - inputBuffer
```
protected java.nio.ByteBuffer inputBuffer
```
    Direct buffer used for input.
  - outputBuffer
```
protected java.nio.ByteBuffer outputBuffer
```
    Direct buffer used for output.
- Constructor Detail
  - AjpAprProcessor
```
public AjpAprProcessor(int packetSize,
               AprEndpoint endpoint)
```
- Method Detail
  - getLog
```
protected Log getLog()
```
    Specified by:
    
    getLog in class AbstractProcessor<java.lang.Long>
  - process
```
public AbstractEndpoint.Handler.SocketState process(SocketWrapper<java.lang.Long> socket)
                                             throws java.io.IOException
```
    Process pipelined HTTP requests using the specified input and output streams.
    
    Specified by:
    
    process in interface Processor<java.lang.Long>
    
    Specified by:
    
    process in class AbstractProcessor<java.lang.Long>
    
    Throws:
    
    java.io.IOException - error during an I/O operation
  - actionInternal
```
protected void actionInternal(ActionCode actionCode,
                  java.lang.Object param)
```
    Send an action to the connector.
    
    Specified by:
    
    actionInternal in class AbstractAjpProcessor<java.lang.Long>
    
    Parameters:
    actionCode - Type of the action
    param - Action parameter
  - resetTimeouts
```
protected void resetTimeouts()
```
    Description copied from class: AbstractAjpProcessor
    
    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.
    
    Specified by:
    
    resetTimeouts in class AbstractAjpProcessor<java.lang.Long>
  - output
```
protected void output(byte[] src,
          int offset,
          int length)
               throws java.io.IOException
```
    Specified by:
    
    output in class AbstractAjpProcessor<java.lang.Long>
    
    Throws:
    
    java.io.IOException
  - read
```
protected boolean read(int n)
                throws java.io.IOException
```
    Read at least the specified amount of bytes, and place them in the input buffer.
    
    Throws:
    
    java.io.IOException
  - readt
```
protected boolean readt(int n,
            boolean useAvailableData)
                 throws java.io.IOException
```
    Read at least the specified amount of bytes, and place them in the input buffer.
    
    Throws:
    
    java.io.IOException
  - receive
```
public boolean receive()
                throws java.io.IOException
```
    Receive a chunk of data. Called to implement the 'special' packet in ajp13 and to receive the data after we send a GET_BODY packet
    
    Specified by:
    
    receive in class AbstractAjpProcessor<java.lang.Long>
    
    Throws:
    
    java.io.IOException
  - readMessage
```
protected boolean readMessage(AjpMessage message,
                  boolean first,
                  boolean useAvailableData)
                       throws java.io.IOException
```
    Read an AJP message.
    
    Parameters:
    first - is true if the message is the first in the request, which will cause a short duration blocking read
    
    Returns:
    true if the message has been read, false if the short read didn't return anything
    
    Throws:
    
    java.io.IOException - any other failure, including incomplete reads
  - recycle
```
public void recycle(boolean socketClosing)
```
    Recycle the processor.
    
    Specified by:
    
    recycle in interface Processor<java.lang.Long>
    
    Overrides:
    
    recycle in class AbstractAjpProcessor<java.lang.Long>
    
    Parameters:
    socketClosing - Indicates if the socket is about to be closed allowing the processor to perform any additional clean-up that may be required

Class AjpAprProcessor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.coyote.ajp.AbstractAjpProcessor

Field Summary

Fields inherited from class org.apache.coyote.ajp.AbstractAjpProcessor

Fields inherited from class org.apache.coyote.AbstractProcessor

Constructor Summary

Method Summary

Methods inherited from class org.apache.coyote.ajp.AbstractAjpProcessor

Methods inherited from class org.apache.coyote.AbstractProcessor

Methods inherited from class java.lang.Object

Field Detail

inputBuffer

outputBuffer

Constructor Detail

AjpAprProcessor

Method Detail

getLog

process

actionInternal

resetTimeouts

output

read

readt

receive

readMessage

recycle