AjpProcessor (Apache Tomcat 7.0.67 API Documentation)

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

All Implemented Interfaces:

ActionHook, Processor<java.net.Socket>
```
public class AjpProcessor
extends AbstractAjpProcessor<java.net.Socket>
```
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.io.InputStream input
Input stream.

protected java.io.OutputStream output
Output stream.
- 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

Fields
Modifier and Type	Field and Description
`protected java.io.InputStream`	`input` Input stream.
`protected java.io.OutputStream`	`output` Output stream.

Constructor Summary

Constructors
Constructor and Description

AjpProcessor(int packetSize, JIoEndpoint endpoint)

Constructors
Constructor and Description
`AjpProcessor(int packetSize, JIoEndpoint 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.net.Socket> socket)` Process pipelined HTTP requests using the specified input and output streams.
`protected boolean`	`read(byte[] buf, int pos, int n)` Read at least the specified amount of bytes, and place them in the input buffer.
`protected boolean`	`readMessage(AjpMessage message)` Read an AJP message.
`boolean`	`receive()` Receive a chunk of data.
`void`	`recycle(boolean socketClosing)` Recycle the processor, ready for the next request which may be on the same connection or a different connection.
`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
  - input
```
protected java.io.InputStream input
```
    Input stream.
  - output
```
protected java.io.OutputStream output
```
    Output stream.
- Constructor Detail
  - AjpProcessor
```
public AjpProcessor(int packetSize,
            JIoEndpoint endpoint)
```
- Method Detail
  - getLog
```
protected Log getLog()
```
    Specified by:
    
    getLog in class AbstractProcessor<java.net.Socket>
  - process
```
public AbstractEndpoint.Handler.SocketState process(SocketWrapper<java.net.Socket> socket)
                                             throws java.io.IOException
```
    Process pipelined HTTP requests using the specified input and output streams.
    
    Specified by:
    
    process in interface Processor<java.net.Socket>
    
    Specified by:
    
    process in class AbstractProcessor<java.net.Socket>
    
    Throws:
    
    java.io.IOException - error during an I/O operation
  - recycle
```
public void recycle(boolean socketClosing)
```
    Description copied from class: AbstractAjpProcessor
    
    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<java.net.Socket>
    
    Overrides:
    
    recycle in class AbstractAjpProcessor<java.net.Socket>
    
    Parameters:
    socketClosing - Indicates if the socket is about to be closed allowing the processor to perform any additional clean-up that may be required
  - actionInternal
```
protected void actionInternal(ActionCode actionCode,
                  java.lang.Object param)
```
    Send an action to the connector.
    
    Specified by:
    
    actionInternal in class AbstractAjpProcessor<java.net.Socket>
    
    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.net.Socket>
  - output
```
protected void output(byte[] src,
          int offset,
          int length)
               throws java.io.IOException
```
    Specified by:
    
    output in class AbstractAjpProcessor<java.net.Socket>
    
    Throws:
    
    java.io.IOException
  - read
```
protected boolean read(byte[] buf,
           int pos,
           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
  - 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.net.Socket>
    
    Throws:
    
    java.io.IOException
  - readMessage
```
protected boolean readMessage(AjpMessage message)
                       throws java.io.IOException
```
    Read an AJP message.
    
    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

Class AjpProcessor

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

input

output

Constructor Detail

AjpProcessor

Method Detail

getLog

process

recycle

actionInternal

resetTimeouts

output

read

receive

readMessage