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

Class SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

SecurityMockMvcRequestPostProcessors

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

Since:

5.3

Method Summary

Modifier and Type	Method and Description
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer) Mutate the attributes using the given Consumer
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor	authorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities) Use the provided authorities in the Authentication
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor	authorities(org.springframework.security.core.GrantedAuthority... authorities) Use the provided authorities in the Authentication
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor	clientRegistration(org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration) Use the provided ClientRegistration as the client to authorize.
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor	oauth2User(org.springframework.security.oauth2.core.user.OAuth2User oauth2User) Use the provided OAuth2User as the authenticated user.
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 Detail

authorities

public SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor authorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities)

Use the provided authorities in the Authentication

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor for further configuration

authorities

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

Use the provided authorities in the Authentication

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor for further configuration

attributes

public SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)

Mutate the attributes using the given Consumer

Parameters:

attributesConsumer - The Consumer for mutating the of attributes

Returns:

the SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor for further configuration

oauth2User

public SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor oauth2User(org.springframework.security.oauth2.core.user.OAuth2User oauth2User)

Use the provided OAuth2User as the authenticated user.

Parameters:

oauth2User - the OAuth2User to use

Returns:

the SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor for further configuration

clientRegistration

public SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor clientRegistration(org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration)

Use the provided ClientRegistration as the client to authorize. The supplied ClientRegistration will be registered into an HttpSessionOAuth2AuthorizedClientRepository. Tests relying on org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient annotations should register an HttpSessionOAuth2AuthorizedClientRepository bean to the application context.

Parameters:

clientRegistration - the ClientRegistration to use

Returns:

the SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor 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