Package org.apache.coyote
Enum ActionCode
- All Implemented Interfaces:
- Serializable,- Comparable<ActionCode>,- java.lang.constant.Constable
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:
- 
Nested Class SummaryNested classes/interfaces inherited from class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
- 
Enum Constant SummaryEnum ConstantsEnum ConstantDescriptionCallback for an async call toAsyncContext.complete().Callback for an async call toAsyncContext.dispatch().Callback to indicate the the actual dispatch has started and that the async state needs change.Callback to trigger the error processing.Callback to determine if async processing is in progress.Call back to determine if async complete is in progress.Callback to determine if async dispatch is in progress.Callback to determine if async is in error.Callback to determine if async dispatch is in progress.Callback to determine if async is timing out.Callback to trigger post processing.Callback for an async call toAsyncContext.start(Runnable).Callback for an async call toAsyncContext.setTimeout(long)Callback for an async request.Callback to trigger the processing of an async timeout.Callback for getting the amount of available bytes.A flush() operation originated by the client ( i.e. a flush() on the servlet output stream or writer, called by a servlet ).A serious error occurred from which it is not possible to recover safely.Hook called if swallowing request input should be disabled.Execute any non-blocking dispatches that have been registered viaDISPATCH_READorDISPATCH_WRITE.Indicates that the container needs to trigger a call to onDataAvailable() for the registered non-blocking read listener.Indicates that the container needs to trigger a call to onWritePossible() for the registered non-blocking write listener.Has the processor been placed into the error state?The processor may have been placed into an error state and some error states do not permit any further I/O.Is server push supported and allowed for the current request?Are the request trailer fields ready to be read?Are HTTP trailer fields supported for the current response?Indicator that Servlet is interested in being notified when data is available to be read.Used with non-blocking writes to determine if a write is currently allowed (sets passed parameter totrue) or not (sets passed parameter tofalse).Obtain the request identifier for this request as defined by the protocol in use.Push a request on behalf of the client of the current request.Callback for lazy evaluation - extract the remote host address.Callback for lazy evaluation - extract the remote host name and address.Callback for lazy evaluation - local address.Callback for lazy evaluation - local address.Callback for lazy evaluation - socket local port.Callback for lazy evaluation - extract the connection peer address.Callback for lazy evaluation - socket remote port.Callback for setting FORM auth body replayCallback for lazy evaluation - extract the SSL-related attributes including the client certificate if present.Force a TLS re-handshake and make the resulting client certificate (if any) available as a request attribute.Indicates if the request body has been fully read.Obtain the servlet connection instance for the network connection supporting the current request.Callback to trigger the HTTP upgrade process.
- 
Method SummaryModifier and TypeMethodDescriptionstatic ActionCodeReturns 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 Details- 
ACK
- 
CLOSE
- 
COMMIT
- 
CLOSE_NOWA 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_FLUSHA 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_ERRORHas the processor been placed into the error state? Note that the response may not have an appropriate error code set.
- 
IS_IO_ALLOWEDThe 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_INPUTHook called if swallowing request input should be disabled. Example: Cancel a large file upload.
- 
REQ_HOST_ATTRIBUTECallback for lazy evaluation - extract the remote host name and address.
- 
REQ_HOST_ADDR_ATTRIBUTECallback for lazy evaluation - extract the remote host address.
- 
REQ_PEER_ADDR_ATTRIBUTECallback for lazy evaluation - extract the connection peer address.
- 
REQ_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.
- 
REQ_REMOTEPORT_ATTRIBUTECallback for lazy evaluation - socket remote port.
- 
REQ_LOCALPORT_ATTRIBUTECallback for lazy evaluation - socket local port.
- 
REQ_LOCAL_ADDR_ATTRIBUTECallback for lazy evaluation - local address.
- 
REQ_LOCAL_NAME_ATTRIBUTECallback for lazy evaluation - local address.
- 
REQ_SET_BODY_REPLAYCallback for setting FORM auth body replay
- 
AVAILABLECallback for getting the amount of available bytes.
- 
ASYNC_STARTCallback for an async request.
- 
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_RUNCallback for an async call toAsyncContext.start(Runnable).
- 
ASYNC_COMPLETECallback for an async call toAsyncContext.complete().
- 
ASYNC_TIMEOUTCallback to trigger the processing of an async timeout.
- 
ASYNC_ERRORCallback to trigger the error processing.
- 
ASYNC_SETTIMEOUTCallback for an async call toAsyncContext.setTimeout(long)
- 
ASYNC_IS_ASYNCCallback to determine if async processing is in progress.
- 
ASYNC_IS_STARTEDCallback to determine if async dispatch 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_TIMINGOUTCallback to determine if async is timing out.
- 
ASYNC_IS_ERRORCallback to determine if async is in error.
- 
ASYNC_POST_PROCESSCallback to trigger post processing. Typically only used during error handling to trigger essential processing that otherwise would be skipped.
- 
UPGRADECallback to trigger the HTTP upgrade process.
- 
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). If a write is not allowed then callback will be triggered at some future point when write becomes possible again.
- 
REQUEST_BODY_FULLY_READIndicates if the request body has been fully read.
- 
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.
- 
DISPATCH_EXECUTEExecute 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_SUPPORTEDIs server push supported and allowed for the current request?
- 
PUSH_REQUESTPush a request on behalf of the client of the current request.
- 
IS_TRAILER_FIELDS_READYAre 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_SUPPORTEDAre 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.
- 
PROTOCOL_REQUEST_IDObtain 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.
- 
SERVLET_CONNECTIONObtain the servlet connection instance for the network connection supporting the current request.
 
- 
- 
Method Details- 
valuesReturns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
 
- 
valueOfReturns 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:
- IllegalArgumentException- if this enum type has no constant with the specified name
- NullPointerException- if the argument is null
 
 
-