Class OAuth2Authorization

java.lang.Object

org.springframework.security.oauth2.server.authorization.OAuth2Authorization

All Implemented Interfaces:

Serializable

public class OAuth2Authorization
extends Object
implements Serializable

A representation of an OAuth 2.0 Authorization, which holds state related to the authorization granted to a client, by the resource owner or itself in the case of the client_credentials grant type.

Since:

7.0

See Also:

• RegisteredClient
• AuthorizationGrantType
• OAuth2Token
• OAuth2AccessToken
• OAuth2RefreshToken
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2Authorization.Builder	A builder for OAuth2Authorization.
static class	OAuth2Authorization.Token<T extends org.springframework.security.oauth2.core.OAuth2Token>	A holder of an OAuth 2.0 Token and it's associated metadata.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OAuth2Authorization()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static OAuth2Authorization.Builder	from(OAuth2Authorization authorization)	Returns a new OAuth2Authorization.Builder, initialized with the values from the provided OAuth2Authorization.
@Nullable OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2AccessToken>	getAccessToken()	Returns the OAuth2Authorization.Token of type OAuth2AccessToken.
<T> @Nullable T	getAttribute(String name)	Returns the value of an attribute associated to the authorization.
Map<String,Object>	getAttributes()	Returns the attribute(s) associated to the authorization.
org.springframework.security.oauth2.core.AuthorizationGrantType	getAuthorizationGrantType()	Returns the authorization grant type used for the authorization.
Set<String>	getAuthorizedScopes()	Returns the authorized scope(s).
String	getId()	Returns the identifier for the authorization.
String	getPrincipalName()	Returns the Principal name of the resource owner (or client).
@Nullable OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2RefreshToken>	getRefreshToken()	Returns the OAuth2Authorization.Token of type OAuth2RefreshToken.
String	getRegisteredClientId()	Returns the identifier for the registered client.
<T extends org.springframework.security.oauth2.core.OAuth2Token> @Nullable OAuth2Authorization.Token<T>	getToken(Class<T> tokenType)	Returns the OAuth2Authorization.Token of type tokenType.
<T extends org.springframework.security.oauth2.core.OAuth2Token> @Nullable OAuth2Authorization.Token<T>	getToken(String tokenValue)	Returns the OAuth2Authorization.Token matching the tokenValue.
int	hashCode()
static OAuth2Authorization.Builder	withRegisteredClient(RegisteredClient registeredClient)	Returns a new OAuth2Authorization.Builder, initialized with the provided RegisteredClient.getId().

Methods inherited from class Object

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

Constructor Details

OAuth2Authorization

protected OAuth2Authorization()

Method Details

getId

public String getId()

Returns the identifier for the authorization.

Returns:

the identifier for the authorization

getRegisteredClientId

public String getRegisteredClientId()

Returns the identifier for the registered client.

Returns:

the RegisteredClient.getId()

getPrincipalName

public String getPrincipalName()

Returns the Principal name of the resource owner (or client).

Returns:

the Principal name of the resource owner (or client)

getAuthorizationGrantType

public org.springframework.security.oauth2.core.AuthorizationGrantType getAuthorizationGrantType()

Returns the authorization grant type used for the authorization.

Returns:

the AuthorizationGrantType used for the authorization

getAuthorizedScopes

public Set<String> getAuthorizedScopes()

Returns the authorized scope(s).

Returns:

the Set of authorized scope(s)

getAccessToken

public @Nullable OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2AccessToken> getAccessToken()

Returns the OAuth2Authorization.Token of type OAuth2AccessToken.

Returns:

the OAuth2Authorization.Token of type OAuth2AccessToken, or null if not available

getRefreshToken

public @Nullable OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2RefreshToken> getRefreshToken()

Returns the OAuth2Authorization.Token of type OAuth2RefreshToken.

Returns:

the OAuth2Authorization.Token of type OAuth2RefreshToken, or null if not available

getToken

public <T extends org.springframework.security.oauth2.core.OAuth2Token>
@Nullable OAuth2Authorization.Token<T> getToken(Class<T> tokenType)

Returns the OAuth2Authorization.Token of type tokenType.

Type Parameters:

T - the type of the token

Parameters:

tokenType - the token type

Returns:

the OAuth2Authorization.Token, or null if not available

getToken

public <T extends org.springframework.security.oauth2.core.OAuth2Token>
@Nullable OAuth2Authorization.Token<T> getToken(String tokenValue)

Returns the OAuth2Authorization.Token matching the tokenValue.

Type Parameters:

T - the type of the token

Parameters:

tokenValue - the token value

Returns:

the OAuth2Authorization.Token, or null if not available

getAttributes

public Map<String,Object> getAttributes()

Returns the attribute(s) associated to the authorization.

Returns:

a Map of the attribute(s)

getAttribute

public <T> @Nullable T getAttribute(String name)

Returns the value of an attribute associated to the authorization.

Type Parameters:

T - the type of the attribute

Parameters:

name - the name of the attribute

Returns:

the value of an attribute associated to the authorization, or null if not available

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

withRegisteredClient

public static OAuth2Authorization.Builder withRegisteredClient(RegisteredClient registeredClient)

Returns a new OAuth2Authorization.Builder, initialized with the provided RegisteredClient.getId().

Parameters:

registeredClient - the RegisteredClient

Returns:

the OAuth2Authorization.Builder

from

public static OAuth2Authorization.Builder from(OAuth2Authorization authorization)

Returns a new OAuth2Authorization.Builder, initialized with the values from the provided OAuth2Authorization.

Parameters:

authorization - the OAuth2Authorization used for initializing the OAuth2Authorization.Builder

Returns:

the OAuth2Authorization.Builder