AbstractProcessor (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.coyote.http11.upgrade.AbstractProcessor<S>

All Implemented Interfaces:

java.lang.AutoCloseable, WebConnection, Processor<S>

Direct Known Subclasses:

AprProcessor, BioProcessor, Nio2Processor, NioProcessor
```
public abstract class AbstractProcessor<S>
extends java.lang.Object
implements Processor<S>, WebConnection
```

Field Summary

Fields
Modifier and Type Field and Description

protected static StringManager sm

Fields
Modifier and Type	Field and Description
`protected static StringManager`	`sm`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractProcessor(UpgradeToken upgradeToken, AbstractServletInputStream upgradeServletInputStream, AbstractServletOutputStream<S> upgradeServletOutputStream)`

Method Summary

Methods
Modifier and Type	Method and Description
`AbstractEndpoint.Handler.SocketState`	`asyncDispatch(SocketStatus status)`
`AbstractEndpoint.Handler.SocketState`	`asyncPostProcess()`
`void`	`close()`
`void`	`errorDispatch()`
`AbstractEndpoint.Handler.SocketState`	`event(SocketStatus status)`
`java.util.concurrent.Executor`	`getExecutor()`
`ServletInputStream`	`getInputStream()` Provides access to the `ServletInputStream` for reading data from the client.
`java.nio.ByteBuffer`	`getLeftoverInput()` Allows retrieving additional input during the upgrade process
`protected abstract Log`	`getLog()`
`ServletOutputStream`	`getOutputStream()` Provides access to the `ServletOutputStream` for writing data to the client.
`Request`	`getRequest()`
`UpgradeToken`	`getUpgradeToken()`
`boolean`	`isAsync()`
`boolean`	`isComet()`
`boolean`	`isUpgrade()`
`AbstractEndpoint.Handler.SocketState`	`process(SocketWrapper<S> socketWrapper)`
`void`	`recycle(boolean socketClosing)`
`void`	`setSslSupport(SSLSupport sslSupport)`
`AbstractEndpoint.Handler.SocketState`	`upgradeDispatch(SocketStatus status)`

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

- Field Detail
  - sm
```
protected static final StringManager sm
```
- Constructor Detail
  - AbstractProcessor
```
protected AbstractProcessor(UpgradeToken upgradeToken,
                 AbstractServletInputStream upgradeServletInputStream,
                 AbstractServletOutputStream<S> upgradeServletOutputStream)
```
- Method Detail
  - getLog
```
protected abstract Log getLog()
```
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - getInputStream
```
public ServletInputStream getInputStream()
                                  throws java.io.IOException
```
    Description copied from interface: javax.servlet.http.WebConnection
    
    Provides access to the ServletInputStream for reading data from the client.
    
    Specified by:
    
    getInputStream in interface WebConnection
    
    Returns:
    the input stream
    
    Throws:
    
    java.io.IOException - If an I/O occurs while obtaining the stream
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws java.io.IOException
```
    Description copied from interface: javax.servlet.http.WebConnection
    
    Provides access to the ServletOutputStream for writing data to the client.
    
    Specified by:
    
    getOutputStream in interface WebConnection
    
    Returns:
    the output stream
    
    Throws:
    
    java.io.IOException - If an I/O occurs while obtaining the stream
  - isUpgrade
```
public final boolean isUpgrade()
```
    Specified by:
    
    isUpgrade in interface Processor<S>
  - getUpgradeToken
```
public UpgradeToken getUpgradeToken()
```
    Specified by:
    
    getUpgradeToken in interface Processor<S>
  - upgradeDispatch
```
public final AbstractEndpoint.Handler.SocketState upgradeDispatch(SocketStatus status)
                                                           throws java.io.IOException
```
    Specified by:
    
    upgradeDispatch in interface Processor<S>
    
    Throws:
    
    java.io.IOException
  - recycle
```
public final void recycle(boolean socketClosing)
```
    Specified by:
    
    recycle in interface Processor<S>
  - getExecutor
```
public final java.util.concurrent.Executor getExecutor()
```
    Specified by:
    
    getExecutor in interface Processor<S>
  - process
```
public final AbstractEndpoint.Handler.SocketState process(SocketWrapper<S> socketWrapper)
                                                   throws java.io.IOException
```
    Specified by:
    
    process in interface Processor<S>
    
    Throws:
    
    java.io.IOException
  - event
```
public final AbstractEndpoint.Handler.SocketState event(SocketStatus status)
                                                 throws java.io.IOException
```
    Specified by:
    
    event in interface Processor<S>
    
    Throws:
    
    java.io.IOException
  - asyncDispatch
```
public final AbstractEndpoint.Handler.SocketState asyncDispatch(SocketStatus status)
```
    Specified by:
    
    asyncDispatch in interface Processor<S>
  - errorDispatch
```
public void errorDispatch()
```
    Specified by:
    
    errorDispatch in interface Processor<S>
  - asyncPostProcess
```
public final AbstractEndpoint.Handler.SocketState asyncPostProcess()
```
    Specified by:
    
    asyncPostProcess in interface Processor<S>
  - isComet
```
public final boolean isComet()
```
    Specified by:
    
    isComet in interface Processor<S>
  - isAsync
```
public final boolean isAsync()
```
    Specified by:
    
    isAsync in interface Processor<S>
  - getRequest
```
public final Request getRequest()
```
    Specified by:
    
    getRequest in interface Processor<S>
  - setSslSupport
```
public final void setSslSupport(SSLSupport sslSupport)
```
    Specified by:
    
    setSslSupport in interface Processor<S>
  - getLeftoverInput
```
public java.nio.ByteBuffer getLeftoverInput()
```
    Description copied from interface: Processor
    
    Allows retrieving additional input during the upgrade process
    
    Specified by:
    
    getLeftoverInput in interface Processor<S>
    
    Returns:
    leftover bytes

Class AbstractProcessor<S>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sm

Constructor Detail

AbstractProcessor

Method Detail

getLog

close

getInputStream

getOutputStream

isUpgrade

getUpgradeToken

upgradeDispatch

recycle

getExecutor

process

event

asyncDispatch

errorDispatch

asyncPostProcess

isComet

isAsync

getRequest

setSslSupport

getLeftoverInput