Class FauxContinuation
- All Implemented Interfaces:
Continuation
,ContinuationFilter.FilteredContinuation
ContinuationFilter
when there are is no native or asynchronous continuation type available.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
Deprecated.private static final int
Deprecated.private static final ContinuationThrowable
Deprecated.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.private boolean
Deprecated.private ArrayList<ContinuationListener>
Deprecated.private final javax.servlet.ServletRequest
Deprecated.private javax.servlet.ServletResponse
Deprecated.private boolean
Deprecated.private boolean
Deprecated.private int
Deprecated.private boolean
Deprecated.private long
Deprecated.Fields inherited from interface org.eclipse.jetty.continuation.Continuation
ATTRIBUTE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addContinuationListener
(ContinuationListener listener) Deprecated.Add a ContinuationListener.void
complete()
Deprecated.Complete a suspended request.boolean
enter
(javax.servlet.ServletResponse response) Deprecated.boolean
exit()
Deprecated.protected void
expire()
Deprecated.private void
Deprecated.private void
Deprecated.getAttribute
(String name) Deprecated.Get a request attribute.javax.servlet.ServletResponse
Deprecated.Get the suspended response.(package private) String
Deprecated.(package private) void
handling()
Deprecated.boolean
Deprecated.boolean
Deprecated.boolean
Deprecated.Is the suspended response wrapped.boolean
Deprecated.boolean
Deprecated.void
Deprecated.void
Deprecated.void
removeAttribute
(String name) Deprecated.Remove a request attribute.void
resume()
Deprecated.Resume a suspended request.void
setAttribute
(String name, Object attribute) Deprecated.Set a request attribute.void
setTimeout
(long timeoutMs) Deprecated.Set the continuation timeout.void
suspend()
Deprecated.Suspend the processing of the request and associatedServletResponse
.void
suspend
(javax.servlet.ServletResponse response) Deprecated.Suspend the processing of the request and associatedServletResponse
.toString()
Deprecated.void
Deprecated.Undispatch the request.
-
Field Details
-
__exception
Deprecated. -
__HANDLING
private static final int __HANDLINGDeprecated.- See Also:
-
__SUSPENDING
private static final int __SUSPENDINGDeprecated.- See Also:
-
__RESUMING
private static final int __RESUMINGDeprecated.- See Also:
-
__COMPLETING
private static final int __COMPLETINGDeprecated.- See Also:
-
__SUSPENDED
private static final int __SUSPENDEDDeprecated.- See Also:
-
__UNSUSPENDING
private static final int __UNSUSPENDINGDeprecated.- See Also:
-
__COMPLETE
private static final int __COMPLETEDeprecated.- See Also:
-
_request
private final javax.servlet.ServletRequest _requestDeprecated. -
_response
private javax.servlet.ServletResponse _responseDeprecated. -
_state
private int _stateDeprecated. -
_initial
private boolean _initialDeprecated. -
_resumed
private boolean _resumedDeprecated. -
_timeout
private boolean _timeoutDeprecated. -
_responseWrapped
private boolean _responseWrappedDeprecated. -
_timeoutMs
private long _timeoutMsDeprecated. -
_listeners
Deprecated.
-
-
Constructor Details
-
FauxContinuation
FauxContinuation(javax.servlet.ServletRequest request) Deprecated.
-
-
Method Details
-
onComplete
public void onComplete()Deprecated. -
onTimeout
public void onTimeout()Deprecated. -
isResponseWrapped
public boolean isResponseWrapped()Deprecated.Description copied from interface:Continuation
Is the suspended response wrapped.Filters that wrap the response object should check this method to determine if they should destroy/finish the wrapped response. If the request was suspended with a call to
Continuation.suspend(ServletResponse)
that passed the wrapped response, then the filter should register aContinuationListener
to destroy/finish the wrapped response during a call toContinuationListener.onComplete(Continuation)
.- Specified by:
isResponseWrapped
in interfaceContinuation
- Returns:
- True if
Continuation.suspend(ServletResponse)
has been passed aServletResponseWrapper
instance. - See Also:
-
isInitial
public boolean isInitial()Deprecated.- Specified by:
isInitial
in interfaceContinuation
- Returns:
- true while the request is within the initial dispatch to the filter chain and/or servlet. Will return false once the calling thread has returned to the container after suspend has been called and during any subsequent redispatch.
-
isResumed
public boolean isResumed()Deprecated.- Specified by:
isResumed
in interfaceContinuation
- Returns:
- true if the request has been redispatched by a call to
Continuation.resume()
. Returns false after any subsequent call to suspend
-
isSuspended
public boolean isSuspended()Deprecated.- Specified by:
isSuspended
in interfaceContinuation
- Returns:
- true after
Continuation.suspend()
has been called and before the request has been redispatched due to being resumed, completed or timed out.
-
isExpired
public boolean isExpired()Deprecated.- Specified by:
isExpired
in interfaceContinuation
- Returns:
- true after a request has been redispatched as the result of a timeout. Returns false after any subsequent call to suspend.
-
setTimeout
public void setTimeout(long timeoutMs) Deprecated.Description copied from interface:Continuation
Set the continuation timeout.- Specified by:
setTimeout
in interfaceContinuation
- Parameters:
timeoutMs
- The time in milliseconds to wait before expiring this continuation after a call toContinuation.suspend()
orContinuation.suspend(ServletResponse)
. A timeout of <=0 means the continuation will never expire.
-
suspend
public void suspend(javax.servlet.ServletResponse response) Deprecated.Description copied from interface:Continuation
Suspend the processing of the request and associatedServletResponse
.After this method has been called, the lifecycle of the request will be extended beyond the return to the container from the
Servlet.service(ServletRequest, ServletResponse)
method andFilter.doFilter(ServletRequest, ServletResponse, FilterChain)
calls. When a suspended request is returned to the container after a dispatch, then the container will not commit the associated response (unless an exception other thanContinuationThrowable
is thrown).When the thread calling the filter chain and/or servlet has returned to the container with a suspended request, the thread is freed for other tasks and the request is held until either:
- a call to
Continuation.resume()
. - a call to
Continuation.complete()
. - the timeout expires.
Typically suspend with a response argument is uses when a call to
Continuation.complete()
is expected. If a call toContinuation.resume()
is expected, then theContinuation.suspend()
method should be used instead of this method.Filters that may wrap the response object should check
Continuation.isResponseWrapped()
to decide if they should destroy/finish the wrapper. IfContinuation.isResponseWrapped()
returns true, then the wrapped request has been passed to the asynchronous handler and the wrapper should not be destroyed/finished until after a call toContinuation.complete()
(potentially using aContinuationListener.onComplete(Continuation)
listener).- Specified by:
suspend
in interfaceContinuation
- Parameters:
response
- The response to return via a call toContinuation.getServletResponse()
- a call to
-
suspend
public void suspend()Deprecated.Description copied from interface:Continuation
Suspend the processing of the request and associatedServletResponse
.After this method has been called, the lifecycle of the request will be extended beyond the return to the container from the
Servlet.service(ServletRequest, ServletResponse)
method andFilter.doFilter(ServletRequest, ServletResponse, FilterChain)
calls. When a suspended request is returned to the container after a dispatch, then the container will not commit the associated response (unless an exception other thanContinuationThrowable
is thrown).When the thread calling the filter chain and/or servlet has returned to the container with a suspended request, the thread is freed for other tasks and the request is held until either:
- a call to
Continuation.resume()
. - a call to
Continuation.complete()
. - the timeout expires.
Typically suspend with no arguments is uses when a call to
Continuation.resume()
is expected. If a call toContinuation.complete()
is expected, then theContinuation.suspend(ServletResponse)
method should be used instead of this method.- Specified by:
suspend
in interfaceContinuation
- a call to
-
resume
public void resume()Deprecated.Description copied from interface:Continuation
Resume a suspended request.This method can be called by any thread that has been passed a reference to a continuation. When called the request is redispatched to the normal filter chain and servlet processing with
Continuation.isInitial()
false.If resume is called before a suspended request is returned to the container (ie the thread that called
Continuation.suspend()
is still within the filter chain and/or servlet service method), then the resume does not take effect until the call to the filter chain and/or servlet returns to the container. In this case bothContinuation.isSuspended()
andContinuation.isResumed()
return true. Multiple calls to resume are ignored.Typically resume() is used after a call to
Continuation.suspend()
with no arguments. The dispatch after a resume call will use the original request and response objects, even ifContinuation.suspend(ServletResponse)
had been passed a wrapped response.- Specified by:
resume
in interfaceContinuation
- See Also:
-
complete
public void complete()Deprecated.Description copied from interface:Continuation
Complete a suspended request.This method can be called by any thread that has been passed a reference to a suspended request. When a request is completed, the associated response object committed and flushed. The request is not redispatched.
If complete is called before a suspended request is returned to the container (ie the thread that called
Continuation.suspend()
is still within the filter chain and/or servlet service method), then the complete does not take effect until the call to the filter chain and/or servlet returns to the container. In this case bothContinuation.isSuspended()
andContinuation.isResumed()
return true.Typically resume() is used after a call to
Continuation.suspend(ServletResponse)
with a possibly wrapped response. The async handler should use the response provided byContinuation.getServletResponse()
to write the response before callingContinuation.complete()
. If the request was suspended with a call toContinuation.suspend()
then no response object will be available viaContinuation.getServletResponse()
.Once complete has been called and any thread calling the filter chain and/or servlet chain has returned to the container, the request lifecycle is complete. The container is able to recycle request objects, so it is not valid hold a request or continuation reference after the end of the life cycle.
- Specified by:
complete
in interfaceContinuation
- See Also:
-
enter
public boolean enter(javax.servlet.ServletResponse response) Deprecated.- Specified by:
enter
in interfaceContinuationFilter.FilteredContinuation
- See Also:
-
getServletResponse
public javax.servlet.ServletResponse getServletResponse()Deprecated.Description copied from interface:Continuation
Get the suspended response.- Specified by:
getServletResponse
in interfaceContinuation
- Returns:
- the
ServletResponse
passed toContinuation.suspend(ServletResponse)
. - See Also:
-
handling
void handling()Deprecated. -
exit
public boolean exit()Deprecated.- Specified by:
exit
in interfaceContinuationFilter.FilteredContinuation
- Returns:
- true if handling is complete
-
expire
protected void expire()Deprecated. -
fauxSuspend
private void fauxSuspend()Deprecated. -
fauxResume
private void fauxResume()Deprecated. -
toString
Deprecated. -
getStatusString
String getStatusString()Deprecated. -
addContinuationListener
Deprecated.Description copied from interface:Continuation
Add a ContinuationListener.- Specified by:
addContinuationListener
in interfaceContinuation
- Parameters:
listener
- the listener
-
getAttribute
Deprecated.Description copied from interface:Continuation
Get a request attribute. This method is a convenience method to call theServletRequest.getAttribute(String)
method on the associated request object. This is a thread safe call and may be called by any thread.- Specified by:
getAttribute
in interfaceContinuation
- Parameters:
name
- the attribute name- Returns:
- the attribute value
- See Also:
-
removeAttribute
Deprecated.Description copied from interface:Continuation
Remove a request attribute. This method is a convenience method to call theServletRequest.removeAttribute(String)
method on the associated request object. This is a thread safe call and may be called by any thread.- Specified by:
removeAttribute
in interfaceContinuation
- Parameters:
name
- the attribute name- See Also:
-
setAttribute
Deprecated.Description copied from interface:Continuation
Set a request attribute. This method is a convenience method to call theServletRequest.setAttribute(String, Object)
method on the associated request object. This is a thread safe call and may be called by any thread.- Specified by:
setAttribute
in interfaceContinuation
- Parameters:
name
- the attribute nameattribute
- the attribute value- See Also:
-
undispatch
public void undispatch()Deprecated.Description copied from interface:Continuation
Undispatch the request.This method can be called on a suspended continuation in order to exit the dispatch to the filter/servlet by throwing a
This method should only be used as a last resort and a normal return is a prefereable solution if filters can be updated to handle that case.ContinuationThrowable
which is caught either by the container or theContinuationFilter
. This is an alternative to simply returning from the dispatch in the case where filters in the filter chain may not be prepared to handle a suspended request.- Specified by:
undispatch
in interfaceContinuation
- See Also:
-
AsyncContext
instead