クラス OAuth2AuthorizationResponse
- java.lang.Object
-
- org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse
public final class OAuth2AuthorizationResponse extends java.lang.Object
認可コード付与型の OAuth 2.0 認可レスポンスの表現。- 導入:
- 5.0
- 関連事項:
OAuth2Error
, セクション 4.1.2 認可レスポンス
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
OAuth2AuthorizationResponse.Builder
OAuth2AuthorizationResponse
のビルダー。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 static OAuth2AuthorizationResponse.Builder
error(java.lang.String errorCode)
エラーコードで初期化された新しいOAuth2AuthorizationResponse.Builder
を返します。java.lang.String
getCode()
認証コードを返します。OAuth2Error
getError()
認可リクエストが失敗した場合はOAuth 2.0 Error
を返し、それ以外の場合はnull
を返します。java.lang.String
getRedirectUri()
レスポンスがリダイレクトされた URI を返します。java.lang.String
getState()
状態を返します。boolean
statusError()
認可リクエストが失敗した場合はtrue
を返し、それ以外の場合はfalse
を返します。boolean
statusOk()
認可リクエストが成功した場合はtrue
を返し、それ以外の場合はfalse
を返します。static OAuth2AuthorizationResponse.Builder
success(java.lang.String code)
認証コードで初期化された新しいOAuth2AuthorizationResponse.Builder
を返します。
メソッドの詳細
getRedirectUri
public java.lang.String getRedirectUri()
レスポンスがリダイレクトされた URI を返します。- 戻り値:
- レスポンスがリダイレクトされた URI
getState
public java.lang.String getState()
状態を返します。- 戻り値:
- 状態
getCode
public java.lang.String getCode()
認証コードを返します。- 戻り値:
- 認証コード
getError
public OAuth2Error getError()
認可リクエストが失敗した場合はOAuth 2.0 Error
を返し、それ以外の場合はnull
を返します。- 戻り値:
- 認可リクエストが失敗した場合は
OAuth2Error
、それ以外の場合はnull
statusOk
public boolean statusOk()
認可リクエストが成功した場合はtrue
を返し、それ以外の場合はfalse
を返します。- 戻り値:
- 認可リクエストが成功した場合は
true
、それ以外の場合はfalse
statusError
public boolean statusError()
認可リクエストが失敗した場合はtrue
を返し、それ以外の場合はfalse
を返します。- 戻り値:
- 認可リクエストが失敗した場合は
true
、それ以外の場合はfalse
success
public static OAuth2AuthorizationResponse.Builder success(java.lang.String code)
認証コードで初期化された新しいOAuth2AuthorizationResponse.Builder
を返します。- パラメーター:
code
- 認証コード- 戻り値:
OAuth2AuthorizationResponse.Builder
error
public static OAuth2AuthorizationResponse.Builder error(java.lang.String errorCode)
エラーコードで初期化された新しいOAuth2AuthorizationResponse.Builder
を返します。- パラメーター:
errorCode
- エラーコード- 戻り値:
OAuth2AuthorizationResponse.Builder