org.apache.coyote

Class AbstractProcessor

java.lang.Object

org.apache.coyote.AbstractProcessorLight

org.apache.coyote.AbstractProcessor

All Implemented Interfaces:

ActionHook, Processor

Direct Known Subclasses:

AjpProcessor, Http11Processor, StreamProcessor

public abstract class AbstractProcessor
extends AbstractProcessorLight
implements ActionHook

Provides functionality and attributes common to all supported protocols (currently HTTP and AJP).

Field Summary

Fields

Modifier and Type	Field and Description
protected Adapter	adapter
protected AsyncStateMachine	asyncStateMachine
protected AbstractEndpoint<?>	endpoint
protected Request	request
protected Response	response
protected SocketWrapperBase<?>	socketWrapper
protected SSLSupport	sslSupport

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractProcessor(AbstractEndpoint<?> endpoint)
protected	AbstractProcessor(Request coyoteRequest, Response coyoteResponse) Used by HTTP/2.

Method Summary

Modifier and Type	Method and Description
AbstractEndpoint.Handler.SocketState	asyncPostProcess()
AbstractEndpoint.Handler.SocketState	dispatch(SocketEvent status) Process an in-progress request that is not longer in standard HTTP mode.
protected abstract AbstractEndpoint.Handler.SocketState	dispatchEndRequest() Perform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.
protected void	dispatchNonBlockingRead() Perform any necessary processing for a non-blocking read before dispatching to the adapter.
protected abstract boolean	flushBufferedWrite() Flush any pending writes.
Adapter	getAdapter() Get the associated adapter.
long	getAsyncTimeout()
protected ErrorState	getErrorState()
protected Executor	getExecutor()
Request	getRequest()
protected SocketWrapperBase<?>	getSocketWrapper()
boolean	isAsync()
void	recycle() Recycle the processor, ready for the next request which may be on the same connection or a different connection.
void	setAdapter(Adapter adapter) Set the associated adapter.
void	setAsyncTimeout(long timeout)
protected void	setErrorState(ErrorState errorState, Throwable t) Update the current error state to the new error state if the new error state is more severe than the current error state.
protected void	setSocketWrapper(SocketWrapperBase<?> socketWrapper) Set the socket wrapper being used.
void	setSslSupport(SSLSupport sslSupport) Set the SSL information for this HTTP connection.
void	timeoutAsync(long now) Check this processor to see if the async timeout has expired and process a timeout if that is that case.

Methods inherited from class org.apache.coyote.AbstractProcessorLight

addDispatch, clearDispatches, getIteratorAndClearDispatches, getLog, process, service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.coyote.ActionHook

action

Methods inherited from interface org.apache.coyote.Processor

getLeftoverInput, getUpgradeToken, isUpgrade, pause

Field Detail

adapter

protected Adapter adapter

asyncStateMachine

protected final AsyncStateMachine asyncStateMachine

endpoint

protected final AbstractEndpoint<?> endpoint

request

protected final Request request

response

protected final Response response

socketWrapper

protected volatile SocketWrapperBase<?> socketWrapper

sslSupport

protected volatile SSLSupport sslSupport

Constructor Detail

AbstractProcessor

protected AbstractProcessor(Request coyoteRequest,
                            Response coyoteResponse)

Used by HTTP/2.

Parameters:

coyoteRequest - The request

coyoteResponse - The response

AbstractProcessor

public AbstractProcessor(AbstractEndpoint<?> endpoint)

Method Detail

setErrorState

protected void setErrorState(ErrorState errorState,
                             Throwable t)

Update the current error state to the new error state if the new error state is more severe than the current error state.

Parameters:

errorState - The error status details

t - The error which occurred

getErrorState

protected ErrorState getErrorState()

getRequest

public Request getRequest()

Specified by:

getRequest in interface Processor

Returns:

The request associated with this processor.

setAdapter

public void setAdapter(Adapter adapter)

Set the associated adapter.

Parameters:

adapter - the new adapter

getAdapter

public Adapter getAdapter()

Get the associated adapter.

Returns:

the associated adapter

setSocketWrapper

protected final void setSocketWrapper(SocketWrapperBase<?> socketWrapper)

Set the socket wrapper being used.

Parameters:

socketWrapper - The socket wrapper

getSocketWrapper

protected final SocketWrapperBase<?> getSocketWrapper()

Returns:

the socket wrapper being used.

setSslSupport

public final void setSslSupport(SSLSupport sslSupport)

Description copied from interface: Processor

Set the SSL information for this HTTP connection.

Specified by:

setSslSupport in interface Processor

Parameters:

sslSupport - The SSL support object to use for this connection

getExecutor

protected Executor getExecutor()

Returns:

the Executor used by the underlying endpoint.

isAsync

public boolean isAsync()

Specified by:

isAsync in interface Processor

asyncPostProcess

public AbstractEndpoint.Handler.SocketState asyncPostProcess()

Specified by:

asyncPostProcess in class AbstractProcessorLight

dispatch

public final AbstractEndpoint.Handler.SocketState dispatch(SocketEvent status)

Description copied from class: AbstractProcessorLight

Process an in-progress request that is not longer in standard HTTP mode. Uses currently include Servlet 3.0 Async and HTTP upgrade connections. Further uses may be added in the future. These will typically start as HTTP requests.

Specified by:

dispatch in class AbstractProcessorLight

Parameters:

status - The event to process

Returns:

the socket state

dispatchNonBlockingRead

protected void dispatchNonBlockingRead()

Perform any necessary processing for a non-blocking read before dispatching to the adapter.

timeoutAsync

public void timeoutAsync(long now)

Description copied from interface: Processor

Check this processor to see if the async timeout has expired and process a timeout if that is that case.

Specified by:

timeoutAsync in interface Processor

Parameters:

now - The time (as returned by System.currentTimeMillis() to use as the current time to determine whether the async timeout has expired. If negative, the timeout will always be treated as if it has expired.

setAsyncTimeout

public void setAsyncTimeout(long timeout)

getAsyncTimeout

public long getAsyncTimeout()

recycle

public void recycle()

Description copied from interface: Processor

Recycle the processor, ready for the next request which may be on the same connection or a different connection.

Specified by:

recycle in interface Processor

flushBufferedWrite

protected abstract boolean flushBufferedWrite()
                                       throws IOException

Flush any pending writes. Used during non-blocking writes to flush any remaining data from a previous incomplete write.

Returns:

true if data remains to be flushed at the end of method

Throws:

IOException - If an I/O error occurs while attempting to flush the data

dispatchEndRequest

protected abstract AbstractEndpoint.Handler.SocketState dispatchEndRequest()

Perform any necessary clean-up processing if the dispatch resulted in the completion of processing for the current request.

Returns:

The state to return for the socket once the clean-up for the current request has completed