Package org.springframework.security.test.web.servlet.request

Class SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor

java.lang.Object

org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor

All Implemented Interfaces:

org.springframework.test.web.servlet.request.RequestPostProcessor

Enclosing class:

SecurityMockMvcRequestPostProcessors

public static final class SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
extends Object
implements org.springframework.test.web.servlet.request.RequestPostProcessor

Since:

5.2

Method Summary

Modifier and Type	Method	Description
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor	authorities(Collection<org.springframework.security.core.GrantedAuthority> authorities)	Use the provided authorities in the token
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor	authorities(org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,Collection<org.springframework.security.core.GrantedAuthority>> authoritiesConverter)	Provides the configured Jwt so that custom authorities can be derived from it
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor	authorities(org.springframework.security.core.GrantedAuthority... authorities)	Use the provided authorities in the token
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor	jwt(Consumer<org.springframework.security.oauth2.jwt.Jwt.Builder> jwtBuilderConsumer)	Use the given Jwt.Builder Consumer to configure the underlying Jwt This method first creates a default Jwt.Builder instance with default values for the alg, sub, and scope claims.
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor	jwt(org.springframework.security.oauth2.jwt.Jwt jwt)	Use the given Jwt
org.springframework.mock.web.MockHttpServletRequest	postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)

Methods inherited from class java.lang.Object

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

Method Details

jwt

public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor jwt(Consumer<org.springframework.security.oauth2.jwt.Jwt.Builder> jwtBuilderConsumer)

Use the given Jwt.Builder Consumer to configure the underlying Jwt This method first creates a default Jwt.Builder instance with default values for the alg, sub, and scope claims. The Consumer can then modify these or provide additional configuration. Calling SecurityMockMvcRequestPostProcessors.jwt() is the equivalent of calling SecurityMockMvcRequestPostProcessors.jwt().jwt(() -> {}).

Parameters:

jwtBuilderConsumer - For configuring the underlying Jwt

Returns:

the SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor for additional customization

jwt

public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor jwt(org.springframework.security.oauth2.jwt.Jwt jwt)

Use the given Jwt

Parameters:

jwt - The Jwt to use

Returns:

the SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor for additional customization

authorities

public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor authorities(Collection<org.springframework.security.core.GrantedAuthority> authorities)

Use the provided authorities in the token

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor for further configuration

authorities

public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor authorities(org.springframework.security.core.GrantedAuthority... authorities)

Use the provided authorities in the token

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor for further configuration

authorities

public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor authorities(org.springframework.core.convert.converter.Converter<org.springframework.security.oauth2.jwt.Jwt,Collection<org.springframework.security.core.GrantedAuthority>> authoritiesConverter)

Provides the configured Jwt so that custom authorities can be derived from it

Parameters:

authoritiesConverter - the conversion strategy from Jwt to a Collection of GrantedAuthoritys

Returns:

the SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor for further configuration

postProcessRequest

public org.springframework.mock.web.MockHttpServletRequest postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)

Specified by:

postProcessRequest in interface org.springframework.test.web.servlet.request.RequestPostProcessor