Package org.springframework.security.oauth2.client.oidc.authentication.event

Class OidcUserRefreshedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.security.oauth2.client.oidc.authentication.event.OidcUserRefreshedEvent

All Implemented Interfaces:

Serializable

public final class OidcUserRefreshedEvent
extends org.springframework.context.ApplicationEvent

An event that is published when an OidcUser is refreshed as a result of using a refresh_token to obtain an OAuth 2.0 Access Token Response that contains an id_token.

Since:

6.5

See Also:

• OidcAuthorizedClientRefreshedEventListener
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
OidcUserRefreshedEvent(OAuth2AccessTokenResponse accessTokenResponse, OidcUser oldOidcUser, OidcUser newOidcUser, Authentication authentication)	Creates a new instance with the provided parameters.

Method Summary

Modifier and Type	Method	Description
OAuth2AccessTokenResponse	getAccessTokenResponse()	Returns the OAuth2AccessTokenResponse that triggered the event.
Authentication	getAuthentication()	Returns the authentication result.
OidcUser	getNewOidcUser()	Returns the refreshed OidcUser.
OidcUser	getOldOidcUser()	Returns the original OidcUser.

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OidcUserRefreshedEvent

public OidcUserRefreshedEvent(OAuth2AccessTokenResponse accessTokenResponse,
 OidcUser oldOidcUser,
 OidcUser newOidcUser,
 Authentication authentication)

Creates a new instance with the provided parameters.

Parameters:

accessTokenResponse - the OAuth2AccessTokenResponse that triggered the event

oldOidcUser - the original OidcUser

newOidcUser - the refreshed OidcUser

authentication - the authentication result

Method Details

getAccessTokenResponse

public OAuth2AccessTokenResponse getAccessTokenResponse()

Returns the OAuth2AccessTokenResponse that triggered the event.

Returns:

the access token response

getOldOidcUser

public OidcUser getOldOidcUser()

Returns the original OidcUser.

Returns:

the original user

getNewOidcUser

public OidcUser getNewOidcUser()

Returns the refreshed OidcUser.

Returns:

the refreshed user

getAuthentication

public Authentication getAuthentication()

Returns the authentication result.

Returns:

the authentication result