Package org.springframework.security.oauth2.client.web.server

Class DefaultServerOAuth2AuthorizationRequestResolver

java.lang.Object

org.springframework.security.oauth2.client.web.server.DefaultServerOAuth2AuthorizationRequestResolver

All Implemented Interfaces:

ServerOAuth2AuthorizationRequestResolver

public class DefaultServerOAuth2AuthorizationRequestResolver
extends java.lang.Object
implements ServerOAuth2AuthorizationRequestResolver

The default implementation of ServerOAuth2AuthorizationRequestResolver. The ClientRegistration.getRegistrationId() is extracted from the request using the DEFAULT_AUTHORIZATION_REQUEST_PATTERN. The injected ReactiveClientRegistrationRepository is then used to resolve the ClientRegistration and create the OAuth2AuthorizationRequest.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_AUTHORIZATION_REQUEST_PATTERN	The default pattern used to resolve the ClientRegistration.getRegistrationId()
static java.lang.String	DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME	The name of the path variable that contains the ClientRegistration.getRegistrationId()

Constructor Summary

Constructors

Constructor	Description
DefaultServerOAuth2AuthorizationRequestResolver(ReactiveClientRegistrationRepository clientRegistrationRepository)	Creates a new instance
DefaultServerOAuth2AuthorizationRequestResolver(ReactiveClientRegistrationRepository clientRegistrationRepository, org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher authorizationRequestMatcher)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest>	resolve(org.springframework.web.server.ServerWebExchange exchange)	Returns the OAuth2AuthorizationRequest resolved from the provided HttpServletRequest or null if not available.
reactor.core.publisher.Mono<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest>	resolve(org.springframework.web.server.ServerWebExchange exchange, java.lang.String clientRegistrationId)	Returns the OAuth2AuthorizationRequest resolved from the provided HttpServletRequest or null if not available.
void	setAuthorizationRequestCustomizer(java.util.function.Consumer<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer)	Sets the Consumer to be provided the OAuth2AuthorizationRequest.Builder allowing for further customizations.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME

public static final java.lang.String DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME

The name of the path variable that contains the ClientRegistration.getRegistrationId()

See Also:

Constant Field Values

DEFAULT_AUTHORIZATION_REQUEST_PATTERN

public static final java.lang.String DEFAULT_AUTHORIZATION_REQUEST_PATTERN

The default pattern used to resolve the ClientRegistration.getRegistrationId()

See Also:

Constant Field Values

Constructor Detail

DefaultServerOAuth2AuthorizationRequestResolver

public DefaultServerOAuth2AuthorizationRequestResolver(ReactiveClientRegistrationRepository clientRegistrationRepository)

Creates a new instance

Parameters:

clientRegistrationRepository - the repository to resolve the ClientRegistration

DefaultServerOAuth2AuthorizationRequestResolver

public DefaultServerOAuth2AuthorizationRequestResolver(ReactiveClientRegistrationRepository clientRegistrationRepository,
                                                       org.springframework.security.web.server.util.matcher.ServerWebExchangeMatcher authorizationRequestMatcher)

Creates a new instance

Parameters:

clientRegistrationRepository - the repository to resolve the ClientRegistration

authorizationRequestMatcher - the matcher that determines if the request is a match and extracts the DEFAULT_REGISTRATION_ID_URI_VARIABLE_NAME from the path variables.

Method Detail

resolve

public reactor.core.publisher.Mono<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest> resolve(org.springframework.web.server.ServerWebExchange exchange)

Description copied from interface: ServerOAuth2AuthorizationRequestResolver

Returns the OAuth2AuthorizationRequest resolved from the provided HttpServletRequest or null if not available.

Specified by:

resolve in interface ServerOAuth2AuthorizationRequestResolver

Parameters:

exchange - the ServerWebExchange

Returns:

the resolved OAuth2AuthorizationRequest or null if not available

resolve

public reactor.core.publisher.Mono<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest> resolve(org.springframework.web.server.ServerWebExchange exchange,
                                                                                                                         java.lang.String clientRegistrationId)

Description copied from interface: ServerOAuth2AuthorizationRequestResolver

Returns the OAuth2AuthorizationRequest resolved from the provided HttpServletRequest or null if not available.

Specified by:

resolve in interface ServerOAuth2AuthorizationRequestResolver

Parameters:

exchange - the ServerWebExchange

clientRegistrationId - the client registration id

Returns:

the resolved OAuth2AuthorizationRequest or null if not available

setAuthorizationRequestCustomizer

public final void setAuthorizationRequestCustomizer(java.util.function.Consumer<org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer)

Sets the Consumer to be provided the OAuth2AuthorizationRequest.Builder allowing for further customizations.

Parameters:

authorizationRequestCustomizer - the Consumer to be provided the OAuth2AuthorizationRequest.Builder

Since:

5.3