类 MockAsyncContext
- java.lang.Object
- org.springframework.mock.web.MockAsyncContext
- 所有已实现的接口:
AsyncContext
public class MockAsyncContext extends Object implements AsyncContext
Mock implementation of theAsyncContext
interface.- 从以下版本开始:
- 3.2
- 作者:
- Rossen Stoyanchev
字段概要
从接口继承的字段 javax.servlet.AsyncContext
ASYNC_CONTEXT_PATH, ASYNC_MAPPING, ASYNC_PATH_INFO, ASYNC_QUERY_STRING, ASYNC_REQUEST_URI, ASYNC_SERVLET_PATH
构造器概要
构造器 构造器 说明 MockAsyncContext(ServletRequest request, ServletResponse response)
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
addDispatchHandler(Runnable handler)
void
addListener(AsyncListener listener)
Registers the givenAsyncListener
with the most recent asynchronous cycle that was started by a call to one of theServletRequest.startAsync()
methods.void
addListener(AsyncListener listener, ServletRequest request, ServletResponse response)
Registers the givenAsyncListener
with the most recent asynchronous cycle that was started by a call to one of theServletRequest.startAsync()
methods.void
complete()
Completes the asynchronous operation that was started on the request that was used to initialze this AsyncContext, closing the response that was used to initialize this AsyncContext.<T extends AsyncListener>
TcreateListener(Class<T> clazz)
Instantiates the givenAsyncListener
class.void
dispatch()
Dispatches the request and response objects of this AsyncContext to the servlet container.void
dispatch(String path)
Dispatches the request and response objects of this AsyncContext to the given path.void
dispatch(ServletContext context, String path)
Dispatches the request and response objects of this AsyncContext to the given path scoped to the given context.String
getDispatchedPath()
List<AsyncListener>
getListeners()
ServletRequest
getRequest()
Gets the request that was used to initialize this AsyncContext by callingServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
.ServletResponse
getResponse()
Gets the response that was used to initialize this AsyncContext by callingServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
.long
getTimeout()
Gets the timeout (in milliseconds) for this AsyncContext.boolean
hasOriginalRequestAndResponse()
Checks if this AsyncContext was initialized with the original or application-wrapped request and response objects.void
setTimeout(long timeout)
By default this is set to 10000 (10 seconds) even though the Servlet API specifies a default async request timeout of 30 seconds.void
start(Runnable runnable)
Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable.
构造器详细资料
MockAsyncContext
public MockAsyncContext(ServletRequest request, @Nullable ServletResponse response)
方法详细资料
addDispatchHandler
public void addDispatchHandler(Runnable handler)
getRequest
public ServletRequest getRequest()
从接口复制的说明:javax.servlet.AsyncContext
Gets the request that was used to initialize this AsyncContext by callingServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
.- 指定者:
getRequest
在接口中AsyncContext
- 返回:
- the request that was used to initialize this AsyncContext
getResponse
@Nullable public ServletResponse getResponse()
从接口复制的说明:javax.servlet.AsyncContext
Gets the response that was used to initialize this AsyncContext by callingServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
.- 指定者:
getResponse
在接口中AsyncContext
- 返回:
- the response that was used to initialize this AsyncContext
hasOriginalRequestAndResponse
public boolean hasOriginalRequestAndResponse()
从接口复制的说明:javax.servlet.AsyncContext
Checks if this AsyncContext was initialized with the original or application-wrapped request and response objects.This information may be used by filters invoked in the outbound direction, after a request was put into asynchronous mode, to determine whether any request and/or response wrappers that they added during their inbound invocation need to be preserved for the duration of the asynchronous operation, or may be released.
- 指定者:
hasOriginalRequestAndResponse
在接口中AsyncContext
- 返回:
- true if this AsyncContext was initialized with the original request and response objects by calling
ServletRequest.startAsync()
, or if it was initialized by callingServletRequest.startAsync(ServletRequest, ServletResponse)
, and neither the ServletRequest nor ServletResponse arguments carried any application-provided wrappers; false otherwise
dispatch
public void dispatch()
从接口复制的说明:javax.servlet.AsyncContext
Dispatches the request and response objects of this AsyncContext to the servlet container.If the asynchronous cycle was started with
ServletRequest.startAsync(ServletRequest, ServletResponse)
, and the request passed is an instance of HttpServletRequest, then the dispatch is to the URI returned byHttpServletRequest.getRequestURI()
. Otherwise, the dispatch is to the URI of the request when it was last dispatched by the container.The following sequence illustrates how this will work:
// REQUEST dispatch to /url/A AsyncContext ac = request.startAsync(); ... ac.dispatch(); // ASYNC dispatch to /url/A // REQUEST to /url/A // FORWARD dispatch to /url/B request.getRequestDispatcher("/url/B").forward(request,response); // Start async operation from within the target of the FORWARD // dispatch ac = request.startAsync(); ... ac.dispatch(); // ASYNC dispatch to /url/A // REQUEST to /url/A // FORWARD dispatch to /url/B request.getRequestDispatcher("/url/B").forward(request,response); // Start async operation from within the target of the FORWARD // dispatch ac = request.startAsync(request,response); ... ac.dispatch(); // ASYNC dispatch to /url/B
This method returns immediately after passing the request and response objects to a container managed thread, on which the dispatch operation will be performed. If this method is called before the container-initiated dispatch that called startAsync has returned to the container, the dispatch operation will be delayed until after the container-initiated dispatch has returned to the container.
The dispatcher type of the request is set to DispatcherType.ASYNC. Unlike
forward dispatches
, the response buffer and headers will not be reset, and it is legal to dispatch even if the response has already been committed.Control over the request and response is delegated to the dispatch target, and the response will be closed when the dispatch target has completed execution, unless
ServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
are called.Any errors or exceptions that may occur during the execution of this method must be caught and handled by the container, as follows:
- Invoke, at their
onError
method, allAsyncListener
instances registered with the ServletRequest for which this AsyncContext was created, and make the caught Throwable available viaAsyncEvent.getThrowable()
. - If none of the listeners called
AsyncContext.complete()
or any of theAsyncContext.dispatch()
methods, perform an error dispatch with a status code equal to HttpServletResponse.SC_INTERNAL_SERVER_ERROR, and make the above Throwable available as the value of the RequestDispatcher.ERROR_EXCEPTION request attribute. - If no matching error page was found, or the error page did not call
AsyncContext.complete()
or any of theAsyncContext.dispatch()
methods, callAsyncContext.complete()
.
There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the
ServletRequest.startAsync()
methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. If startAsync is subsequently called on the dispatched request, then any of the dispatch orAsyncContext.complete()
methods may be called.- 指定者:
dispatch
在接口中AsyncContext
- 另请参阅:
ServletRequest.getDispatcherType()
- Invoke, at their
dispatch
public void dispatch(String path)
从接口复制的说明:javax.servlet.AsyncContext
Dispatches the request and response objects of this AsyncContext to the given path.The path parameter is interpreted in the same way as in
ServletRequest.getRequestDispatcher(String)
, within the scope of theServletContext
from which this AsyncContext was initialized.All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the
AsyncContext.ASYNC_REQUEST_URI
,AsyncContext.ASYNC_CONTEXT_PATH
,AsyncContext.ASYNC_PATH_INFO
,AsyncContext.ASYNC_SERVLET_PATH
, andAsyncContext.ASYNC_QUERY_STRING
attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches.There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the
ServletRequest.startAsync()
methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. If startAsync is subsequently called on the dispatched request, then any of the dispatch orAsyncContext.complete()
methods may be called.See
AsyncContext.dispatch()
for additional details, including error handling.- 指定者:
dispatch
在接口中AsyncContext
- 参数:
path
- the path of the dispatch target, scoped to the ServletContext from which this AsyncContext was initialized- 另请参阅:
ServletRequest.getDispatcherType()
dispatch
public void dispatch(@Nullable ServletContext context, String path)
从接口复制的说明:javax.servlet.AsyncContext
Dispatches the request and response objects of this AsyncContext to the given path scoped to the given context.The path parameter is interpreted in the same way as in
ServletRequest.getRequestDispatcher(String)
, except that it is scoped to the given context.All path related query methods of the request must reflect the dispatch target, while the original request URI, context path, path info, servlet path, and query string may be recovered from the
AsyncContext.ASYNC_REQUEST_URI
,AsyncContext.ASYNC_CONTEXT_PATH
,AsyncContext.ASYNC_PATH_INFO
,AsyncContext.ASYNC_SERVLET_PATH
, andAsyncContext.ASYNC_QUERY_STRING
attributes of the request. These attributes will always reflect the original path elements, even under repeated dispatches.There can be at most one asynchronous dispatch operation per asynchronous cycle, which is started by a call to one of the
ServletRequest.startAsync()
methods. Any attempt to perform an additional asynchronous dispatch operation within the same asynchronous cycle will result in an IllegalStateException. If startAsync is subsequently called on the dispatched request, then any of the dispatch orAsyncContext.complete()
methods may be called.See
AsyncContext.dispatch()
for additional details, including error handling.- 指定者:
dispatch
在接口中AsyncContext
- 参数:
context
- the ServletContext of the dispatch targetpath
- the path of the dispatch target, scoped to the given ServletContext- 另请参阅:
ServletRequest.getDispatcherType()
getDispatchedPath
@Nullable public String getDispatchedPath()
complete
public void complete()
从接口复制的说明:javax.servlet.AsyncContext
Completes the asynchronous operation that was started on the request that was used to initialze this AsyncContext, closing the response that was used to initialize this AsyncContext.Any listeners of type
AsyncListener
that were registered with the ServletRequest for which this AsyncContext was created will be invoked at theironComplete
method.It is legal to call this method any time after a call to
ServletRequest.startAsync()
orServletRequest.startAsync(ServletRequest, ServletResponse)
, and before a call to one of the dispatch methods of this class. If this method is called before the container-initiated dispatch that called startAsync has returned to the container, then the call will not take effect (and any invocations ofAsyncListener.onComplete(AsyncEvent)
will be delayed) until after the container-initiated dispatch has returned to the container.- 指定者:
complete
在接口中AsyncContext
start
public void start(Runnable runnable)
从接口复制的说明:javax.servlet.AsyncContext
Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable. The container may propagate appropriate contextual information to the Runnable.- 指定者:
start
在接口中AsyncContext
- 参数:
runnable
- the asynchronous handler
addListener
public void addListener(AsyncListener listener)
从接口复制的说明:javax.servlet.AsyncContext
Registers the givenAsyncListener
with the most recent asynchronous cycle that was started by a call to one of theServletRequest.startAsync()
methods.The given AsyncListener will receive an
AsyncEvent
when the asynchronous cycle completes successfully, times out, results in an error, or a new asynchronous cycle is being initiated via one of theServletRequest.startAsync()
methods.AsyncListener instances will be notified in the order in which they were added.
If
ServletRequest.startAsync(ServletRequest, ServletResponse)
orServletRequest.startAsync()
is called, the exact same request and response objects are available from theAsyncEvent
when theAsyncListener
is notified.- 指定者:
addListener
在接口中AsyncContext
- 参数:
listener
- the AsyncListener to be registered
addListener
public void addListener(AsyncListener listener, ServletRequest request, ServletResponse response)
从接口复制的说明:javax.servlet.AsyncContext
Registers the givenAsyncListener
with the most recent asynchronous cycle that was started by a call to one of theServletRequest.startAsync()
methods.The given AsyncListener will receive an
AsyncEvent
when the asynchronous cycle completes successfully, times out, results in an error, or a new asynchronous cycle is being initiated via one of theServletRequest.startAsync()
methods.AsyncListener instances will be notified in the order in which they were added.
The given ServletRequest and ServletResponse objects will be made available to the given AsyncListener via the
getSuppliedRequest
andgetSuppliedResponse
methods, respectively, of theAsyncEvent
delivered to it. These objects should not be read from or written to, respectively, at the time the AsyncEvent is delivered, because additional wrapping may have occurred since the given AsyncListener was registered, but may be used in order to release any resources associated with them.- 指定者:
addListener
在接口中AsyncContext
- 参数:
listener
- the AsyncListener to be registeredrequest
- the ServletRequest that will be included in the AsyncEventresponse
- the ServletResponse that will be included in the AsyncEvent
getListeners
public List<AsyncListener> getListeners()
createListener
public <T extends AsyncListener> T createListener(Class<T> clazz) throws ServletException
从接口复制的说明:javax.servlet.AsyncContext
Instantiates the givenAsyncListener
class.The returned AsyncListener instance may be further customized before it is registered with this AsyncContext via a call to one of the
addListener
methods.The given AsyncListener class must define a zero argument constructor, which is used to instantiate it.
This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
This method supports any annotations applicable to AsyncListener.
- 指定者:
createListener
在接口中AsyncContext
- 类型参数:
T
- the class of the object to instantiate- 参数:
clazz
- the AsyncListener class to instantiate- 返回:
- the new AsyncListener instance
- 抛出:
ServletException
- if the given clazz fails to be instantiated
setTimeout
public void setTimeout(long timeout)
By default this is set to 10000 (10 seconds) even though the Servlet API specifies a default async request timeout of 30 seconds. Keep in mind the timeout could further be impacted by global configuration through the MVC Java config or the XML namespace, as well as be overridden per request onDeferredResult
or onSseEmitter
.- 指定者:
setTimeout
在接口中AsyncContext
- 参数:
timeout
- the timeout value to use.- 另请参阅:
AsyncContext.setTimeout(long)
getTimeout
public long getTimeout()
从接口复制的说明:javax.servlet.AsyncContext
Gets the timeout (in milliseconds) for this AsyncContext.This method returns the container's default timeout for asynchronous operations, or the timeout value passed to the most recent invocation of
AsyncContext.setTimeout(long)
.A timeout value of zero or less indicates no timeout.
- 指定者:
getTimeout
在接口中AsyncContext
- 返回:
- the timeout in milliseconds