クラス OAuth2AuthorizationRequest
- java.lang.Object
-
- org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest
- 実装されたすべてのインターフェース:
java.io.Serializable
public final class OAuth2AuthorizationRequest extends java.lang.Object implements java.io.Serializable
認可コード認可型または暗黙的認可型の OAuth 2.0 認可リクエストの表現。
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
OAuth2AuthorizationRequest.Builder
OAuth2AuthorizationRequest
のビルダー。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 static OAuth2AuthorizationRequest.Builder
authorizationCode()
認証コード付与型で初期化された新しいOAuth2AuthorizationRequest.Builder
を返します。static OAuth2AuthorizationRequest.Builder
from(OAuth2AuthorizationRequest authorizationRequest)
指定されたauthorizationRequest
の値で初期化された新しいOAuth2AuthorizationRequest.Builder
を返します。java.util.Map<java.lang.String,java.lang.Object>
getAdditionalParameters()
リクエストで使用される追加のパラメーターを返します。<T> T
getAttribute(java.lang.String name)
リクエストに関連付けられている属性の値を返します。java.util.Map<java.lang.String,java.lang.Object>
getAttributes()
リクエストに関連付けられている属性を返します。java.lang.String
getAuthorizationRequestUri()
OAuth 2.0 認可リクエストのURI
文字列表現を返します。java.lang.String
getAuthorizationUri()
認可エンドポイントの URI を返します。java.lang.String
getClientId()
クライアント識別子を返します。AuthorizationGrantType
getGrantType()
grant type
を返します。java.lang.String
getRedirectUri()
リダイレクトエンドポイントの URI を返します。OAuth2AuthorizationResponseType
getResponseType()
response type
を返します。java.util.Set<java.lang.String>
getScopes()
スコープを返します。java.lang.String
getState()
状態を返します。static OAuth2AuthorizationRequest.Builder
implicit()
使用すべきではありません。クライアントが受信したことを確認せずに HTTP リダイレクトでアクセストークンを返すという固有のリスクがあるため、暗黙のフローを使用することはお勧めしません。
メソッドの詳細
getAuthorizationUri
public java.lang.String getAuthorizationUri()
認可エンドポイントの URI を返します。- 戻り値:
- 認可エンドポイントの URI
getGrantType
public AuthorizationGrantType getGrantType()
grant type
を返します。
getResponseType
public OAuth2AuthorizationResponseType getResponseType()
response type
を返します。
getClientId
public java.lang.String getClientId()
クライアント識別子を返します。- 戻り値:
- クライアント識別子
getRedirectUri
public java.lang.String getRedirectUri()
リダイレクトエンドポイントの URI を返します。- 戻り値:
- リダイレクトエンドポイントの URI
getScopes
public java.util.Set<java.lang.String> getScopes()
スコープを返します。- 戻り値:
- スコープ、または利用できない場合は空の
Set
getState
public java.lang.String getState()
状態を返します。- 戻り値:
- 状態
getAdditionalParameters
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalParameters()
リクエストで使用される追加のパラメーターを返します。- 戻り値:
- 追加パラメーターの
Map
、または利用できない場合は空のMap
getAttributes
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
リクエストに関連付けられている属性を返します。- 戻り値:
- 属性の
Map
、または利用できない場合は空のMap
- 導入:
- 5.2
getAttribute
public <T> T getAttribute(java.lang.String name)
リクエストに関連付けられている属性の値を返します。- 型パラメーター:
T
- 属性の型- パラメーター:
name
- 属性の名前- 戻り値:
- リクエストに関連付けられた属性の値、または利用できない場合は
null
- 導入:
- 5.2
getAuthorizationRequestUri
public java.lang.String getAuthorizationRequestUri()
OAuth 2.0 認可リクエストのURI
文字列表現を返します。注意 :
URI
文字列は、application/x-www-form-urlencoded
MIME 形式でエンコードされます。- 戻り値:
- OAuth 2.0 認可リクエストの
URI
文字列表現 - 導入:
- 5.1
authorizationCode
public static OAuth2AuthorizationRequest.Builder authorizationCode()
認証コード付与型で初期化された新しいOAuth2AuthorizationRequest.Builder
を返します。
implicit
@Deprecated public static OAuth2AuthorizationRequest.Builder implicit()
使用すべきではありません。クライアントが受信したことを確認せずに HTTP リダイレクトでアクセストークンを返すという固有のリスクがあるため、暗黙のフローを使用することはお勧めしません。暗黙的な付与型で初期化された新しいOAuth2AuthorizationRequest.Builder
を返します。
from
public static OAuth2AuthorizationRequest.Builder from(OAuth2AuthorizationRequest authorizationRequest)
指定されたauthorizationRequest
の値で初期化された新しいOAuth2AuthorizationRequest.Builder
を返します。- パラメーター:
authorizationRequest
-OAuth2AuthorizationRequest.Builder
の初期化に使用される認可リクエスト- 戻り値:
OAuth2AuthorizationRequest.Builder
- 導入:
- 5.1