java.lang.Object
- org.springframework.test.context.support.AbstractTestExecutionListener
- - org.springframework.test.context.web.ServletTestExecutionListener

All Implemented Interfaces:
Ordered, TestExecutionListener
```
public class ServletTestExecutionListener
extends AbstractTestExecutionListener
```
TestExecutionListener which provides mock Servlet API support to WebApplicationContexts loaded by the Spring TestContext Framework.
Specifically, ServletTestExecutionListener sets up thread-local state via Spring Web's RequestContextHolder during test instance preparation and before each test method and creates a MockHttpServletRequest, MockHttpServletResponse, and ServletWebRequest based on the MockServletContext present in the WebApplicationContext. This listener also ensures that the MockHttpServletResponse and ServletWebRequest can be injected into the test instance, and once the test is complete this listener cleans up thread-local state.
Note that ServletTestExecutionListener is enabled by default but generally takes no action if the test class is not annotated with @WebAppConfiguration. See the javadocs for individual methods in this class for details.
Since:
3.2
Author:
Sam Brannen, Phillip Webb

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ACTIVATE_LISTENER`	Attribute name for a `TestContext` attribute which indicates that the `ServletTestExecutionListener` should be activated.
`static String`	`CREATED_BY_THE_TESTCONTEXT_FRAMEWORK`	Attribute name for a request attribute which indicates that the `MockHttpServletRequest` stored in the `RequestAttributes` in Spring Web's `RequestContextHolder` was created by the TestContext framework.
`static String`	`POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE`	Attribute name for a `TestContext` attribute which indicates that `ServletTestExecutionListener` has already populated Spring Web's `RequestContextHolder`.
`static String`	`RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE`	Attribute name for a `TestContext` attribute which indicates whether or not the `ServletTestExecutionListener` should reset Spring Web's `RequestContextHolder` in `afterTestMethod(TestContext)`.

Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary
Constructors
Constructor Description
ServletTestExecutionListener()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`afterTestMethod(TestContext testContext)`	If the `RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE` in the supplied `TestContext` has a value of `Boolean.TRUE`, this method will (1) clean up thread-local state after each test method by resetting Spring Web's `RequestContextHolder` and (2) ensure that new mocks are injected into the test instance for subsequent tests by setting the `DependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE` in the test context to `true`.
`void`	`beforeTestMethod(TestContext testContext)`	Sets up thread-local state before each test method via Spring Web's `RequestContextHolder`, but only if the test class is annotated with `@WebAppConfiguration`.
`int`	`getOrder()`	Returns `1000`.
`void`	`prepareTestInstance(TestContext testContext)`	Sets up thread-local state during the test instance preparation callback phase via Spring Web's `RequestContextHolder`, but only if the test class is annotated with `@WebAppConfiguration`.

Methods inherited from class org.springframework.test.context.support.AbstractTestExecutionListener
afterTestClass, beforeTestClass

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
```
public static final String RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
```
    Attribute name for a TestContext attribute which indicates whether or not the ServletTestExecutionListener should reset Spring Web's RequestContextHolder in afterTestMethod(TestContext).
    Permissible values include Boolean.TRUE and Boolean.FALSE.
  - POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
```
public static final String POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE
```
    Attribute name for a TestContext attribute which indicates that ServletTestExecutionListener has already populated Spring Web's RequestContextHolder.
    Permissible values include Boolean.TRUE and Boolean.FALSE.
  - CREATED_BY_THE_TESTCONTEXT_FRAMEWORK
```
public static final String CREATED_BY_THE_TESTCONTEXT_FRAMEWORK
```
    Attribute name for a request attribute which indicates that the MockHttpServletRequest stored in the RequestAttributes in Spring Web's RequestContextHolder was created by the TestContext framework.
    Permissible values include Boolean.TRUE and Boolean.FALSE.
    Since:
    4.2
  - ACTIVATE_LISTENER
```
public static final String ACTIVATE_LISTENER
```
    Attribute name for a TestContext attribute which indicates that the ServletTestExecutionListener should be activated. When not set to true, activation occurs when the test class is annotated with @WebAppConfiguration.
    Permissible values include Boolean.TRUE and Boolean.FALSE.
    Since:
    4.3
- Constructor Detail
  - ServletTestExecutionListener
```
public ServletTestExecutionListener()
```
- Method Detail
  - getOrder
```
public final int getOrder()
```
    Returns 1000.
    Specified by:
    getOrder in interface Ordered
    Overrides:
    getOrder in class AbstractTestExecutionListener
    Returns:
    the order value
    See Also:
    Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE
  - prepareTestInstance
```
public void prepareTestInstance(TestContext testContext)
                         throws Exception
```
    Sets up thread-local state during the test instance preparation callback phase via Spring Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.
    Specified by:
    prepareTestInstance in interface TestExecutionListener
    Overrides:
    prepareTestInstance in class AbstractTestExecutionListener
    Parameters:
    testContext - the test context for the test; never null
    Throws:
    Exception - allows any exception to propagate
    See Also:
    TestExecutionListener.prepareTestInstance(TestContext), setUpRequestContextIfNecessary(TestContext)
  - beforeTestMethod
```
public void beforeTestMethod(TestContext testContext)
                      throws Exception
```
    Sets up thread-local state before each test method via Spring Web's RequestContextHolder, but only if the test class is annotated with @WebAppConfiguration.
    Specified by:
    beforeTestMethod in interface TestExecutionListener
    Overrides:
    beforeTestMethod in class AbstractTestExecutionListener
    Parameters:
    testContext - the test context in which the test method will be executed; never null
    Throws:
    Exception - allows any exception to propagate
    See Also:
    TestExecutionListener.beforeTestMethod(TestContext), setUpRequestContextIfNecessary(TestContext)
  - afterTestMethod
```
public void afterTestMethod(TestContext testContext)
                     throws Exception
```
    If the RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE in the supplied TestContext has a value of Boolean.TRUE, this method will (1) clean up thread-local state after each test method by resetting Spring Web's RequestContextHolder and (2) ensure that new mocks are injected into the test instance for subsequent tests by setting the DependencyInjectionTestExecutionListener.REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true.
    The RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE and POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE will be subsequently removed from the test context, regardless of their values.
    Specified by:
    afterTestMethod in interface TestExecutionListener
    Overrides:
    afterTestMethod in class AbstractTestExecutionListener
    Parameters:
    testContext - the test context in which the test method was executed; never null
    Throws:
    Exception - allows any exception to propagate
    See Also:
    TestExecutionListener.afterTestMethod(TestContext)

Class ServletTestExecutionListener

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.springframework.test.context.support.AbstractTestExecutionListener

Methods inherited from class java.lang.Object

Field Detail

RESET_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

POPULATED_REQUEST_CONTEXT_HOLDER_ATTRIBUTE

CREATED_BY_THE_TESTCONTEXT_FRAMEWORK

ACTIVATE_LISTENER

Constructor Detail

ServletTestExecutionListener

Method Detail

getOrder

prepareTestInstance

beforeTestMethod

afterTestMethod