Package org.springframework.security.test.context.support

Annotation Type WithSecurityContext

@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Inherited
@Documented
public @interface WithSecurityContext

An annotation to determine what SecurityContext to use. The factory() attribute must be provided with an instance of WithUserDetailsSecurityContextFactory.

Typically this annotation will be used as an meta-annotation as done with WithMockUser and WithUserDetails.

If you would like to create your own implementation of WithSecurityContextFactory you can do so by implementing the interface. You can also use Autowired and other Spring semantics on the WithSecurityContextFactory implementation.

Since:

4.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
java.lang.Class<? extends WithSecurityContextFactory<? extends java.lang.annotation.Annotation>>	factory	The WithUserDetailsSecurityContextFactory to use to create the SecurityContext.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
TestExecutionEvent	setupBefore	Determines when the SecurityContext is setup.

Element Detail

factory

java.lang.Class<? extends WithSecurityContextFactory<? extends java.lang.annotation.Annotation>> factory

The WithUserDetailsSecurityContextFactory to use to create the SecurityContext. It can contain Autowired and other Spring annotations.

Returns:

setupBefore

TestExecutionEvent setupBefore

Determines when the SecurityContext is setup. The default is before TestExecutionEvent.TEST_METHOD which occurs during TestExecutionListener.beforeTestMethod(TestContext)

Returns:

the TestExecutionEvent to initialize before

Since:

5.1

Default:

org.springframework.security.test.context.support.TestExecutionEvent.TEST_METHOD