ProtocolHandler (Apache Tomcat 8.0.53 API Documentation)

All Known Implementing Classes:

AbstractAjpProtocol, AbstractHttp11JsseProtocol, AbstractHttp11Protocol, AbstractProtocol, AjpAprProtocol, AjpNio2Protocol, AjpNioProtocol, AjpProtocol, Http11AprProtocol, Http11Nio2Protocol, Http11NioProtocol, Http11Protocol
```
public interface ProtocolHandler
```
Abstract the protocol implementation, including threading, etc. Processor is single threaded and specific to stream-based protocols, will not fit Jk protocols like JNI. This is the main interface to be implemented by a coyote connector. Adapter is the main interface to be implemented by a coyote servlet container.

Author:

Remy Maucherat, Costin Manolache

See Also:
Adapter

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroy the protocol (optional).
`Adapter`	`getAdapter()`
`java.util.concurrent.Executor`	`getExecutor()` The executor, provide access to the underlying thread pool.
`void`	`init()` Initialise the protocol.
`boolean`	`isAprRequired()` Requires APR/native library
`boolean`	`isCometSupported()` Does this ProtocolHandler support Comet?
`boolean`	`isCometTimeoutSupported()` Does this ProtocolHandler support Comet timeouts?
`boolean`	`isSendfileSupported()` Does this ProtocolHandler support sendfile?
`void`	`pause()` Pause the protocol (optional).
`void`	`resume()` Resume the protocol (optional).
`void`	`setAdapter(Adapter adapter)` The adapter, used to call the connector.
`void`	`start()` Start the protocol.
`void`	`stop()` Stop the protocol.

- Method Detail
  - setAdapter
```
void setAdapter(Adapter adapter)
```
    The adapter, used to call the connector.
  - getAdapter
```
Adapter getAdapter()
```
  - getExecutor
```
java.util.concurrent.Executor getExecutor()
```
    The executor, provide access to the underlying thread pool.
  - init
```
void init()
          throws java.lang.Exception
```
    Initialise the protocol.
    
    Throws:
    
    java.lang.Exception
  - start
```
void start()
           throws java.lang.Exception
```
    Start the protocol.
    
    Throws:
    
    java.lang.Exception
  - pause
```
void pause()
           throws java.lang.Exception
```
    Pause the protocol (optional).
    
    Throws:
    
    java.lang.Exception
  - resume
```
void resume()
            throws java.lang.Exception
```
    Resume the protocol (optional).
    
    Throws:
    
    java.lang.Exception
  - stop
```
void stop()
          throws java.lang.Exception
```
    Stop the protocol.
    
    Throws:
    
    java.lang.Exception
  - destroy
```
void destroy()
             throws java.lang.Exception
```
    Destroy the protocol (optional).
    
    Throws:
    
    java.lang.Exception
  - isAprRequired
```
boolean isAprRequired()
```
    Requires APR/native library
  - isCometSupported
```
boolean isCometSupported()
```
    Does this ProtocolHandler support Comet?
  - isCometTimeoutSupported
```
boolean isCometTimeoutSupported()
```
    Does this ProtocolHandler support Comet timeouts?
  - isSendfileSupported
```
boolean isSendfileSupported()
```
    Does this ProtocolHandler support sendfile?

Interface ProtocolHandler

Method Summary

Method Detail

setAdapter

getAdapter

getExecutor

init

start

pause

resume

stop

destroy

isAprRequired

isCometSupported

isCometTimeoutSupported

isSendfileSupported