Annotation Type WithSecurityContext
-
@Target(ANNOTATION_TYPE) @Retention(RUNTIME) @Inherited @Documented public @interface WithSecurityContext
An annotation to determine what
SecurityContext
to use. Thefactory()
attribute must be provided with an instance ofWithUserDetailsSecurityContextFactory
.Typically this annotation will be used as an meta-annotation as done with
WithMockUser
andWithUserDetails
.If you would like to create your own implementation of
WithSecurityContextFactory
you can do so by implementing the interface. You can also useAutowired
and other Spring semantics on theWithSecurityContextFactory
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
TheWithUserDetailsSecurityContextFactory
to use to create theSecurityContext
.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description TestExecutionEvent
setupBefore
Determines when theSecurityContext
is setup.
-
-
-
Element Detail
-
factory
java.lang.Class<? extends WithSecurityContextFactory<? extends java.lang.annotation.Annotation>> factory
TheWithUserDetailsSecurityContextFactory
to use to create theSecurityContext
. It can containAutowired
and other Spring annotations.- Returns:
-
-
-
setupBefore
TestExecutionEvent setupBefore
Determines when theSecurityContext
is setup. The default is beforeTestExecutionEvent.TEST_METHOD
which occurs duringTestExecutionListener.beforeTestMethod(TestContext)
- Returns:
- the
TestExecutionEvent
to initialize before - Since:
- 5.1
- Default:
- org.springframework.security.test.context.support.TestExecutionEvent.TEST_METHOD
-
-