Package org.apache.coyote
Enum ActionCode
- java.lang.Object
- 
- java.lang.Enum<ActionCode>
- 
- org.apache.coyote.ActionCode
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable,- java.lang.Comparable<ActionCode>
 
 public enum ActionCode extends java.lang.Enum<ActionCode> 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
 
- 
- 
Enum Constant SummaryEnum Constants Enum Constant Description ACKASYNC_COMPLETECallback for an async call toAsyncContext.complete().ASYNC_DISPATCHCallback for an async call toAsyncContext.dispatch().ASYNC_DISPATCHEDCallback to indicate the the actual dispatch has started and that the async state needs change.ASYNC_ERRORCallback to trigger the error processing.ASYNC_IS_ASYNCCallback to determine if async processing is in progress.ASYNC_IS_COMPLETINGCall back to determine if async complete is in progress.ASYNC_IS_DISPATCHINGCallback to determine if async dispatch is in progress.ASYNC_IS_ERRORCallback to determine if async is in error.ASYNC_IS_STARTEDCallback to determine if async dispatch is in progress.ASYNC_IS_TIMINGOUTCallback to determine if async is timing out.ASYNC_POST_PROCESSCallback to trigger post processing.ASYNC_RUNCallback for an async call toAsyncContext.start(Runnable).ASYNC_SETTIMEOUTCallback for an async call toAsyncContext.setTimeout(long)ASYNC_STARTCallback for an async request.ASYNC_TIMEOUTCallback to trigger the processing of an async timeout.AVAILABLECallback for getting the amount of available bytes.CLIENT_FLUSHA flush() operation originated by the client ( i.e. a flush() on the servlet output stream or writer, called by a servlet ).CLOSECLOSE_NOWA serious error occurred from which it is not possible to recover safely.COMMITCONNECTION_IDObtain the connection identifier for the request.DISABLE_SWALLOW_INPUTHook called if swallowing request input should be disabled.DISPATCH_EXECUTEExecute any non-blocking dispatches that have been registered viaDISPATCH_READorDISPATCH_WRITE.DISPATCH_READIndicates that the container needs to trigger a call to onDataAvailable() for the registered non-blocking read listener.DISPATCH_WRITEIndicates that the container needs to trigger a call to onWritePossible() for the registered non-blocking write listener.IS_ERRORHas the processor been placed into the error state?IS_IO_ALLOWEDThe processor may have been placed into an error state and some error states do not permit any further I/O.IS_PUSH_SUPPORTEDIs server push supported and allowed for the current request?IS_TRAILER_FIELDS_READYAre the request trailer fields ready to be read?IS_TRAILER_FIELDS_SUPPORTEDAre HTTP trailer fields supported for the current response?NB_READ_INTERESTIndicator that Servlet is interested in being notified when data is available to be read.NB_WRITE_INTERESTUsed with non-blocking writes to determine if a write is currently allowed (sets passed parameter totrue) or not (sets passed parameter tofalse).PUSH_REQUESTPush a request on behalf of the client of the current request.REQ_HOST_ADDR_ATTRIBUTECallback for lazy evaluation - extract the remote host address.REQ_HOST_ATTRIBUTECallback for lazy evaluation - extract the remote host name and address.REQ_LOCAL_ADDR_ATTRIBUTECallback for lazy evaluation - local address.REQ_LOCAL_NAME_ATTRIBUTECallback for lazy evaluation - local address.REQ_LOCALPORT_ATTRIBUTECallback for lazy evaluation - socket local port.REQ_PEER_ADDR_ATTRIBUTECallback for lazy evaluation - extract the connection peer address.REQ_REMOTEPORT_ATTRIBUTECallback for lazy evaluation - socket remote port.REQ_SET_BODY_REPLAYCallback for setting FORM auth body replayREQ_SSL_ATTRIBUTECallback for lazy evaluation - extract the SSL-related attributes including the client certificate if present.REQ_SSL_CERTIFICATEForce a TLS re-handshake and make the resulting client certificate (if any) available as a request attribute.REQUEST_BODY_FULLY_READIndicates if the request body has been fully read.STREAM_IDObtain the stream identifier for the request.UPGRADECallback to trigger the HTTP upgrade process.
 - 
Method SummaryAll Methods Static Methods Concrete Methods Modifier and Type Method Description static ActionCodevalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static ActionCode[]values()Returns an array containing the constants of this enum type, in the order they are declared.
 
- 
- 
- 
Enum Constant Detail- 
ACKpublic static final ActionCode ACK 
 - 
CLOSEpublic static final ActionCode CLOSE 
 - 
COMMITpublic static final ActionCode COMMIT 
 - 
CLOSE_NOWpublic 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.
 - 
CLIENT_FLUSHpublic 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.
 - 
IS_ERRORpublic 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_ALLOWEDpublic 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?
 - 
DISABLE_SWALLOW_INPUTpublic static final ActionCode DISABLE_SWALLOW_INPUT Hook called if swallowing request input should be disabled. Example: Cancel a large file upload.
 - 
REQ_HOST_ATTRIBUTEpublic static final ActionCode REQ_HOST_ATTRIBUTE Callback for lazy evaluation - extract the remote host name and address.
 - 
REQ_HOST_ADDR_ATTRIBUTEpublic static final ActionCode REQ_HOST_ADDR_ATTRIBUTE Callback for lazy evaluation - extract the remote host address.
 - 
REQ_PEER_ADDR_ATTRIBUTEpublic static final ActionCode REQ_PEER_ADDR_ATTRIBUTE Callback for lazy evaluation - extract the connection peer address.
 - 
REQ_SSL_ATTRIBUTEpublic static final ActionCode REQ_SSL_ATTRIBUTE Callback for lazy evaluation - extract the SSL-related attributes including the client certificate if present.
 - 
REQ_SSL_CERTIFICATEpublic static final ActionCode REQ_SSL_CERTIFICATE Force a TLS re-handshake and make the resulting client certificate (if any) available as a request attribute.
 - 
REQ_REMOTEPORT_ATTRIBUTEpublic static final ActionCode REQ_REMOTEPORT_ATTRIBUTE Callback for lazy evaluation - socket remote port.
 - 
REQ_LOCALPORT_ATTRIBUTEpublic static final ActionCode REQ_LOCALPORT_ATTRIBUTE Callback for lazy evaluation - socket local port.
 - 
REQ_LOCAL_ADDR_ATTRIBUTEpublic static final ActionCode REQ_LOCAL_ADDR_ATTRIBUTE Callback for lazy evaluation - local address.
 - 
REQ_LOCAL_NAME_ATTRIBUTEpublic static final ActionCode REQ_LOCAL_NAME_ATTRIBUTE Callback for lazy evaluation - local address.
 - 
REQ_SET_BODY_REPLAYpublic static final ActionCode REQ_SET_BODY_REPLAY Callback for setting FORM auth body replay
 - 
AVAILABLEpublic static final ActionCode AVAILABLE Callback for getting the amount of available bytes.
 - 
ASYNC_STARTpublic static final ActionCode ASYNC_START Callback for an async request.
 - 
ASYNC_DISPATCHpublic static final ActionCode ASYNC_DISPATCH Callback for an async call toAsyncContext.dispatch().
 - 
ASYNC_DISPATCHEDpublic static final ActionCode ASYNC_DISPATCHED Callback to indicate the the actual dispatch has started and that the async state needs change.
 - 
ASYNC_RUNpublic static final ActionCode ASYNC_RUN Callback for an async call toAsyncContext.start(Runnable).
 - 
ASYNC_COMPLETEpublic static final ActionCode ASYNC_COMPLETE Callback for an async call toAsyncContext.complete().
 - 
ASYNC_TIMEOUTpublic static final ActionCode ASYNC_TIMEOUT Callback to trigger the processing of an async timeout.
 - 
ASYNC_ERRORpublic static final ActionCode ASYNC_ERROR Callback to trigger the error processing.
 - 
ASYNC_SETTIMEOUTpublic static final ActionCode ASYNC_SETTIMEOUT Callback for an async call toAsyncContext.setTimeout(long)
 - 
ASYNC_IS_ASYNCpublic static final ActionCode ASYNC_IS_ASYNC Callback to determine if async processing is in progress.
 - 
ASYNC_IS_STARTEDpublic static final ActionCode ASYNC_IS_STARTED Callback to determine if async dispatch is in progress.
 - 
ASYNC_IS_COMPLETINGpublic static final ActionCode ASYNC_IS_COMPLETING Call back to determine if async complete is in progress.
 - 
ASYNC_IS_DISPATCHINGpublic static final ActionCode ASYNC_IS_DISPATCHING Callback to determine if async dispatch is in progress.
 - 
ASYNC_IS_TIMINGOUTpublic static final ActionCode ASYNC_IS_TIMINGOUT Callback to determine if async is timing out.
 - 
ASYNC_IS_ERRORpublic static final ActionCode ASYNC_IS_ERROR Callback to determine if async is in error.
 - 
ASYNC_POST_PROCESSpublic 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.
 - 
UPGRADEpublic static final ActionCode UPGRADE Callback to trigger the HTTP upgrade process.
 - 
NB_READ_INTERESTpublic static final ActionCode NB_READ_INTEREST Indicator that Servlet is interested in being notified when data is available to be read.
 - 
NB_WRITE_INTERESTpublic static final ActionCode NB_WRITE_INTEREST Used with non-blocking writes to determine if a write is currently allowed (sets passed parameter totrue) or not (sets passed parameter tofalse). If a write is not allowed then callback will be triggered at some future point when write becomes possible again.
 - 
REQUEST_BODY_FULLY_READpublic static final ActionCode REQUEST_BODY_FULLY_READ Indicates if the request body has been fully read.
 - 
DISPATCH_READpublic static final ActionCode DISPATCH_READ Indicates that the container needs to trigger a call to onDataAvailable() for the registered non-blocking read listener.
 - 
DISPATCH_WRITEpublic static final ActionCode DISPATCH_WRITE Indicates that the container needs to trigger a call to onWritePossible() for the registered non-blocking write listener.
 - 
DISPATCH_EXECUTEpublic static final ActionCode DISPATCH_EXECUTE Execute any non-blocking dispatches that have been registered viaDISPATCH_READorDISPATCH_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.
 - 
IS_PUSH_SUPPORTEDpublic static final ActionCode IS_PUSH_SUPPORTED Is server push supported and allowed for the current request?
 - 
PUSH_REQUESTpublic static final ActionCode PUSH_REQUEST Push a request on behalf of the client of the current request.
 - 
IS_TRAILER_FIELDS_READYpublic 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_SUPPORTEDpublic 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.
 - 
CONNECTION_IDpublic static final ActionCode CONNECTION_ID Obtain the connection identifier for the request. Used with multiplexing protocols such as HTTP/2.
 - 
STREAM_IDpublic static final ActionCode STREAM_ID Obtain the stream identifier for the request. Used with multiplexing protocols such as HTTP/2.
 
- 
 - 
Method Detail- 
valuespublic static ActionCode[] values() Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ActionCode c : ActionCode.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static ActionCode valueOf(java.lang.String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
- name- the name of the enum constant to be returned.
- Returns:
- the enum constant with the specified name
- Throws:
- java.lang.IllegalArgumentException- if this enum type has no constant with the specified name
- java.lang.NullPointerException- if the argument is null
 
 
- 
 
-