org.springframework.security.oauth2.server.authorization

Class OAuth2AuthorizationConsent

java.lang.Object

org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationConsent

All Implemented Interfaces:

java.io.Serializable

public final class OAuth2AuthorizationConsent
extends java.lang.Object
implements java.io.Serializable

A representation of an OAuth 2.0 "consent" to an Authorization request, which holds state related to the set of authorities granted to a client by the resource owner.

When authorizing access for a given client, the resource owner may only grant a subset of the authorities the client requested. The typical use-case is the authorization_code flow, in which the client requests a set of scopes. The resource owner then selects which scopes they grant to the client.

Since:

0.1.2

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2AuthorizationConsent.Builder A builder for OAuth2AuthorizationConsent.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static OAuth2AuthorizationConsent.Builder	from(OAuth2AuthorizationConsent authorizationConsent) Returns a new OAuth2AuthorizationConsent.Builder, initialized with the values from the provided OAuth2AuthorizationConsent.
java.util.Set<org.springframework.security.core.GrantedAuthority>	getAuthorities() Returns the authorities granted to the client by the principal.
java.lang.String	getPrincipalName() Returns the Principal name of the resource owner (or client).
java.lang.String	getRegisteredClientId() Returns the identifier for the registered client.
java.util.Set<java.lang.String>	getScopes() Convenience method for obtaining the scopes granted to the client by the principal, extracted from the authorities.
int	hashCode()
static OAuth2AuthorizationConsent.Builder	withId(java.lang.String registeredClientId, java.lang.String principalName) Returns a new OAuth2AuthorizationConsent.Builder, initialized with the given registeredClientId and Principal name.

Methods inherited from class java.lang.Object

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

Method Detail

getRegisteredClientId

public java.lang.String getRegisteredClientId()

Returns the identifier for the registered client.

Returns:

the RegisteredClient.getId()

getPrincipalName

public java.lang.String getPrincipalName()

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

Returns:

the Principal name of the resource owner (or client)

getAuthorities

public java.util.Set<org.springframework.security.core.GrantedAuthority> getAuthorities()

Returns the authorities granted to the client by the principal.

Returns:

the authorities granted to the client by the principal.

getScopes

public java.util.Set<java.lang.String> getScopes()

Convenience method for obtaining the scopes granted to the client by the principal, extracted from the authorities.

Returns:

the scopes granted to the client by the principal.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

from

public static OAuth2AuthorizationConsent.Builder from(OAuth2AuthorizationConsent authorizationConsent)

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

Parameters:

authorizationConsent - the OAuth2AuthorizationConsent used for initializing the OAuth2AuthorizationConsent.Builder

Returns:

the OAuth2AuthorizationConsent.Builder

withId

public static OAuth2AuthorizationConsent.Builder withId(@NonNull
                                                        java.lang.String registeredClientId,
                                                        @NonNull
                                                        java.lang.String principalName)

Returns a new OAuth2AuthorizationConsent.Builder, initialized with the given registeredClientId and Principal name.

Parameters:

registeredClientId - the RegisteredClient.getId()

principalName - the Principal name

Returns:

the OAuth2AuthorizationConsent.Builder