AjpProcessor (Apache Tomcat 8.0.53 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

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

protected java.io.OutputStream output
- Fields inherited from class org.apache.coyote.ajp.AbstractAjpProcessor
  ajpFlush, bodyBytes, bodyMessage, bytesWritten, certificates, clientCertProvider, empty, endAndCloseMessageArray, endMessageArray, endOfStream, finished, first, flushMessageArray, getBodyMessageArray, keepAliveTimeout, pongMessageArray, replay, requestHeaderMessage, requiredSecret, responseMessage, sm, tmpMB, tomcatAuthentication
- Fields inherited from class org.apache.coyote.AbstractProcessor
  adapter, asyncStateMachine, endpoint, hostNameC, request, response, socketWrapper, userDataHelper

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

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 Log`	`getLog()`
`protected int`	`output(byte[] src, int offset, int length, boolean block)`
`protected boolean`	`read(byte[] buf, int pos, int n, boolean blockFirstRead)` Read at least the specified amount of bytes, and place them in the input buffer.
`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`	`registerForEvent(boolean read, boolean write)` Register the socket for the specified events.
`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.
`protected void`	`setTimeout(SocketWrapper<java.net.Socket> socketWrapper, int timeout)`
`protected void`	`setupSocket(SocketWrapper<java.net.Socket> socketWrapper)`

Methods inherited from class org.apache.coyote.ajp.AbstractAjpProcessor
action, asyncDispatch, event, finish, flush, getAjpFlush, getClientCertProvider, getKeepAliveTimeout, getLeftoverInput, getTomcatAuthentication, getTomcatAuthorization, getUpgradeToken, isComet, isUpgrade, populateHost, prepareRequest, prepareResponse, process, readMessage, receive, refillReadBuffer, setAjpFlush, setClientCertProvider, setKeepAliveTimeout, setRequiredSecret, setSslSupport, setTomcatAuthentication, setTomcatAuthorization, upgradeDispatch

Methods inherited from class org.apache.coyote.AbstractProcessor
asyncPostProcess, errorDispatch, getAdapter, getEndpoint, getErrorState, getExecutor, getMaxCookieCount, getRequest, getSocketWrapper, isAsync, parseHost, 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
  - input
```
protected java.io.InputStream input
```
  - output
```
protected java.io.OutputStream output
```
- Constructor Detail
  - AjpProcessor
```
public AjpProcessor(int packetSize,
            JIoEndpoint endpoint)
```
- Method Detail
  - getLog
```
protected Log getLog()
```
    Specified by:
    
    getLog in class AbstractProcessor<java.net.Socket>
  - 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
  - registerForEvent
```
protected void registerForEvent(boolean read,
                    boolean write)
```
    Description copied from class: AbstractProcessor
    
    Register the socket for the specified events.
    
    Specified by:
    
    registerForEvent in class AbstractProcessor<java.net.Socket>
    
    Parameters:
    read - Register the socket for read events
    write - Register the socket for write events
  - 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>
  - setupSocket
```
protected void setupSocket(SocketWrapper<java.net.Socket> socketWrapper)
                    throws java.io.IOException
```
    Specified by:
    
    setupSocket in class AbstractAjpProcessor<java.net.Socket>
    
    Throws:
    
    java.io.IOException
  - setTimeout
```
protected void setTimeout(SocketWrapper<java.net.Socket> socketWrapper,
              int timeout)
                   throws java.io.IOException
```
    Specified by:
    
    setTimeout in class AbstractAjpProcessor<java.net.Socket>
    
    Throws:
    
    java.io.IOException
  - output
```
protected int output(byte[] src,
         int offset,
         int length,
         boolean block)
              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,
           boolean blockFirstRead)
                throws java.io.IOException
```
    Description copied from class: AbstractAjpProcessor
    
    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.
    
    Specified by:
    
    read in class AbstractAjpProcessor<java.net.Socket>
    
    Parameters:
    buf - Buffer to read data into
    pos - Start position
    n - The minimum number of bytes to read
    blockFirstRead - 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

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

recycle

registerForEvent

resetTimeouts

setupSocket

setTimeout

output

read