Http11AprProtocol (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.coyote.AbstractProtocol<S>
- - org.apache.coyote.http11.AbstractHttp11Protocol<java.lang.Long>
  - - org.apache.coyote.http11.Http11AprProtocol

All Implemented Interfaces:

javax.management.MBeanRegistration, ProtocolHandler
```
public class Http11AprProtocol
extends AbstractHttp11Protocol<java.lang.Long>
```
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 Http11AprProtocol.Http11ConnectionHandler
- Nested classes/interfaces inherited from class org.apache.coyote.AbstractProtocol
  AbstractProtocol.AbstractConnectionHandler<S,P extends Processor<S>>, AbstractProtocol.RecycledProcessors<P extends Processor<S>,S>

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Http11AprProtocol.Http11ConnectionHandler`

Field Summary
- Fields inherited from class org.apache.coyote.AbstractProtocol
  adapter, clientCertProvider, domain, endpoint, mserver, oname, processorCache, rgOname, sm, tpOname

Constructor Summary

Constructors
Constructor and Description

Http11AprProtocol()

Constructors
Constructor and Description
`Http11AprProtocol()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getCiphersUsed()`
`boolean`	`getDeferAccept()`
`protected AbstractEndpoint.Handler`	`getHandler()` Obtain the handler associated with the underlying Endpoint
`protected Log`	`getLog()` Concrete implementations need to provide access to their logger to be used by the abstract classes.
`protected java.lang.String`	`getNamePrefix()` Obtain the prefix to be used when construction a name for this protocol handler.
`int`	`getPollerSize()`
`int`	`getPollTime()`
`int`	`getSendfileSize()`
`int`	`getSendfileThreadCount()`
`java.lang.String`	`getSSLCACertificateFile()` SSL CA certificate file.
`java.lang.String`	`getSSLCACertificatePath()` SSL CA certificate path.
`java.lang.String`	`getSSLCARevocationFile()` SSL CA revocation file.
`java.lang.String`	`getSSLCARevocationPath()` SSL CA revocation path.
`java.lang.String`	`getSSLCertificateChainFile()` SSL certificate chain file.
`java.lang.String`	`getSSLCertificateFile()` SSL certificate file.
`java.lang.String`	`getSSLCertificateKeyFile()` SSL certificate key file.
`java.lang.String`	`getSSLCipherSuite()` SSL cipher suite.
`boolean`	`getSSLDisableCompression()` Disable SSL compression.
`boolean`	`getSSLDisableSessionTickets()` Disable TLS Session Tickets (RFC 4507).
`boolean`	`getSSLHonorCipherOrder()` SSL honor cipher order.
`java.lang.String`	`getSSLPassword()` SSL password (if a cert is encrypted, and no password has been provided, a callback will ask for a password).
`java.lang.String`	`getSSLProtocol()` SSL protocol.
`java.lang.String`	`getSSLVerifyClient()` SSL verify client.
`int`	`getSSLVerifyDepth()` SSL verify depth.
`boolean`	`getUseSendfile()`
`boolean`	`isAprRequired()` Requires APR/native library
`void`	`setDeferAccept(boolean deferAccept)`
`void`	`setPollerSize(int pollerSize)`
`void`	`setPollTime(int pollTime)`
`void`	`setSendfileSize(int sendfileSize)`
`void`	`setSendfileThreadCount(int sendfileThreadCount)`
`void`	`setSSLCACertificateFile(java.lang.String SSLCACertificateFile)`
`void`	`setSSLCACertificatePath(java.lang.String SSLCACertificatePath)`
`void`	`setSSLCARevocationFile(java.lang.String SSLCARevocationFile)`
`void`	`setSSLCARevocationPath(java.lang.String SSLCARevocationPath)`
`void`	`setSSLCertificateChainFile(java.lang.String SSLCertificateChainFile)`
`void`	`setSSLCertificateFile(java.lang.String SSLCertificateFile)`
`void`	`setSSLCertificateKeyFile(java.lang.String SSLCertificateKeyFile)`
`void`	`setSSLCipherSuite(java.lang.String SSLCipherSuite)`
`void`	`setSSLDisableCompression(boolean disable)`
`void`	`setSSLDisableSessionTickets(boolean enable)`
`void`	`setSSLHonorCipherOrder(boolean SSLHonorCipherOrder)`
`void`	`setSSLPassword(java.lang.String SSLPassword)`
`void`	`setSSLProtocol(java.lang.String SSLProtocol)`
`void`	`setSSLVerifyClient(java.lang.String SSLVerifyClient)`
`void`	`setSSLVerifyDepth(int SSLVerifyDepth)`
`void`	`setUseSendfile(boolean useSendfile)`

Methods inherited from class org.apache.coyote.http11.AbstractHttp11Protocol
addAllowedTrailerHeader, configureProcessor, getAllowedTrailerHeaders, getAllowedTrailerHeadersAsSet, getAllowHostHeaderMismatch, getCompressableMimeType, getCompressableMimeTypes, getCompressibleMimeType, getCompression, getCompressionMinSize, getConnectionUploadTimeout, getDisableUploadTimeout, getMaxExtensionSize, getMaxHttpHeaderSize, getMaxKeepAliveRequests, getMaxSavePostSize, getMaxSwallowSize, getMaxTrailerSize, getNoCompressionUserAgents, getProtocolName, getRejectIllegalHeaderName, getRelaxedPathChars, getRelaxedQueryChars, getRestrictedUserAgents, getSecure, getServer, getSocketBuffer, getUpgradeAsyncWriteBufferSize, isSSLEnabled, removeAllowedTrailerHeader, setAllowedTrailerHeaders, setAllowHostHeaderMismatch, setCompressableMimeType, setCompressableMimeTypes, setCompressibleMimeType, setCompression, setCompressionMinSize, setConnectionUploadTimeout, setDisableUploadTimeout, setMaxExtensionSize, setMaxHttpHeaderSize, setMaxKeepAliveRequests, setMaxSavePostSize, setMaxSwallowSize, setMaxTrailerSize, setNoCompressionUserAgents, setRejectIllegalHeaderName, setRelaxedPathChars, setRelaxedQueryChars, setRestrictedUserAgents, setSecure, setServer, setSocketBuffer, setSSLEnabled, setUpgradeAsyncWriteBufferSize

Methods inherited from class org.apache.coyote.AbstractProtocol
destroy, getAdapter, getAddress, getBacklog, getClientCertProvider, getConnectionCount, getConnectionTimeout, getDomain, getExecutor, getKeepAliveTimeout, getLocalPort, getMaxConnections, getMaxCookieCount, getMaxHeaderCount, getMaxThreads, getMinSpareThreads, getName, getNameIndex, getObjectName, getPort, getProcessorCache, getProperty, getSoLinger, getSoTimeout, getTcpNoDelay, getThreadPriority, init, isCometSupported, isCometTimeoutSupported, isSendfileSupported, pause, postDeregister, postRegister, preDeregister, preRegister, resume, setAdapter, setAddress, setBacklog, setClientCertProvider, setConnectionTimeout, setExecutor, setKeepAliveTimeout, setMaxConnections, setMaxCookieCount, setMaxHeaderCount, setMaxThreads, setMinSpareThreads, setPort, setProcessorCache, setProperty, setSoLinger, setSoTimeout, setTcpNoDelay, setThreadPriority, start, stop

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

Constructor Detail
- Http11AprProtocol
```
public Http11AprProtocol()
```

Method Detail

getLog
```
protected Log getLog()
```
Description copied from class: AbstractProtocol

Concrete implementations need to provide access to their logger to be used by the abstract classes.

Specified by:

getLog in class AbstractProtocol<java.lang.Long>

getHandler
```
protected AbstractEndpoint.Handler getHandler()
```
Description copied from class: AbstractProtocol

Obtain the handler associated with the underlying Endpoint

Specified by:

getHandler in class AbstractProtocol<java.lang.Long>

isAprRequired
```
public boolean isAprRequired()
```
Description copied from interface: ProtocolHandler

Requires APR/native library

Specified by:

isAprRequired in interface ProtocolHandler

Overrides:

isAprRequired in class AbstractProtocol<java.lang.Long>

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()
```

getSendfileSize
```
public int getSendfileSize()
```

setSendfileSize

public void setSendfileSize(int sendfileSize)

setSendfileThreadCount

public void setSendfileThreadCount(int sendfileThreadCount)

getSendfileThreadCount
```
public int getSendfileThreadCount()
```

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

setDeferAccept

public void setDeferAccept(boolean deferAccept)

getSSLProtocol

public java.lang.String getSSLProtocol()

SSL protocol.

setSSLProtocol

public void setSSLProtocol(java.lang.String SSLProtocol)

getSSLPassword
```
public java.lang.String getSSLPassword()
```
SSL password (if a cert is encrypted, and no password has been provided, a callback will ask for a password).

setSSLPassword

public void setSSLPassword(java.lang.String SSLPassword)

getSSLCipherSuite

public java.lang.String getSSLCipherSuite()

SSL cipher suite.

setSSLCipherSuite

public void setSSLCipherSuite(java.lang.String SSLCipherSuite)

getCiphersUsed

public java.lang.String[] getCiphersUsed()

getSSLHonorCipherOrder
```
public boolean getSSLHonorCipherOrder()
```
SSL honor cipher order. Set to true to enforce the server's cipher order instead of the default which is to allow the client to choose a preferred cipher.

setSSLHonorCipherOrder

public void setSSLHonorCipherOrder(boolean SSLHonorCipherOrder)

getSSLCertificateFile

public java.lang.String getSSLCertificateFile()

SSL certificate file.

setSSLCertificateFile

public void setSSLCertificateFile(java.lang.String SSLCertificateFile)

getSSLCertificateKeyFile

public java.lang.String getSSLCertificateKeyFile()

SSL certificate key file.

setSSLCertificateKeyFile

public void setSSLCertificateKeyFile(java.lang.String SSLCertificateKeyFile)

getSSLCertificateChainFile

public java.lang.String getSSLCertificateChainFile()

SSL certificate chain file.

setSSLCertificateChainFile

public void setSSLCertificateChainFile(java.lang.String SSLCertificateChainFile)

getSSLCACertificatePath

public java.lang.String getSSLCACertificatePath()

SSL CA certificate path.

setSSLCACertificatePath

public void setSSLCACertificatePath(java.lang.String SSLCACertificatePath)

getSSLCACertificateFile

public java.lang.String getSSLCACertificateFile()

SSL CA certificate file.

setSSLCACertificateFile

public void setSSLCACertificateFile(java.lang.String SSLCACertificateFile)

getSSLCARevocationPath

public java.lang.String getSSLCARevocationPath()

SSL CA revocation path.

setSSLCARevocationPath

public void setSSLCARevocationPath(java.lang.String SSLCARevocationPath)

getSSLCARevocationFile

public java.lang.String getSSLCARevocationFile()

SSL CA revocation file.

setSSLCARevocationFile

public void setSSLCARevocationFile(java.lang.String SSLCARevocationFile)

getSSLVerifyClient

public java.lang.String getSSLVerifyClient()

SSL verify client.

setSSLVerifyClient

public void setSSLVerifyClient(java.lang.String SSLVerifyClient)

getSSLVerifyDepth
```
public int getSSLVerifyDepth()
```
SSL verify depth.

setSSLVerifyDepth

public void setSSLVerifyDepth(int SSLVerifyDepth)

getSSLDisableCompression
```
public boolean getSSLDisableCompression()
```
Disable SSL compression.

setSSLDisableCompression

public void setSSLDisableCompression(boolean disable)

getSSLDisableSessionTickets
```
public boolean getSSLDisableSessionTickets()
```
Disable TLS Session Tickets (RFC 4507).

setSSLDisableSessionTickets

public void setSSLDisableSessionTickets(boolean enable)

getNamePrefix
```
protected java.lang.String getNamePrefix()
```
Description copied from class: AbstractProtocol

Obtain the prefix to be used when construction a name for this protocol handler. The name will be prefix-address-port.

Specified by:

getNamePrefix in class AbstractProtocol<java.lang.Long>

Class Http11AprProtocol

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.coyote.AbstractProtocol

Field Summary

Fields inherited from class org.apache.coyote.AbstractProtocol

Constructor Summary

Method Summary

Methods inherited from class org.apache.coyote.http11.AbstractHttp11Protocol

Methods inherited from class org.apache.coyote.AbstractProtocol

Methods inherited from class java.lang.Object

Constructor Detail

Http11AprProtocol

Method Detail

getLog

getHandler

isAprRequired

getUseSendfile