OAuth2Authorization (spring-security-oauth2-authorization-server 0.3.0 API)

java.lang.Object
- org.springframework.security.oauth2.server.authorization.OAuth2Authorization

所有已实现的接口:

java.io.Serializable
```
public class OAuth2Authorization
extends java.lang.Object
implements java.io.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.

从以下版本开始:

0.0.1

另请参阅:

RegisteredClient, AuthorizationGrantType, OAuth2Token, OAuth2AccessToken, OAuth2RefreshToken, 序列化表格

嵌套类概要

嵌套类
限定符和类型	类和说明
`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.

字段概要

字段
限定符和类型字段和说明

static java.lang.String AUTHORIZED_SCOPE_ATTRIBUTE_NAME
The name of the attribute used for the authorized scope(s).

字段
限定符和类型	字段和说明
`static java.lang.String`	`AUTHORIZED_SCOPE_ATTRIBUTE_NAME` The name of the `attribute` used for the authorized scope(s).

构造器概要

构造器
限定符构造器和说明

protected OAuth2Authorization()

构造器
限定符	构造器和说明
`protected`	`OAuth2Authorization()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object obj)`
`static OAuth2Authorization.Builder`	`from(OAuth2Authorization authorization)` Returns a new `OAuth2Authorization.Builder`, initialized with the values from the provided `OAuth2Authorization`.
`OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2AccessToken>`	`getAccessToken()` Returns the `OAuth2Authorization.Token` of type `OAuth2AccessToken`.
`<T> T`	`getAttribute(java.lang.String name)` Returns the value of an attribute associated to the authorization.
`java.util.Map<java.lang.String,java.lang.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.
`java.lang.String`	`getId()` Returns the identifier for the authorization.
`java.lang.String`	`getPrincipalName()` Returns the `Principal` name of the resource owner (or client).
`OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2RefreshToken>`	`getRefreshToken()` Returns the `OAuth2Authorization.Token` of type `OAuth2RefreshToken`.
`java.lang.String`	`getRegisteredClientId()` Returns the identifier for the `registered client`.
`<T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Token<T>`	`getToken(java.lang.Class<T> tokenType)` Returns the `OAuth2Authorization.Token` of type `tokenType`.
`<T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Token<T>`	`getToken(java.lang.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()`.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - AUTHORIZED_SCOPE_ATTRIBUTE_NAME
```
public static final java.lang.String AUTHORIZED_SCOPE_ATTRIBUTE_NAME
```
    The name of the attribute used for the authorized scope(s). The value of the attribute is of type Set<String>.
- 构造器详细资料
  - OAuth2Authorization
```
protected OAuth2Authorization()
```
- 方法详细资料
  - getId
```
public java.lang.String getId()
```
    Returns the identifier for the authorization.
    
    返回:
    
    the identifier for the authorization
  - getRegisteredClientId
```
public java.lang.String getRegisteredClientId()
```
    Returns the identifier for the registered client.
    
    返回:
    
    the RegisteredClient.getId()
  - getPrincipalName
```
public java.lang.String getPrincipalName()
```
    Returns the Principal name of the resource owner (or client).
    
    返回:
    
    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.
    
    返回:
    
    the AuthorizationGrantType used for the authorization
  - getAccessToken
```
public OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2AccessToken> getAccessToken()
```
    Returns the OAuth2Authorization.Token of type OAuth2AccessToken.
    
    返回:
    
    the OAuth2Authorization.Token of type OAuth2AccessToken
  - getRefreshToken
```
@Nullable
public OAuth2Authorization.Token<org.springframework.security.oauth2.core.OAuth2RefreshToken> getRefreshToken()
```
    Returns the OAuth2Authorization.Token of type OAuth2RefreshToken.
    
    返回:
    
    the OAuth2Authorization.Token of type OAuth2RefreshToken, or null if not available
  - getToken
```
@Nullable
public <T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Token<T> getToken(java.lang.Class<T> tokenType)
```
    Returns the OAuth2Authorization.Token of type tokenType.
    
    类型参数:
    
    T - the type of the token
    
    参数:
    
    tokenType - the token type
    
    返回:
    
    the OAuth2Authorization.Token, or null if not available
  - getToken
```
@Nullable
public <T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Token<T> getToken(java.lang.String tokenValue)
```
    Returns the OAuth2Authorization.Token matching the tokenValue.
    
    类型参数:
    
    T - the type of the token
    
    参数:
    
    tokenValue - the token value
    
    返回:
    
    the OAuth2Authorization.Token, or null if not available
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    Returns the attribute(s) associated to the authorization.
    
    返回:
    
    a Map of the attribute(s)
  - getAttribute
```
@Nullable
public <T> T getAttribute(java.lang.String name)
```
    Returns the value of an attribute associated to the authorization.
    
    类型参数:
    
    T - the type of the attribute
    
    参数:
    
    name - the name of the attribute
    
    返回:
    
    the value of an attribute associated to the authorization, or null if not available
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - withRegisteredClient
```
public static OAuth2Authorization.Builder withRegisteredClient(RegisteredClient registeredClient)
```
    Returns a new OAuth2Authorization.Builder, initialized with the provided RegisteredClient.getId().
    
    参数:
    
    registeredClient - the RegisteredClient
    
    返回:
    
    the OAuth2Authorization.Builder
  - from
```
public static OAuth2Authorization.Builder from(OAuth2Authorization authorization)
```
    Returns a new OAuth2Authorization.Builder, initialized with the values from the provided OAuth2Authorization.
    
    参数:
    
    authorization - the OAuth2Authorization used for initializing the OAuth2Authorization.Builder
    
    返回:
    
    the OAuth2Authorization.Builder

类 OAuth2Authorization

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

AUTHORIZED_SCOPE_ATTRIBUTE_NAME

构造器详细资料

OAuth2Authorization

方法详细资料

getId

getRegisteredClientId

getPrincipalName

getAuthorizationGrantType

getAccessToken

getRefreshToken

getToken

getToken

getAttributes

getAttribute

equals

hashCode

withRegisteredClient

from