org.springframework.security.test.context.support

Class WithSecurityContextTestExecutionListener

java.lang.Object

org.springframework.test.context.support.AbstractTestExecutionListener

org.springframework.security.test.context.support.WithSecurityContextTestExecutionListener

All Implemented Interfaces:

Ordered, TestExecutionListener

public class WithSecurityContextTestExecutionListener
extends AbstractTestExecutionListener

A TestExecutionListener that will find annotations that are annotated with WithSecurityContext on a test method or at the class level. If found, the WithSecurityContext.factory() is used to create a SecurityContext that will be used with this test. If using with MockMvc the SecurityMockMvcRequestPostProcessors.testSecurityContext() needs to be used too.

Since:

4.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
WithSecurityContextTestExecutionListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterTestMethod(TestContext testContext) Clears out the TestSecurityContextHolder and the SecurityContextHolder after each test method.
void	beforeTestMethod(TestContext testContext) Sets up the SecurityContext for each test method.

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

afterTestClass, beforeTestClass, getOrder, prepareTestInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

WithSecurityContextTestExecutionListener

public WithSecurityContextTestExecutionListener()

Method Detail

beforeTestMethod

public void beforeTestMethod(TestContext testContext)
                      throws Exception

Sets up the SecurityContext for each test method. First the specific method is inspected for a WithSecurityContext or Annotation that has WithSecurityContext on it. If that is not found, the class is inspected. If still not found, then no SecurityContext is populated.

Specified by:

beforeTestMethod in interface TestExecutionListener

Overrides:

beforeTestMethod in class AbstractTestExecutionListener

Throws:

Exception

afterTestMethod

public void afterTestMethod(TestContext testContext)
                     throws Exception

Clears out the TestSecurityContextHolder and the SecurityContextHolder after each test method.

Specified by:

afterTestMethod in interface TestExecutionListener

Overrides:

afterTestMethod in class AbstractTestExecutionListener

Throws:

Exception