Class MockAsyncContext

java.lang.Object

org.springframework.mock.web.MockAsyncContext

All Implemented Interfaces:

jakarta.servlet.AsyncContext

public class MockAsyncContext
extends Object
implements jakarta.servlet.AsyncContext

Mock implementation of the AsyncContext interface.

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from interface jakarta.servlet.AsyncContext

ASYNC_CONTEXT_PATH, ASYNC_MAPPING, ASYNC_PATH_INFO, ASYNC_QUERY_STRING, ASYNC_REQUEST_URI, ASYNC_SERVLET_PATH

Constructor Summary

Constructors

Constructor	Description
MockAsyncContext(jakarta.servlet.ServletRequest request, @Nullable jakarta.servlet.ServletResponse response)

Method Summary

Modifier and Type	Method	Description
void	addDispatchHandler(Runnable handler)
void	addListener(jakarta.servlet.AsyncListener listener)
void	addListener(jakarta.servlet.AsyncListener listener, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
void	complete()
<T extends jakarta.servlet.AsyncListener> T	createListener(Class<T> clazz)
void	dispatch()
void	dispatch(@Nullable jakarta.servlet.ServletContext context, String path)
void	dispatch(String path)
@Nullable String	getDispatchedPath()
List<jakarta.servlet.AsyncListener>	getListeners()
jakarta.servlet.ServletRequest	getRequest()
@Nullable jakarta.servlet.ServletResponse	getResponse()
long	getTimeout()
boolean	hasOriginalRequestAndResponse()
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MockAsyncContext

public MockAsyncContext(jakarta.servlet.ServletRequest request,
 @Nullable jakarta.servlet.ServletResponse response)

Method Details

addDispatchHandler

public void addDispatchHandler(Runnable handler)

getRequest

public jakarta.servlet.ServletRequest getRequest()

Specified by:

getRequest in interface jakarta.servlet.AsyncContext

getResponse

public @Nullable jakarta.servlet.ServletResponse getResponse()

Specified by:

getResponse in interface jakarta.servlet.AsyncContext

hasOriginalRequestAndResponse

public boolean hasOriginalRequestAndResponse()

Specified by:

hasOriginalRequestAndResponse in interface jakarta.servlet.AsyncContext

dispatch

public void dispatch()

Specified by:

dispatch in interface jakarta.servlet.AsyncContext

dispatch

public void dispatch(String path)

Specified by:

dispatch in interface jakarta.servlet.AsyncContext

dispatch

public void dispatch(@Nullable jakarta.servlet.ServletContext context,
 String path)

Specified by:

dispatch in interface jakarta.servlet.AsyncContext

getDispatchedPath

public @Nullable String getDispatchedPath()

complete

public void complete()

Specified by:

complete in interface jakarta.servlet.AsyncContext

start

public void start(Runnable runnable)

Specified by:

start in interface jakarta.servlet.AsyncContext

addListener

public void addListener(jakarta.servlet.AsyncListener listener)

Specified by:

addListener in interface jakarta.servlet.AsyncContext

addListener

public void addListener(jakarta.servlet.AsyncListener listener,
 jakarta.servlet.ServletRequest request,
 jakarta.servlet.ServletResponse response)

Specified by:

addListener in interface jakarta.servlet.AsyncContext

getListeners

public List<jakarta.servlet.AsyncListener> getListeners()

createListener

public <T extends jakarta.servlet.AsyncListener> T createListener(Class<T> clazz)
                                                           throws jakarta.servlet.ServletException

Specified by:

createListener in interface jakarta.servlet.AsyncContext

Throws:

jakarta.servlet.ServletException

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 on DeferredResult or on SseEmitter.

Specified by:

setTimeout in interface jakarta.servlet.AsyncContext

Parameters:

timeout - the timeout value to use.

See Also:

• AsyncContext.setTimeout(long)

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface jakarta.servlet.AsyncContext