Class DefaultOAuth2AuthorizationRequestResolver
- java.lang.Object
-
- org.springframework.security.oauth2.client.web.DefaultOAuth2AuthorizationRequestResolver
-
- All Implemented Interfaces:
OAuth2AuthorizationRequestResolver
public final class DefaultOAuth2AuthorizationRequestResolver extends java.lang.Object implements OAuth2AuthorizationRequestResolver
An implementation of anOAuth2AuthorizationRequestResolver
that attempts to resolve anOAuth2AuthorizationRequest
from the providedHttpServletRequest
using the default requestURI
pattern/oauth2/authorization/{registrationId}
.NOTE: The default base
URI
/oauth2/authorization
may be overridden via it's constructorDefaultOAuth2AuthorizationRequestResolver(ClientRegistrationRepository, String)
.- Since:
- 5.1
- See Also:
OAuth2AuthorizationRequestResolver
,OAuth2AuthorizationRequestRedirectFilter
-
-
Constructor Summary
Constructors Constructor Description DefaultOAuth2AuthorizationRequestResolver(ClientRegistrationRepository clientRegistrationRepository, java.lang.String authorizationRequestBaseUri)
Constructs aDefaultOAuth2AuthorizationRequestResolver
using the provided parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OAuth2AuthorizationRequest
resolve(javax.servlet.http.HttpServletRequest request)
Returns theOAuth2AuthorizationRequest
resolved from the providedHttpServletRequest
ornull
if not available.OAuth2AuthorizationRequest
resolve(javax.servlet.http.HttpServletRequest request, java.lang.String registrationId)
Returns theOAuth2AuthorizationRequest
resolved from the providedHttpServletRequest
ornull
if not available.void
setAuthorizationRequestCustomizer(java.util.function.Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer)
Sets theConsumer
to be provided theOAuth2AuthorizationRequest.Builder
allowing for further customizations.
-
-
-
Constructor Detail
-
DefaultOAuth2AuthorizationRequestResolver
public DefaultOAuth2AuthorizationRequestResolver(ClientRegistrationRepository clientRegistrationRepository, java.lang.String authorizationRequestBaseUri)
Constructs aDefaultOAuth2AuthorizationRequestResolver
using the provided parameters.- Parameters:
clientRegistrationRepository
- the repository of client registrationsauthorizationRequestBaseUri
- the baseURI
used for resolving authorization requests
-
-
Method Detail
-
resolve
public OAuth2AuthorizationRequest resolve(javax.servlet.http.HttpServletRequest request)
Description copied from interface:OAuth2AuthorizationRequestResolver
Returns theOAuth2AuthorizationRequest
resolved from the providedHttpServletRequest
ornull
if not available.- Specified by:
resolve
in interfaceOAuth2AuthorizationRequestResolver
- Parameters:
request
- theHttpServletRequest
- Returns:
- the resolved
OAuth2AuthorizationRequest
ornull
if not available
-
resolve
public OAuth2AuthorizationRequest resolve(javax.servlet.http.HttpServletRequest request, java.lang.String registrationId)
Description copied from interface:OAuth2AuthorizationRequestResolver
Returns theOAuth2AuthorizationRequest
resolved from the providedHttpServletRequest
ornull
if not available.- Specified by:
resolve
in interfaceOAuth2AuthorizationRequestResolver
- Parameters:
request
- theHttpServletRequest
registrationId
- the clientRegistrationId to use- Returns:
- the resolved
OAuth2AuthorizationRequest
ornull
if not available
-
setAuthorizationRequestCustomizer
public void setAuthorizationRequestCustomizer(java.util.function.Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer)
Sets theConsumer
to be provided theOAuth2AuthorizationRequest.Builder
allowing for further customizations.- Parameters:
authorizationRequestCustomizer
- theConsumer
to be provided theOAuth2AuthorizationRequest.Builder
- Since:
- 5.3
-
-