AjpAprProtocol (JBoss Web 8.0.0.Alpha1 API)

java.lang.Object
- org.apache.coyote.ajp.AjpAprProtocol

All Implemented Interfaces:

MBeanRegistration, ProtocolHandler
```
public class AjpAprProtocol
extends Object
implements ProtocolHandler, MBeanRegistration
```
Abstract the protocol implementation, including threading, etc. Processor is single threaded and specific to stream-based protocols, will not fit Jk protocols like JNI.

Author:

Remy Maucherat, Costin Manolache

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AjpAprProtocol.AjpConnectionHandler

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AjpAprProtocol.AjpConnectionHandler`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Hashtable`	`attributes` Configuration attributes.
`protected String`	`domain`
`protected AprEndpoint`	`endpoint` Associated APR endpoint.
`protected MBeanServer`	`mserver`
`protected ObjectName`	`oname`
`protected int`	`packetSize` AJP packet size.
`protected int`	`processorCache` Processor cache.
`protected String`	`requiredSecret` Required secret.
`protected ObjectName`	`rgOname`
`protected boolean`	`tomcatAuthentication` Should authentication be done in the native webserver layer, or in the Servlet container ?
`protected ObjectName`	`tpOname`

Constructor Summary

Constructors
Constructor and Description

AjpAprProtocol()

Constructors
Constructor and Description
`AjpAprProtocol()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()`
`Adapter`	`getAdapter()`
`InetAddress`	`getAddress()`
`Object`	`getAttribute(String key)`
`Iterator`	`getAttributeNames()`
`int`	`getBacklog()`
`boolean`	`getDeferAccept()`
`String`	`getDomain()`
`Executor`	`getExecutor()`
`String`	`getJmxName()`
`int`	`getKeepAliveTimeout()` The number of seconds Tomcat will wait for a subsequent request before closing the connection.
`int`	`getMaxThreads()`
`String`	`getName()`
`ObjectName`	`getObjectName()`
`int`	`getPacketSize()`
`int`	`getPollerSize()`
`int`	`getPollTime()`
`int`	`getPort()`
`int`	`getProcessorCache()`
`RequestGroupInfo`	`getRequestGroupInfo()`
`boolean`	`getReverseConnection()`
`int`	`getSoLinger()`
`int`	`getSoTimeout()`
`boolean`	`getTcpNoDelay()`
`int`	`getThreadPriority()`
`boolean`	`getTomcatAuthentication()`
`boolean`	`getUseSendfile()`
`boolean`	`hasIoEvents()`
`void`	`init()` Start the protocol
`void`	`pause()` Pause the protocol (optional).
`void`	`postDeregister()`
`void`	`postRegister(Boolean registrationDone)`
`void`	`preDeregister()`
`ObjectName`	`preRegister(MBeanServer server, ObjectName name)`
`void`	`resume()` Resume the protocol (optional).
`void`	`setAdapter(Adapter adapter)` The adapter, used to call the connector
`void`	`setAddress(InetAddress ia)`
`void`	`setAttribute(String name, Object value)` Pass config info
`void`	`setBacklog(int backlog)`
`void`	`setDeferAccept(boolean deferAccept)`
`void`	`setExecutor(Executor executor)`
`void`	`setKeepAliveTimeout(int timeout)`
`void`	`setMaxThreads(int maxThreads)`
`void`	`setPacketSize(int packetSize)`
`void`	`setPollerSize(int pollerSize)`
`void`	`setPollTime(int pollTime)`
`void`	`setPort(int port)`
`void`	`setProcessorCache(int processorCache)`
`void`	`setRequiredSecret(String requiredSecret)`
`void`	`setReverseConnection(boolean reverseConnection)`
`void`	`setSoLinger(int soLinger)`
`void`	`setSoTimeout(int soTimeout)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setThreadPriority(int threadPriority)`
`void`	`setTomcatAuthentication(boolean tomcatAuthentication)`
`void`	`setUseSendfile(boolean useSendfile)`
`void`	`start()` Start the protocol.

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

Field Detail

tpOname
```
protected ObjectName tpOname
```

rgOname
```
protected ObjectName rgOname
```

endpoint
```
protected AprEndpoint endpoint
```
Associated APR endpoint.

attributes
```
protected Hashtable attributes
```
Configuration attributes.

processorCache
```
protected int processorCache
```
Processor cache.

tomcatAuthentication
```
protected boolean tomcatAuthentication
```
Should authentication be done in the native webserver layer, or in the Servlet container ?

requiredSecret
```
protected String requiredSecret
```
Required secret.

packetSize
```
protected int packetSize
```
AJP packet size.

domain
```
protected String domain
```

oname
```
protected ObjectName oname
```

mserver
```
protected MBeanServer mserver
```

Constructor Detail
- AjpAprProtocol
```
public AjpAprProtocol()
```

Method Detail

setAttribute

public void setAttribute(String name,
                         Object value)

Pass config info

Specified by:: setAttribute in interface ProtocolHandler

getAttribute
```
public Object getAttribute(String key)
```
Specified by:

getAttribute in interface ProtocolHandler

getAttributeNames
```
public Iterator getAttributeNames()
```
Specified by:

getAttributeNames in interface ProtocolHandler

setAdapter
```
public void setAdapter(Adapter adapter)
```
The adapter, used to call the connector

Specified by:

setAdapter in interface ProtocolHandler

getAdapter
```
public Adapter getAdapter()
```
Specified by:

getAdapter in interface ProtocolHandler

hasIoEvents
```
public boolean hasIoEvents()
```
Specified by:

hasIoEvents in interface ProtocolHandler

getRequestGroupInfo
```
public RequestGroupInfo getRequestGroupInfo()
```
Specified by:

getRequestGroupInfo in interface ProtocolHandler

init
```
public void init()
          throws Exception
```
Start the protocol

Specified by:

init in interface ProtocolHandler

Throws:

Exception

start
```
public void start()
           throws Exception
```
Description copied from interface: ProtocolHandler

Start the protocol.

Specified by:

start in interface ProtocolHandler

Throws:

Exception

pause
```
public void pause()
           throws Exception
```
Description copied from interface: ProtocolHandler

Pause the protocol (optional).

Specified by:

pause in interface ProtocolHandler

Throws:

Exception

resume
```
public void resume()
            throws Exception
```
Description copied from interface: ProtocolHandler

Resume the protocol (optional).

Specified by:

resume in interface ProtocolHandler

Throws:

Exception

destroy
```
public void destroy()
             throws Exception
```
Specified by:

destroy in interface ProtocolHandler

Throws:

Exception

getJmxName
```
public String getJmxName()
```

getName
```
public String getName()
```

getProcessorCache
```
public int getProcessorCache()
```

setProcessorCache

public void setProcessorCache(int processorCache)

getExecutor
```
public Executor getExecutor()
```

setExecutor

public void setExecutor(Executor executor)

getMaxThreads
```
public int getMaxThreads()
```

setMaxThreads

public void setMaxThreads(int maxThreads)

getThreadPriority
```
public int getThreadPriority()
```

setThreadPriority

public void setThreadPriority(int threadPriority)

getBacklog
```
public int getBacklog()
```

setBacklog
```
public void setBacklog(int backlog)
```

getPort
```
public int getPort()
```

setPort
```
public void setPort(int port)
```

getAddress
```
public InetAddress getAddress()
```

setAddress

public void setAddress(InetAddress ia)

getTcpNoDelay
```
public boolean getTcpNoDelay()
```

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

getSoLinger
```
public int getSoLinger()
```

setSoLinger

public void setSoLinger(int soLinger)

getSoTimeout
```
public int getSoTimeout()
```

setSoTimeout

public void setSoTimeout(int soTimeout)

getReverseConnection
```
public boolean getReverseConnection()
```

setReverseConnection

public void setReverseConnection(boolean reverseConnection)

getDeferAccept
```
public boolean getDeferAccept()
```

setDeferAccept

public void setDeferAccept(boolean deferAccept)

getTomcatAuthentication

public boolean getTomcatAuthentication()

setTomcatAuthentication

public void setTomcatAuthentication(boolean tomcatAuthentication)

setRequiredSecret

public void setRequiredSecret(String requiredSecret)

getPacketSize
```
public int getPacketSize()
```

setPacketSize

public void setPacketSize(int packetSize)

getKeepAliveTimeout
```
public int getKeepAliveTimeout()
```
The number of seconds Tomcat will wait for a subsequent request before closing the connection.

setKeepAliveTimeout

public void setKeepAliveTimeout(int timeout)

getUseSendfile
```
public boolean getUseSendfile()
```

setUseSendfile

public void setUseSendfile(boolean useSendfile)

getPollTime
```
public int getPollTime()
```

setPollTime

public void setPollTime(int pollTime)

setPollerSize

public void setPollerSize(int pollerSize)

getPollerSize
```
public int getPollerSize()
```

getObjectName
```
public ObjectName getObjectName()
```

getDomain
```
public String getDomain()
```

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

Specified by:: preRegister in interface MBeanRegistration
Throws:: Exception

postRegister
```
public void postRegister(Boolean registrationDone)
```
Specified by:

postRegister in interface MBeanRegistration

preDeregister
```
public void preDeregister()
                   throws Exception
```
Specified by:

preDeregister in interface MBeanRegistration

Throws:

Exception

postDeregister
```
public void postDeregister()
```
Specified by:

postDeregister in interface MBeanRegistration

Class AjpAprProtocol

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tpOname

rgOname

endpoint

attributes

processorCache

tomcatAuthentication

requiredSecret

packetSize

domain

oname

mserver

Constructor Detail

AjpAprProtocol

Method Detail

setAttribute

getAttribute

getAttributeNames

setAdapter

getAdapter

hasIoEvents

getRequestGroupInfo

init

start

pause

resume

destroy

getJmxName

getName

getProcessorCache

setProcessorCache

getExecutor

setExecutor

getMaxThreads

setMaxThreads

getThreadPriority

setThreadPriority

getBacklog

setBacklog

getPort

setPort

getAddress

setAddress

getTcpNoDelay

setTcpNoDelay

getSoLinger

setSoLinger

getSoTimeout

setSoTimeout

getReverseConnection

setReverseConnection

getDeferAccept

setDeferAccept

getTomcatAuthentication

setTomcatAuthentication

setRequiredSecret

getPacketSize

setPacketSize

getKeepAliveTimeout

setKeepAliveTimeout

getUseSendfile

setUseSendfile

getPollTime

setPollTime

setPollerSize

getPollerSize

getObjectName

getDomain

preRegister

postRegister

preDeregister

postDeregister