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 java.lang.Object implements org.springframework.test.web.servlet.request.RequestPostProcessor
- Since:
- 5.2
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
authorities(java.util.Collection<GrantedAuthority> authorities)
Use the provided authorities in the tokenSecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
authorities(org.springframework.core.convert.converter.Converter<Jwt,java.util.Collection<GrantedAuthority>> authoritiesConverter)
Provides the configuredJwt
so that custom authorities can be derived from itSecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
authorities(GrantedAuthority... authorities)
Use the provided authorities in the tokenSecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
jwt(java.util.function.Consumer<Jwt.Builder> jwtBuilderConsumer)
Use the givenJwt.Builder
Consumer
to configure the underlyingJwt
This method first creates a defaultJwt.Builder
instance with default values for thealg
,sub
, andscope
claims.SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
jwt(Jwt jwt)
Use the givenJwt
org.springframework.mock.web.MockHttpServletRequest
postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)
-
-
-
Method Detail
-
jwt
public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor jwt(java.util.function.Consumer<Jwt.Builder> jwtBuilderConsumer)
Use the givenJwt.Builder
Consumer
to configure the underlyingJwt
This method first creates a defaultJwt.Builder
instance with default values for thealg
,sub
, andscope
claims. TheConsumer
can then modify these or provide additional configuration. CallingSecurityMockMvcRequestPostProcessors.jwt()
is the equivalent of callingSecurityMockMvcRequestPostProcessors.jwt().jwt(() -> {})
.- Parameters:
jwtBuilderConsumer
- For configuring the underlyingJwt
- Returns:
- the
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
for additional customization
-
jwt
public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor jwt(Jwt jwt)
Use the givenJwt
- Parameters:
jwt
- TheJwt
to use- Returns:
- the
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
for additional customization
-
authorities
public SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor authorities(java.util.Collection<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(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<Jwt,java.util.Collection<GrantedAuthority>> authoritiesConverter)
Provides the configuredJwt
so that custom authorities can be derived from it- Parameters:
authoritiesConverter
- the conversion strategy fromJwt
to aCollection
ofGrantedAuthority
s- 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 interfaceorg.springframework.test.web.servlet.request.RequestPostProcessor
-
-