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

Annotation Type WithUserDetails

  • @Target({METHOD,TYPE})
@Retention(RUNTIME)
@Inherited
@Documented
@WithSecurityContext(factory=org.springframework.security.test.context.support.WithUserDetailsSecurityContextFactory.class)
public @interface WithUserDetails
    When used with WithSecurityContextTestExecutionListener this annotation can be added to a test method to emulate running with a UserDetails returned from the UserDetailsService. In order to work with MockMvc The SecurityContext that is used will have the following properties:
    • The SecurityContext created with be that of SecurityContextHolder.createEmptyContext()
    • It will be populated with an UsernamePasswordAuthenticationToken that uses the username of value().
    Since:
    4.0
    See Also:
    WithMockUser

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      TestExecutionEvent setupBefore
      Determines when the SecurityContext is setup.
      java.lang.String userDetailsServiceBeanName
      The bean name for the UserDetailsService to use.
      java.lang.String value
      The username to look up in the UserDetailsService

    • Element Detail

      • value

        java.lang.String value
        The username to look up in the UserDetailsService
        Returns:
        Default:
        "user"

      • userDetailsServiceBeanName

        java.lang.String userDetailsServiceBeanName
        The bean name for the UserDetailsService to use. If this is not provided, then the lookup is done by type and expects only a single UserDetailsService bean to be exposed.
        Returns:
        the bean name for the UserDetailsService to use.
        Since:
        4.1
        Default:
        ""