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

Interface ServerAuthorizationRequestRepository<T extends org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest>

Type Parameters:

T - The type of OAuth 2.0 Authorization Request

All Known Implementing Classes:

WebSessionOAuth2ServerAuthorizationRequestRepository

public interface ServerAuthorizationRequestRepository<T extends org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest>

Implementations of this interface are responsible for the persistence of OAuth2AuthorizationRequest between requests.

Used by the OAuth2AuthorizationRequestRedirectFilter for persisting the Authorization Request before it initiates the authorization code grant flow. As well, used by the OAuth2LoginAuthenticationFilter for resolving the associated Authorization Request when handling the callback of the Authorization Response.

Since:

5.1

See Also:

OAuth2AuthorizationRequest, HttpSessionOAuth2AuthorizationRequestRepository

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<T>	loadAuthorizationRequest(org.springframework.web.server.ServerWebExchange exchange) Returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest or null if not available.
reactor.core.publisher.Mono<T>	removeAuthorizationRequest(org.springframework.web.server.ServerWebExchange exchange) Removes and returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest or if not available returns null.
reactor.core.publisher.Mono<java.lang.Void>	saveAuthorizationRequest(T authorizationRequest, org.springframework.web.server.ServerWebExchange exchange) Persists the OAuth2AuthorizationRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

Method Detail

loadAuthorizationRequest

reactor.core.publisher.Mono<T> loadAuthorizationRequest(org.springframework.web.server.ServerWebExchange exchange)

Returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest or null if not available.

Parameters:

exchange - the ServerWebExchange

Returns:

the OAuth2AuthorizationRequest or null if not available

saveAuthorizationRequest

reactor.core.publisher.Mono<java.lang.Void> saveAuthorizationRequest(T authorizationRequest,
                                                                     org.springframework.web.server.ServerWebExchange exchange)

Persists the OAuth2AuthorizationRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

Parameters:

authorizationRequest - the OAuth2AuthorizationRequest

exchange - the ServerWebExchange

removeAuthorizationRequest

reactor.core.publisher.Mono<T> removeAuthorizationRequest(org.springframework.web.server.ServerWebExchange exchange)

Removes and returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest or if not available returns null.

Parameters:

exchange - the ServerWebExchange

Returns:

the removed OAuth2AuthorizationRequest or null if not available