Top Description Fields Constructors Methods
org.apache.coyote

public final Enum ActionCode

extends Enum<ActionCode>
Class Inheritance

ActionCodes represent callbacks from the servlet container to the coyote connector. Actions are implemented by ProtocolHandler, using the ActionHook interface.
Author
Remy Maucherat
See Also
ProtocolHandler, ActionHook

Field Summary

Modifier and TypeField and Description
public static final ActionCode
public static final ActionCode
public static final ActionCode
public static final ActionCode
ASYNC_DISPATCHED

Callback to indicate the the actual dispatch has started and that the async state needs change.

public static final ActionCode
ASYNC_ERROR

Callback to trigger the error processing.

public static final ActionCode
ASYNC_IS_ASYNC

Callback to determine if async processing is in progress.

public static final ActionCode
ASYNC_IS_COMPLETING

Call back to determine if async complete is in progress.

public static final ActionCode
ASYNC_IS_DISPATCHING

Callback to determine if async dispatch is in progress.

public static final ActionCode
ASYNC_IS_ERROR

Callback to determine if async is in error.

public static final ActionCode
ASYNC_IS_STARTED

Callback to determine if async dispatch is in progress.

public static final ActionCode
ASYNC_IS_TIMINGOUT

Callback to determine if async is timing out.

public static final ActionCode
ASYNC_POST_PROCESS

Callback to trigger post processing.

public static final ActionCode
public static final ActionCode
public static final ActionCode
ASYNC_START

Callback for an async request.

public static final ActionCode
ASYNC_TIMEOUT

Callback to trigger the processing of an async timeout.

public static final ActionCode
AVAILABLE

Callback for getting the amount of available bytes.

public static final ActionCode
CLIENT_FLUSH

A flush() operation originated by the client ( i.e. a flush() on the servlet output stream or writer, called by a servlet ).

public static final ActionCode
public static final ActionCode
CLOSE_NOW

A serious error occurred from which it is not possible to recover safely.

public static final ActionCode
public static final ActionCode
DISABLE_SWALLOW_INPUT

Hook called if swallowing request input should be disabled.

public static final ActionCode
DISPATCH_EXECUTE

Execute any non-blocking dispatches that have been registered via DISPATCH_READ or DISPATCH_WRITE.

public static final ActionCode
DISPATCH_READ

Indicates that the container needs to trigger a call to onDataAvailable() for the registered non-blocking read listener.

public static final ActionCode
DISPATCH_WRITE

Indicates that the container needs to trigger a call to onWritePossible() for the registered non-blocking write listener.

public static final ActionCode
IS_ERROR

Has the processor been placed into the error state?

public static final ActionCode
IS_IO_ALLOWED

The processor may have been placed into an error state and some error states do not permit any further I/O.

public static final ActionCode
IS_PUSH_SUPPORTED

Is server push supported and allowed for the current request?

public static final ActionCode
IS_TRAILER_FIELDS_READY

Are the request trailer fields ready to be read?

public static final ActionCode
IS_TRAILER_FIELDS_SUPPORTED

Are HTTP trailer fields supported for the current response?

public static final ActionCode
NB_READ_INTEREST

Indicator that Servlet is interested in being notified when data is available to be read.

public static final ActionCode
NB_WRITE_INTEREST

Used with non-blocking writes to determine if a write is currently allowed (sets passed parameter to true) or not (sets passed parameter to false).

public static final ActionCode
PROTOCOL_REQUEST_ID

Obtain the request identifier for this request as defined by the protocol in use.

public static final ActionCode
PUSH_REQUEST

Push a request on behalf of the client of the current request.

public static final ActionCode
REQ_HOST_ADDR_ATTRIBUTE

Callback for lazy evaluation - extract the remote host address.

public static final ActionCode
REQ_HOST_ATTRIBUTE

Callback for lazy evaluation - extract the remote host name and address.

public static final ActionCode
REQ_LOCAL_ADDR_ATTRIBUTE

Callback for lazy evaluation - local address.

public static final ActionCode
REQ_LOCAL_NAME_ATTRIBUTE

Callback for lazy evaluation - local address.

public static final ActionCode
REQ_LOCALPORT_ATTRIBUTE

Callback for lazy evaluation - socket local port.

public static final ActionCode
REQ_PEER_ADDR_ATTRIBUTE

Callback for lazy evaluation - extract the connection peer address.

public static final ActionCode
REQ_REMOTEPORT_ATTRIBUTE

Callback for lazy evaluation - socket remote port.

public static final ActionCode
REQ_SET_BODY_REPLAY

Callback for setting FORM auth body replay

public static final ActionCode
REQ_SSL_ATTRIBUTE

Callback for lazy evaluation - extract the SSL-related attributes including the client certificate if present.

public static final ActionCode
REQ_SSL_CERTIFICATE

Force a TLS re-handshake and make the resulting client certificate (if any) available as a request attribute.

public static final ActionCode
REQUEST_BODY_FULLY_READ

Indicates if the request body has been fully read.

public static final ActionCode
SERVLET_CONNECTION

Obtain the servlet connection instance for the network connection supporting the current request.

public static final ActionCode
UPGRADE

Callback to trigger the HTTP upgrade process.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ActionCode
public static ActionCode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ACKback to summary
public static final ActionCode ACK
ASYNC_COMPLETEback to summary
public static final ActionCode ASYNC_COMPLETE

Callback for an async call to jakarta.servlet.AsyncContext#complete().

ASYNC_DISPATCHback to summary
public static final ActionCode ASYNC_DISPATCH

Callback for an async call to jakarta.servlet.AsyncContext#dispatch().

ASYNC_DISPATCHEDback to summary
public static final ActionCode ASYNC_DISPATCHED

Callback to indicate the the actual dispatch has started and that the async state needs change.

ASYNC_ERRORback to summary
public static final ActionCode ASYNC_ERROR

Callback to trigger the error processing.

ASYNC_IS_ASYNCback to summary
public static final ActionCode ASYNC_IS_ASYNC

Callback to determine if async processing is in progress.

ASYNC_IS_COMPLETINGback to summary
public static final ActionCode ASYNC_IS_COMPLETING

Call back to determine if async complete is in progress.

ASYNC_IS_DISPATCHINGback to summary
public static final ActionCode ASYNC_IS_DISPATCHING

Callback to determine if async dispatch is in progress.

ASYNC_IS_ERRORback to summary
public static final ActionCode ASYNC_IS_ERROR

Callback to determine if async is in error.

ASYNC_IS_STARTEDback to summary
public static final ActionCode ASYNC_IS_STARTED

Callback to determine if async dispatch is in progress.

ASYNC_IS_TIMINGOUTback to summary
public static final ActionCode ASYNC_IS_TIMINGOUT

Callback to determine if async is timing out.

ASYNC_POST_PROCESSback to summary
public static final ActionCode ASYNC_POST_PROCESS

Callback to trigger post processing. Typically only used during error handling to trigger essential processing that otherwise would be skipped.

ASYNC_RUNback to summary
public static final ActionCode ASYNC_RUN

Callback for an async call to jakarta.servlet.AsyncContext#start(Runnable).

ASYNC_SETTIMEOUTback to summary
public static final ActionCode ASYNC_SETTIMEOUT

Callback for an async call to jakarta.servlet.AsyncContext#setTimeout(long)

ASYNC_STARTback to summary
public static final ActionCode ASYNC_START

Callback for an async request.

ASYNC_TIMEOUTback to summary
public static final ActionCode ASYNC_TIMEOUT

Callback to trigger the processing of an async timeout.

AVAILABLEback to summary
public static final ActionCode AVAILABLE

Callback for getting the amount of available bytes.

CLIENT_FLUSHback to summary
public static final ActionCode CLIENT_FLUSH

A flush() operation originated by the client ( i.e. a flush() on the servlet output stream or writer, called by a servlet ). Argument is the Response.

CLOSEback to summary
public static final ActionCode CLOSE
CLOSE_NOWback to summary
public static final ActionCode CLOSE_NOW

A serious error occurred from which it is not possible to recover safely. Further attempts to write to the response should be ignored and the connection needs to be closed as soon as possible. This can also be used to forcibly close a connection if an error occurs after the response has been committed.

COMMITback to summary
public static final ActionCode COMMIT
DISABLE_SWALLOW_INPUTback to summary
public static final ActionCode DISABLE_SWALLOW_INPUT

Hook called if swallowing request input should be disabled. Example: Cancel a large file upload.

DISPATCH_EXECUTEback to summary
public static final ActionCode DISPATCH_EXECUTE

Execute any non-blocking dispatches that have been registered via DISPATCH_READ or DISPATCH_WRITE. Typically required when the non-blocking listeners are configured on a thread where the processing wasn't triggered by a read or write event on the socket.

DISPATCH_READback to summary
public static final ActionCode DISPATCH_READ

Indicates that the container needs to trigger a call to onDataAvailable() for the registered non-blocking read listener.

DISPATCH_WRITEback to summary
public static final ActionCode DISPATCH_WRITE

Indicates that the container needs to trigger a call to onWritePossible() for the registered non-blocking write listener.

IS_ERRORback to summary
public static final ActionCode IS_ERROR

Has the processor been placed into the error state? Note that the response may not have an appropriate error code set.

IS_IO_ALLOWEDback to summary
public static final ActionCode IS_IO_ALLOWED

The processor may have been placed into an error state and some error states do not permit any further I/O. Is I/O currently allowed?

IS_PUSH_SUPPORTEDback to summary
public static final ActionCode IS_PUSH_SUPPORTED

Is server push supported and allowed for the current request?

IS_TRAILER_FIELDS_READYback to summary
public static final ActionCode IS_TRAILER_FIELDS_READY

Are the request trailer fields ready to be read? Note that this returns true if it is known that request trailer fields are not supported so an empty collection of trailers can then be read.

IS_TRAILER_FIELDS_SUPPORTEDback to summary
public static final ActionCode IS_TRAILER_FIELDS_SUPPORTED

Are HTTP trailer fields supported for the current response? Note that once an HTTP/1.1 response has been committed, it will no longer support trailer fields.

NB_READ_INTERESTback to summary
public static final ActionCode NB_READ_INTEREST

Indicator that Servlet is interested in being notified when data is available to be read.

NB_WRITE_INTERESTback to summary
public static final ActionCode NB_WRITE_INTEREST

Used with non-blocking writes to determine if a write is currently allowed (sets passed parameter to true) or not (sets passed parameter to false). If a write is not allowed then callback will be triggered at some future point when write becomes possible again.

PROTOCOL_REQUEST_IDback to summary
public static final ActionCode PROTOCOL_REQUEST_ID

Obtain the request identifier for this request as defined by the protocol in use. Note that some protocols do not define such an identifier. E.g. this will be Stream ID for HTTP/2.

PUSH_REQUESTback to summary
public static final ActionCode PUSH_REQUEST

Push a request on behalf of the client of the current request.

REQ_HOST_ADDR_ATTRIBUTEback to summary
public static final ActionCode REQ_HOST_ADDR_ATTRIBUTE

Callback for lazy evaluation - extract the remote host address.

REQ_HOST_ATTRIBUTEback to summary
public static final ActionCode REQ_HOST_ATTRIBUTE

Callback for lazy evaluation - extract the remote host name and address.

REQ_LOCAL_ADDR_ATTRIBUTEback to summary
public static final ActionCode REQ_LOCAL_ADDR_ATTRIBUTE

Callback for lazy evaluation - local address.

REQ_LOCAL_NAME_ATTRIBUTEback to summary
public static final ActionCode REQ_LOCAL_NAME_ATTRIBUTE

Callback for lazy evaluation - local address.

REQ_LOCALPORT_ATTRIBUTEback to summary
public static final ActionCode REQ_LOCALPORT_ATTRIBUTE

Callback for lazy evaluation - socket local port.

REQ_PEER_ADDR_ATTRIBUTEback to summary
public static final ActionCode REQ_PEER_ADDR_ATTRIBUTE

Callback for lazy evaluation - extract the connection peer address.

REQ_REMOTEPORT_ATTRIBUTEback to summary
public static final ActionCode REQ_REMOTEPORT_ATTRIBUTE

Callback for lazy evaluation - socket remote port.

REQ_SET_BODY_REPLAYback to summary
public static final ActionCode REQ_SET_BODY_REPLAY

Callback for setting FORM auth body replay

REQ_SSL_ATTRIBUTEback to summary
public static final ActionCode REQ_SSL_ATTRIBUTE

Callback for lazy evaluation - extract the SSL-related attributes including the client certificate if present.

REQ_SSL_CERTIFICATEback to summary
public static final ActionCode REQ_SSL_CERTIFICATE

Force a TLS re-handshake and make the resulting client certificate (if any) available as a request attribute.

REQUEST_BODY_FULLY_READback to summary
public static final ActionCode REQUEST_BODY_FULLY_READ

Indicates if the request body has been fully read.

SERVLET_CONNECTIONback to summary
public static final ActionCode SERVLET_CONNECTION

Obtain the servlet connection instance for the network connection supporting the current request.

UPGRADEback to summary
public static final ActionCode UPGRADE

Callback to trigger the HTTP upgrade process.

Constructor Detail

ActionCodeback to summary
private ActionCode()

Method Detail

valueOfback to summary
public static ActionCode valueOf(String name)
valuesback to summary
public static ActionCode[] values()