Package org.springframework.security.oauth2.server.authorization.web.authentication

Class OAuth2AccessTokenResponseAuthenticationSuccessHandler

java.lang.Object

org.springframework.security.oauth2.server.authorization.web.authentication.OAuth2AccessTokenResponseAuthenticationSuccessHandler

All Implemented Interfaces:

AuthenticationSuccessHandler

public final class OAuth2AccessTokenResponseAuthenticationSuccessHandler
extends Object
implements AuthenticationSuccessHandler

An implementation of an AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken and returning the Access Token Response.

Since:

7.0

See Also:

• AuthenticationSuccessHandler
• OAuth2AccessTokenResponseHttpMessageConverter

Constructor Summary

Constructors

Constructor	Description
OAuth2AccessTokenResponseAuthenticationSuccessHandler()

Method Summary

Modifier and Type	Method	Description
void	onAuthenticationSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Authentication authentication)	Called when a user has been successfully authenticated.
void	setAccessTokenResponseCustomizer(Consumer<OAuth2AccessTokenAuthenticationContext> accessTokenResponseCustomizer)	Sets the Consumer providing access to the OAuth2AccessTokenAuthenticationContext containing an OAuth2AccessTokenResponse.Builder and additional context information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.web.authentication.AuthenticationSuccessHandler

onAuthenticationSuccess

Constructor Details

OAuth2AccessTokenResponseAuthenticationSuccessHandler

public OAuth2AccessTokenResponseAuthenticationSuccessHandler()

Method Details

onAuthenticationSuccess

public void onAuthenticationSuccess(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Authentication authentication)
                             throws IOException,
jakarta.servlet.ServletException

Description copied from interface: AuthenticationSuccessHandler

Called when a user has been successfully authenticated.

Specified by:

onAuthenticationSuccess in interface AuthenticationSuccessHandler

Parameters:

request - the request which caused the successful authentication

response - the response

authentication - the Authentication object which was created during the authentication process.

Throws:

IOException

jakarta.servlet.ServletException

setAccessTokenResponseCustomizer

public void setAccessTokenResponseCustomizer(Consumer<OAuth2AccessTokenAuthenticationContext> accessTokenResponseCustomizer)

Sets the Consumer providing access to the OAuth2AccessTokenAuthenticationContext containing an OAuth2AccessTokenResponse.Builder and additional context information.

Parameters:

accessTokenResponseCustomizer - the Consumer providing access to the OAuth2AccessTokenAuthenticationContext containing an OAuth2AccessTokenResponse.Builder