Http11Protocol (JBoss Web 8.0.0.Alpha1 API)

java.lang.Object
- org.apache.coyote.http11.Http11Protocol

All Implemented Interfaces:

MBeanRegistration, ProtocolHandler
```
public class Http11Protocol
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 Http11Protocol.Http11ConnectionHandler

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Adapter`	`adapter` The adapter, used to call the connector.
`protected HashMap<String,Object>`	`attributes`
`protected Http11Protocol.Http11ConnectionHandler`	`cHandler`
`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 JIoEndpoint`	`endpoint`
`protected int`	`keepAliveTimeout` The number of seconds Tomcat will wait for a subsequent request before closing the connection.
`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`	`restrictedUserAgents` User agents regular expressions which should be restricted to HTTP/1.0 support.
`protected ObjectName`	`rgOname`
`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 int`	`socketBuffer`
`protected ServerSocketFactory`	`socketFactory`
`protected String`	`socketFactoryName` Name of the socket factory.
`protected boolean`	`SSLEnabled`
`protected JSSEImplementation`	`sslImplementation`
`protected String`	`sslImplementationName` Name of the SSL implementation.
`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.
`protected ObjectName`	`tpOname`

Constructor Summary

Constructors
Constructor and Description

Http11Protocol()

Constructors
Constructor and Description
`Http11Protocol()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()`
`Adapter`	`getAdapter()`
`InetAddress`	`getAddress()`
`String`	`getAlgorithm()`
`Object`	`getAttribute(String key)`
`Iterator`	`getAttributeNames()`
`int`	`getBacklog()`
`String`	`getCiphers()`
`String`	`getClientauth()`
`String`	`getCompressableMimeType()`
`String`	`getCompression()`
`int`	`getCompressionMinSize()`
`boolean`	`getDisableUploadTimeout()`
`String`	`getDomain()`
`Executor`	`getExecutor()`
`String`	`getJmxName()`
`boolean`	`getKeepAlive()` Return the Keep-Alive policy for the connection.
`int`	`getKeepAliveTimeout()`
`String`	`getKeyAlias()`
`String`	`getKeypass()`
`String`	`getKeystore()`
`String`	`getKeytype()`
`int`	`getMaxHttpHeaderSize()`
`int`	`getMaxKeepAliveRequests()`
`int`	`getMaxSavePostSize()`
`int`	`getMaxThreads()`
`String`	`getName()`
`String`	`getNoCompressionUserAgents()`
`ObjectName`	`getObjectName()`
`int`	`getPollerSize()`
`int`	`getPort()`
`int`	`getProcessorCache()`
`String`	`getProperty(String name)` Get a property
`String`	`getProtocols()`
`RequestGroupInfo`	`getRequestGroupInfo()`
`String`	`getRestrictedUserAgents()`
`boolean`	`getSecure()`
`String`	`getServer()`
`int`	`getSocketBuffer()`
`String`	`getSocketFactory()`
`int`	`getSoLinger()`
`int`	`getSoTimeout()`
`SSLContext`	`getSSLContext()`
`String`	`getSSLImplementation()`
`boolean`	`getTcpNoDelay()`
`int`	`getThreadPriority()`
`int`	`getTimeout()`
`boolean`	`hasIoEvents()`
`void`	`init()` Init the protocol.
`boolean`	`isSSLEnabled()`
`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`	`setAlgorithm(String k)`
`void`	`setAttribute(String name, Object value)` Pass config info
`void`	`setBacklog(int backlog)`
`void`	`setCiphers(String ciphers)`
`void`	`setClientauth(String k)`
`void`	`setCompressableMimeType(String valueS)`
`void`	`setCompression(String valueS)`
`void`	`setCompressionMinSize(int valueI)`
`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`	`setKeyAlias(String keyAlias)`
`void`	`setKeypass(String k)`
`void`	`setKeystore(String k)`
`void`	`setKeytype(String k)`
`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`	`setPort(int port)`
`void`	`setProcessorCache(int processorCache)`
`void`	`setProperty(String name, String value)` Set a property.
`void`	`setProtocols(String k)`
`void`	`setRestrictedUserAgents(String valueS)`
`void`	`setSecure(boolean b)`
`void`	`setServer(String server)`
`void`	`setSocketBuffer(int socketBuffer)`
`void`	`setSocketFactory(String valueS)`
`void`	`setSoLinger(int soLinger)`
`void`	`setSoTimeout(int soTimeout)`
`void`	`setSSLContext(SSLContext sslContext)`
`void`	`setSSLEnabled(boolean SSLEnabled)`
`void`	`setSSLImplementation(String valueS)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setThreadPriority(int threadPriority)`
`void`	`setTimeout(int timeout)`
`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
- cHandler
```
protected Http11Protocol.Http11ConnectionHandler cHandler
```
- endpoint
```
protected JIoEndpoint endpoint
```
- tpOname
```
protected ObjectName tpOname
```
- rgOname
```
protected ObjectName rgOname
```
- socketFactory
```
protected ServerSocketFactory socketFactory
```
- sslImplementation
```
protected JSSEImplementation sslImplementation
```
- attributes
```
protected HashMap<String,Object> attributes
```
- adapter
```
protected Adapter adapter
```
  The adapter, used to call the connector.
- processorCache
```
protected int processorCache
```
  Processor cache.
- socketBuffer
```
protected int socketBuffer
```
- secure
```
protected boolean secure
```
  This field indicates if the protocol is secure from the perspective of the client (= https is used).
- SSLEnabled
```
protected boolean SSLEnabled
```
- socketFactoryName
```
protected String socketFactoryName
```
  Name of the socket factory.
- sslImplementationName
```
protected String sslImplementationName
```
  Name of the SSL implementation.
- 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.
- keepAliveTimeout
```
protected int keepAliveTimeout
```
  The number of seconds Tomcat will wait for a subsequent request before closing the connection. The default is the same as for Apache HTTP Server (15 000 milliseconds).
- timeout
```
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. The default is the same as for Apache HTTP Server (300 000 milliseconds).
- maxSavePostSize
```
protected int maxSavePostSize
```
  Maximum size of the post which will be saved when processing certain requests, such as a POST.
- maxHttpHeaderSize
```
protected int maxHttpHeaderSize
```
  Maximum size of the HTTP message header.
- disableUploadTimeout
```
protected boolean disableUploadTimeout
```
  If true, the regular socket timeout will be used for the full duration of the connection.
- compression
```
protected String compression
```
  Integrated compression support.
- noCompressionUserAgents
```
protected String noCompressionUserAgents
```
- compressableMimeTypes
```
protected String compressableMimeTypes
```
- compressionMinSize
```
protected int compressionMinSize
```
- restrictedUserAgents
```
protected String restrictedUserAgents
```
  User agents regular expressions which should be restricted to HTTP/1.0 support.
- server
```
protected String server
```
  Server header.
- domain
```
protected String domain
```
- oname
```
protected ObjectName oname
```
- mserver
```
protected MBeanServer mserver
```

Constructor Detail
- Http11Protocol
```
public Http11Protocol()
```

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

setProperty

public void setProperty(String name,
                        String value)

Set a property.

getProperty

public String getProperty(String name)

Get a property

setAdapter
```
public void setAdapter(Adapter adapter)
```
Description copied from interface: ProtocolHandler

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
```
Description copied from interface: ProtocolHandler

Init 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)

getSocketBuffer
```
public int getSocketBuffer()
```

setSocketBuffer

public void setSocketBuffer(int socketBuffer)

getSecure
```
public boolean getSecure()
```

setSecure
```
public void setSecure(boolean b)
```

isSSLEnabled
```
public boolean isSSLEnabled()
```

setSSLEnabled

public void setSSLEnabled(boolean SSLEnabled)

getSocketFactory
```
public String getSocketFactory()
```

setSocketFactory

public void setSocketFactory(String valueS)

getSSLImplementation
```
public String getSSLImplementation()
```

setSSLImplementation

public void setSSLImplementation(String valueS)

getMaxKeepAliveRequests
```
public int getMaxKeepAliveRequests()
```

setMaxKeepAliveRequests

public void setMaxKeepAliveRequests(int mkar)

getKeepAliveTimeout
```
public int getKeepAliveTimeout()
```

setKeepAliveTimeout

public void setKeepAliveTimeout(int timeout)

getTimeout
```
public int getTimeout()
```

setTimeout
```
public void setTimeout(int timeout)
```

getMaxSavePostSize
```
public int getMaxSavePostSize()
```

setMaxSavePostSize

public void setMaxSavePostSize(int valueI)

getMaxHttpHeaderSize
```
public int getMaxHttpHeaderSize()
```

setMaxHttpHeaderSize

public void setMaxHttpHeaderSize(int valueI)

getDisableUploadTimeout

public boolean getDisableUploadTimeout()

setDisableUploadTimeout

public void setDisableUploadTimeout(boolean isDisabled)

getCompression
```
public String getCompression()
```

setCompression

public void setCompression(String valueS)

getNoCompressionUserAgents

public String getNoCompressionUserAgents()

setNoCompressionUserAgents

public void setNoCompressionUserAgents(String valueS)

getCompressableMimeType

public String getCompressableMimeType()

setCompressableMimeType

public void setCompressableMimeType(String valueS)

getCompressionMinSize
```
public int getCompressionMinSize()
```

setCompressionMinSize

public void setCompressionMinSize(int valueI)

getRestrictedUserAgents

public String getRestrictedUserAgents()

setRestrictedUserAgents

public void setRestrictedUserAgents(String valueS)

setServer
```
public void setServer(String server)
```

getServer
```
public String getServer()
```

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)

setPollerSize

public void setPollerSize(int pollerSize)

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

getKeepAlive
```
public boolean getKeepAlive()
```
Return the Keep-Alive policy for the connection.

setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
Set the keep-alive policy for this connection.

getKeystore
```
public String getKeystore()
```

setKeystore
```
public void setKeystore(String k)
```

getKeypass
```
public String getKeypass()
```

setKeypass
```
public void setKeypass(String k)
```

getKeytype
```
public String getKeytype()
```

setKeytype
```
public void setKeytype(String k)
```

getClientauth
```
public String getClientauth()
```

setClientauth
```
public void setClientauth(String k)
```

getProtocols
```
public String getProtocols()
```

setProtocols
```
public void setProtocols(String k)
```

getAlgorithm
```
public String getAlgorithm()
```

setAlgorithm
```
public void setAlgorithm(String k)
```

getCiphers
```
public String getCiphers()
```

setCiphers

public void setCiphers(String ciphers)

getKeyAlias
```
public String getKeyAlias()
```

setKeyAlias

public void setKeyAlias(String keyAlias)

getSSLContext
```
public SSLContext getSSLContext()
```

setSSLContext

public void setSSLContext(SSLContext sslContext)

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 Http11Protocol

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cHandler

endpoint

tpOname

rgOname

socketFactory

sslImplementation

attributes

adapter

processorCache

socketBuffer

secure

SSLEnabled

socketFactoryName

sslImplementationName

maxKeepAliveRequests

keepAliveTimeout

timeout

maxSavePostSize

maxHttpHeaderSize

disableUploadTimeout

compression

noCompressionUserAgents

compressableMimeTypes

compressionMinSize

restrictedUserAgents

server

domain

oname

mserver

Constructor Detail

Http11Protocol

Method Detail

setAttribute

getAttribute

getAttributeNames

setProperty

getProperty

setAdapter

getAdapter

hasIoEvents

getRequestGroupInfo

init

start

pause

resume

destroy

getJmxName

getName

getProcessorCache

setProcessorCache

getSocketBuffer

setSocketBuffer

getSecure

setSecure

isSSLEnabled

setSSLEnabled

getSocketFactory

setSocketFactory

getSSLImplementation

setSSLImplementation

getMaxKeepAliveRequests

setMaxKeepAliveRequests

getKeepAliveTimeout

setKeepAliveTimeout

getTimeout

setTimeout

getMaxSavePostSize

setMaxSavePostSize

getMaxHttpHeaderSize

setMaxHttpHeaderSize

getDisableUploadTimeout

setDisableUploadTimeout

getCompression