org.apache.coyote.http11

Class Http11AprProtocol

public class Http11AprProtocol 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

Field Summary
protected Adapter	adapter The adapter, used to call the connector.
protected HashMap<String,Object>	attributes
protected String	compressableMimeTypes
protected String	compression Integrated compression support.
protected int	compressionMinSize
protected boolean	disableUploadTimeout If true, the regular socket timeout will be used for the full duration of the connection.
protected String	domain
protected AprEndpoint	endpoint
protected static Log	log
protected int	maxHttpHeaderSize Maximum size of the HTTP message header.
protected int	maxKeepAliveRequests Maximum number of requests which can be performed over a keepalive connection.
protected int	maxSavePostSize Maximum size of the post which will be saved when processing certain requests, such as a POST.
protected MBeanServer	mserver
protected String	noCompressionUserAgents
protected ObjectName	oname
protected int	processorCache Processor cache.
protected String	protocol
protected String	restrictedUserAgents User agents regular expressions which should be restricted to HTTP/1.0 support.
protected boolean	secure This field indicates if the protocol is secure from the perspective of the client (= https is used).
protected String	server Server header.
protected static StringManager	sm The string manager for this package.
protected int	socketBuffer
protected int	timeout This timeout represents the socket timeout which will be used while the adapter execution is in progress, unless disableUploadTimeout is set to true.

Constructor Summary
	Http11AprProtocol()

Method Summary
void	destroy()
Adapter	getAdapter()
InetAddress	getAddress()
Object	getAttribute(String key)
Iterator	getAttributeNames()
int	getBacklog()
String	getCompressableMimeType()
String	getCompression()
int	getCompressionMinSize()
boolean	getDeferAccept()
boolean	getDisableUploadTimeout()
String	getDomain()
Executor	getExecutor()
boolean	getKeepAlive() Return the Keep-Alive policy for the connection.
int	getKeepAliveTimeout() The number of seconds Tomcat will wait for a subsequent request before closing the connection.
int	getMaxHttpHeaderSize()
int	getMaxKeepAliveRequests()
int	getMaxSavePostSize()
int	getMaxThreads()
String	getName()
String	getNoCompressionUserAgents()
ObjectName	getObjectName()
int	getPollerSize()
int	getPollerThreadCount()
int	getPollTime()
int	getPort()
int	getProcessorCache()
String	getProtocol()
String	getRestrictedUserAgents()
boolean	getSecure()
int	getSendfileSize()
int	getSendfileThreadCount()
String	getServer()
int	getSocketBuffer()
int	getSoLinger()
int	getSoTimeout()
String	getSSLCACertificateFile() SSL CA certificate file.
String	getSSLCACertificatePath() SSL CA certificate path.
String	getSSLCARevocationFile() SSL CA revocation file.
String	getSSLCARevocationPath() SSL CA revocation path.
String	getSSLCertificateChainFile() SSL certificate chain file.
String	getSSLCertificateFile() SSL certificate file.
String	getSSLCertificateKeyFile() SSL certificate key file.
String	getSSLCipherSuite() SSL cipher suite.
String	getSSLPassword() SSL password (if a cert is encrypted, and no password has been provided, a callback will ask for a password).
String	getSSLProtocol() SSL protocol.
String	getSSLVerifyClient() SSL verify client.
int	getSSLVerifyDepth() SSL verify depth.
boolean	getTcpNoDelay()
int	getThreadPriority()
int	getTimeout()
int	getUnlockTimeout()
boolean	getUseSendfile()
void	init() Start the protocol
boolean	isSSLEnabled() SSL engine.
void	pause()
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
void	resume()
void	setAdapter(Adapter adapter)
void	setAddress(InetAddress ia)
void	setAttribute(String name, Object value) Pass config info
void	setBacklog(int backlog)
void	setCompressableMimeType(String valueS)
void	setCompression(String valueS)
void	setCompressionMinSize(int valueI)
void	setDeferAccept(boolean deferAccept)
void	setDisableUploadTimeout(boolean isDisabled)
void	setExecutor(Executor executor)
void	setKeepAlive(boolean keepAlive) Set the keep-alive policy for this connection.
void	setKeepAliveTimeout(int timeout)
void	setMaxHttpHeaderSize(int valueI)
void	setMaxKeepAliveRequests(int mkar)
void	setMaxSavePostSize(int valueI)
void	setMaxThreads(int maxThreads)
void	setNoCompressionUserAgents(String valueS)
void	setPollerSize(int pollerSize)
void	setPollerThreadCount(int pollerThreadCount)
void	setPollTime(int pollTime)
void	setPort(int port)
void	setProcessorCache(int processorCache)
void	setProtocol(String protocol)
void	setRestrictedUserAgents(String valueS)
void	setSecure(boolean b)
void	setSendfileSize(int sendfileSize)
void	setSendfileThreadCount(int sendfileThreadCount)
void	setServer(String server)
void	setSocketBuffer(int socketBuffer)
void	setSoLinger(int soLinger)
void	setSoTimeout(int soTimeout)
void	setSSLCACertificateFile(String SSLCACertificateFile)
void	setSSLCACertificatePath(String SSLCACertificatePath)
void	setSSLCARevocationFile(String SSLCARevocationFile)
void	setSSLCARevocationPath(String SSLCARevocationPath)
void	setSSLCertificateChainFile(String SSLCertificateChainFile)
void	setSSLCertificateFile(String SSLCertificateFile)
void	setSSLCertificateKeyFile(String SSLCertificateKeyFile)
void	setSSLCipherSuite(String SSLCipherSuite)
void	setSSLEnabled(boolean SSLEnabled)
void	setSSLPassword(String SSLPassword)
void	setSSLProtocol(String SSLProtocol)
void	setSSLVerifyClient(String SSLVerifyClient)
void	setSSLVerifyDepth(int SSLVerifyDepth)
void	setTcpNoDelay(boolean tcpNoDelay)
void	setThreadPriority(int threadPriority)
void	setTimeout(int timeout)
void	setUnlockTimeout(int unlockTimeout)
void	setUseSendfile(boolean useSendfile)
void	start()

Field Detail

adapter

protected Adapter adapter

The adapter, used to call the connector.

attributes

protected HashMap<String,Object> attributes

compression

protected String compression

Integrated compression support.

disableUploadTimeout

protected boolean disableUploadTimeout

If true, the regular socket timeout will be used for the full duration of the connection.

maxHttpHeaderSize

protected int maxHttpHeaderSize

Maximum size of the HTTP message header.

maxKeepAliveRequests

protected int maxKeepAliveRequests

Maximum number of requests which can be performed over a keepalive connection. The default is the same as for Apache HTTP Server.

maxSavePostSize

protected int maxSavePostSize

Maximum size of the post which will be saved when processing certain requests, such as a POST.

noCompressionUserAgents

protected String noCompressionUserAgents

processorCache

protected int processorCache

Processor cache.

restrictedUserAgents

protected String restrictedUserAgents

User agents regular expressions which should be restricted to HTTP/1.0 support.

secure

protected boolean secure

This field indicates if the protocol is secure from the perspective of the client (= https is used).

sm

protected static StringManager sm

The string manager for this package.

This timeout represents the socket timeout which will be used while the adapter execution is in progress, unless disableUploadTimeout is set to true. The default is the same as for Apache HTTP Server (300 000 milliseconds).

Constructor Detail

Http11AprProtocol

public Http11AprProtocol()

Method Detail

destroy

public void destroy()

getAdapter

public Adapter getAdapter()

getAddress

public InetAddress getAddress()

getAttribute

public Object getAttribute(String key)

getAttributeNames

public Iterator getAttributeNames()

getBacklog

public int getBacklog()

getCompressableMimeType

public String getCompressableMimeType()

getCompression

public String getCompression()

getCompressionMinSize

public int getCompressionMinSize()

getDeferAccept

public boolean getDeferAccept()

getDisableUploadTimeout

public boolean getDisableUploadTimeout()

getDomain

public String getDomain()

getExecutor

public Executor getExecutor()

getKeepAlive

public boolean getKeepAlive()

Return the Keep-Alive policy for the connection.

getKeepAliveTimeout

public int getKeepAliveTimeout()

The number of seconds Tomcat will wait for a subsequent request before closing the connection.

getMaxHttpHeaderSize

public int getMaxHttpHeaderSize()

getMaxKeepAliveRequests

public int getMaxKeepAliveRequests()

getMaxSavePostSize

public int getMaxSavePostSize()

getMaxThreads

public int getMaxThreads()

getName

public String getName()

getNoCompressionUserAgents

public String getNoCompressionUserAgents()

getObjectName

public ObjectName getObjectName()

getPollerSize

public int getPollerSize()

getPollerThreadCount

public int getPollerThreadCount()

getPollTime

public int getPollTime()

getPort

public int getPort()

getProcessorCache

public int getProcessorCache()

getProtocol

public String getProtocol()

getRestrictedUserAgents

public String getRestrictedUserAgents()

getSecure

public boolean getSecure()

getSendfileSize

public int getSendfileSize()

getSendfileThreadCount

public int getSendfileThreadCount()

getServer

public String getServer()

getSocketBuffer

public int getSocketBuffer()

getSoLinger

public int getSoLinger()

getSoTimeout

public int getSoTimeout()

getSSLCACertificateFile

public String getSSLCACertificateFile()

SSL CA certificate file.

getSSLCACertificatePath

public String getSSLCACertificatePath()

SSL CA certificate path.

getSSLCARevocationFile

public String getSSLCARevocationFile()

SSL CA revocation file.

getSSLCARevocationPath

public String getSSLCARevocationPath()

SSL CA revocation path.

getSSLCertificateChainFile

public String getSSLCertificateChainFile()

SSL certificate chain file.

getSSLCertificateFile

public String getSSLCertificateFile()

SSL certificate file.

getSSLCertificateKeyFile

public String getSSLCertificateKeyFile()

SSL certificate key file.

getSSLCipherSuite

public String getSSLCipherSuite()

SSL cipher suite.

getSSLPassword

public String getSSLPassword()

SSL password (if a cert is encrypted, and no password has been provided, a callback will ask for a password).

getSSLProtocol

public String getSSLProtocol()

SSL protocol.

getSSLVerifyClient

public String getSSLVerifyClient()

SSL verify client.

getSSLVerifyDepth

public int getSSLVerifyDepth()

SSL verify depth.

getTcpNoDelay

public boolean getTcpNoDelay()

getThreadPriority

public int getThreadPriority()

getTimeout

public int getTimeout()

getUnlockTimeout

public int getUnlockTimeout()

getUseSendfile

public boolean getUseSendfile()

init

public void init()

Start the protocol

isSSLEnabled

public boolean isSSLEnabled()

SSL engine.

pause

public void pause()

postDeregister

public void postDeregister()

postRegister

public void postRegister(Boolean registrationDone)

preDeregister

public void preDeregister()

preRegister

public ObjectName preRegister(MBeanServer server, ObjectName name)

resume

public void resume()

setAdapter

public void setAdapter(Adapter adapter)

setAddress

public void setAddress(InetAddress ia)

setAttribute

public void setAttribute(String name, Object value)

Pass config info

setBacklog

public void setBacklog(int backlog)

setCompressableMimeType

public void setCompressableMimeType(String valueS)

setCompression

public void setCompression(String valueS)

setCompressionMinSize

public void setCompressionMinSize(int valueI)

setDeferAccept

public void setDeferAccept(boolean deferAccept)

setDisableUploadTimeout

public void setDisableUploadTimeout(boolean isDisabled)

setExecutor

public void setExecutor(Executor executor)

setKeepAlive

public void setKeepAlive(boolean keepAlive)

Set the keep-alive policy for this connection.

setKeepAliveTimeout

public void setKeepAliveTimeout(int timeout)

setMaxHttpHeaderSize

public void setMaxHttpHeaderSize(int valueI)

setMaxKeepAliveRequests

public void setMaxKeepAliveRequests(int mkar)

setMaxSavePostSize

public void setMaxSavePostSize(int valueI)

setMaxThreads

public void setMaxThreads(int maxThreads)

setNoCompressionUserAgents

public void setNoCompressionUserAgents(String valueS)

setPollerSize

public void setPollerSize(int pollerSize)

setPollerThreadCount

public void setPollerThreadCount(int pollerThreadCount)

setPollTime

public void setPollTime(int pollTime)

setPort

public void setPort(int port)

setProcessorCache

public void setProcessorCache(int processorCache)

setProtocol

public void setProtocol(String protocol)

setRestrictedUserAgents

public void setRestrictedUserAgents(String valueS)

setSecure

public void setSecure(boolean b)

setSendfileSize

public void setSendfileSize(int sendfileSize)

setSendfileThreadCount

public void setSendfileThreadCount(int sendfileThreadCount)

setServer

public void setServer(String server)

setSocketBuffer

public void setSocketBuffer(int socketBuffer)

setSoLinger

public void setSoLinger(int soLinger)

setSoTimeout

public void setSoTimeout(int soTimeout)

setSSLCACertificateFile

public void setSSLCACertificateFile(String SSLCACertificateFile)

setSSLCACertificatePath

public void setSSLCACertificatePath(String SSLCACertificatePath)

setSSLCARevocationFile

public void setSSLCARevocationFile(String SSLCARevocationFile)

setSSLCARevocationPath

public void setSSLCARevocationPath(String SSLCARevocationPath)

setSSLCertificateChainFile

public void setSSLCertificateChainFile(String SSLCertificateChainFile)

setSSLCertificateFile

public void setSSLCertificateFile(String SSLCertificateFile)

setSSLCertificateKeyFile

public void setSSLCertificateKeyFile(String SSLCertificateKeyFile)

setSSLCipherSuite

public void setSSLCipherSuite(String SSLCipherSuite)

setSSLEnabled

public void setSSLEnabled(boolean SSLEnabled)

setSSLPassword

public void setSSLPassword(String SSLPassword)

setSSLProtocol

public void setSSLProtocol(String SSLProtocol)

setSSLVerifyClient

public void setSSLVerifyClient(String SSLVerifyClient)

setSSLVerifyDepth

public void setSSLVerifyDepth(int SSLVerifyDepth)

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

setThreadPriority

public void setThreadPriority(int threadPriority)

setTimeout

public void setTimeout(int timeout)

setUnlockTimeout

public void setUnlockTimeout(int unlockTimeout)

setUseSendfile

public void setUseSendfile(boolean useSendfile)

start

public void start()