org.springframework.security.oauth2.client.web

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

Type Parameters:

T - The type of OAuth 2.0 Authorization Request

All Known Implementing Classes:

HttpSessionOAuth2AuthorizationRequestRepository

public interface AuthorizationRequestRepository<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.0

See Also:

OAuth2AuthorizationRequest, HttpSessionOAuth2AuthorizationRequestRepository

Method Summary

Modifier and Type	Method and Description
T	loadAuthorizationRequest(javax.servlet.http.HttpServletRequest request) Returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest or null if not available.
T	removeAuthorizationRequest(javax.servlet.http.HttpServletRequest request) Deprecated. Use removeAuthorizationRequest(HttpServletRequest, HttpServletResponse) instead
default T	removeAuthorizationRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Removes and returns the OAuth2AuthorizationRequest associated to the provided HttpServletRequest and HttpServletResponse or if not available returns null.
void	saveAuthorizationRequest(T authorizationRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Persists the OAuth2AuthorizationRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

Method Detail

loadAuthorizationRequest

T loadAuthorizationRequest(javax.servlet.http.HttpServletRequest request)

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

Parameters:

request - the HttpServletRequest

Returns:

the OAuth2AuthorizationRequest or null if not available

saveAuthorizationRequest

void saveAuthorizationRequest(T authorizationRequest,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)

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

Parameters:

authorizationRequest - the OAuth2AuthorizationRequest

request - the HttpServletRequest

response - the HttpServletResponse

removeAuthorizationRequest

@Deprecated
T removeAuthorizationRequest(javax.servlet.http.HttpServletRequest request)

Deprecated. Use removeAuthorizationRequest(HttpServletRequest, HttpServletResponse) instead

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

Parameters:

request - the HttpServletRequest

Returns:

the removed OAuth2AuthorizationRequest or null if not available

removeAuthorizationRequest

default T removeAuthorizationRequest(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

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

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the OAuth2AuthorizationRequest or null if not available

Since:

5.1