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

Class SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

SecurityMockMvcRequestPostProcessors

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

Since:

5.3

Method Summary

Modifier and Type	Method and Description
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	authorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities) Use the provided authorities in the Authentication
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	authorities(org.springframework.security.core.GrantedAuthority... authorities) Use the provided authorities in the Authentication
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	clientRegistration(org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration) Use the provided ClientRegistration as the client to authorize.
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	idToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcIdToken.Builder> idTokenBuilderConsumer) Use the provided OidcIdToken when constructing the authenticated user
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	oidcUser(org.springframework.security.oauth2.core.oidc.user.OidcUser oidcUser) Use the provided OidcUser as the authenticated user.
org.springframework.mock.web.MockHttpServletRequest	postProcessRequest(org.springframework.mock.web.MockHttpServletRequest request)
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor	userInfoToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder> userInfoBuilderConsumer) Use the provided OidcUserInfo when constructing the authenticated user

Methods inherited from class java.lang.Object

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

Method Detail

authorities

public SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor 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.OidcLoginRequestPostProcessor for further configuration

authorities

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

Use the provided authorities in the Authentication

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor for further configuration

idToken

public SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor idToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcIdToken.Builder> idTokenBuilderConsumer)

Use the provided OidcIdToken when constructing the authenticated user

Parameters:

idTokenBuilderConsumer - a Consumer of a OidcIdToken.Builder

Returns:

the SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor for further configuration

userInfoToken

public SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor userInfoToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder> userInfoBuilderConsumer)

Use the provided OidcUserInfo when constructing the authenticated user

Parameters:

userInfoBuilderConsumer - a Consumer of a OidcUserInfo.Builder

Returns:

the SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor for further configuration

oidcUser

public SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor oidcUser(org.springframework.security.oauth2.core.oidc.user.OidcUser oidcUser)

Use the provided OidcUser as the authenticated user.

Parameters:

oidcUser - the OidcUser to use

Returns:

the SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor for further configuration

clientRegistration

public SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor 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.OidcLoginRequestPostProcessor 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