jp.co.intra_mart.foundation.oauth.client.service

クラス OAuthErrorCode

java.lang.Object

jp.co.intra_mart.foundation.oauth.client.service.OAuthErrorCode

public final class OAuthErrorCode
extends Object

OAuth 2.0 認可コードグラントフローで発生するエラーのエラーコードを定義する定数クラスです。
OAuth 2.0 で定義されているエラーコードについては、以下を参照してください。

• 認可コード取得エラー： 4.1.2.1. Error Response
• アクセストークン取得エラー： 5.2. Error Response

バージョン:

8.0.0

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	ACCESS_DENIED リソースオーナーまたは認可サーバーがリクエストを拒否した.
static String	INVALID_CLIENT クライアント認証に失敗した (例: 未知のクライアントである, クライアント認証情報が含まれていない, サポートされない認証方式が利用されている).
static String	INVALID_GRANT 提供された認可グラント (例えば認可コード, リソースオーナークレデンシャル)またはリフレッシュトークン が不正, 有効期限切れ, 失効している, 認可リクエストで用いられたリダイレクトURIとマッチしていない, 他のクライアントに対して発行されたものである.
static String	INVALID_REQUEST リクエストに必要なパラメーターが含まれていない.
static String	INVALID_SCOPE リクエストスコープが不正, 未知, もしくはその他の不当な形式である.
static String	SERVER_ERROR 認可サーバーがリクエストの処理ができないような予期しない状況に遭遇した.
static String	TEMPORARILY_UNAVAILABLE 認可サーバーが一時的な過負荷やメンテナンスによってリクエストを扱うことが出来ない.
static String	UNAUTHORIZED_CLIENT クライアントは現在の方法でアクセストークンを取得することを認可されていない.
static String	UNSUPPORTED_GRANT_TYPE グラントタイプが認可サーバーによってサポートされていない.
static String	UNSUPPORTED_RESPONSE_TYPE 認可サーバーは現在の方法によるアクセストークン取得をサポートしていない.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static int	toStatusCode(String error) エラーコードをHTTPステータスコードに変換します。

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

INVALID_REQUEST

public static final String INVALID_REQUEST

リクエストに必要なパラメーターが含まれていない. 不正なパラメーターが付与されていた場合や, パラメータが複数回指定されていた場合, その他不正な形式であった場合もこれに含まれる.
リクエストに必要なパラメーターが含まれていない, サポートされない(グラントタイプ以外の)パラメーター値が含まれている, パラメーターが重複している, 複数のクレデンシャルが含まれている, クライアント認証のための複数のメカニズムが利用されている, もしくは異常値が設定されている.

関連項目:

定数フィールド値

UNAUTHORIZED_CLIENT

public static final String UNAUTHORIZED_CLIENT

クライアントは現在の方法でアクセストークンを取得することを認可されていない.
認証されたクライアントが当該のグラントタイプを利用する様に認可されていない.

関連項目:

定数フィールド値

ACCESS_DENIED

public static final String ACCESS_DENIED

リソースオーナーまたは認可サーバーがリクエストを拒否した.

関連項目:

定数フィールド値

UNSUPPORTED_RESPONSE_TYPE

public static final String UNSUPPORTED_RESPONSE_TYPE

認可サーバーは現在の方法によるアクセストークン取得をサポートしていない.

関連項目:

定数フィールド値

INVALID_SCOPE

public static final String INVALID_SCOPE

リクエストスコープが不正, 未知, もしくはその他の不当な形式である.
要求されたスコープが不正, 未知, 異常, リソースオーナーによって与えられた範囲を超えている.

関連項目:

定数フィールド値

SERVER_ERROR

public static final String SERVER_ERROR

認可サーバーがリクエストの処理ができないような予期しない状況に遭遇した. (このエラーコードはHTTPステータスコード500 Internal Server ErrorがHTTPリダイレクトではクライアントへ返されないため必要である)

関連項目:

定数フィールド値

TEMPORARILY_UNAVAILABLE

public static final String TEMPORARILY_UNAVAILABLE

認可サーバーが一時的な過負荷やメンテナンスによってリクエストを扱うことが出来ない. (このエラーコードはHTTPステータスコード503 Service UnavailabeがHTTPリダイレクトではクライアントへ返されないため必要である)

関連項目:

定数フィールド値

INVALID_CLIENT

public static final String INVALID_CLIENT

クライアント認証に失敗した (例: 未知のクライアントである, クライアント認証情報が含まれていない, サポートされない認証方式が利用されている). 認可サーバーはどのHTTP認証スキームがサポートされているかを示すためにHTTP ステータスコード 401 (Unauthorized) を返してもよい (MAY). もしクライアントが Authorization リクエストヘッダー経由で認証を試みた場合, 認可サーバーはHTTP ステータスコード 401 (Unauthorized) と共に, WWW-Authenticate レスポンスヘッダーにクライアントが利用すべき認証スキームを含めなければならない (MUST).

関連項目:

定数フィールド値

INVALID_GRANT

public static final String INVALID_GRANT

提供された認可グラント (例えば認可コード, リソースオーナークレデンシャル)またはリフレッシュトークン が不正, 有効期限切れ, 失効している, 認可リクエストで用いられたリダイレクトURIとマッチしていない, 他のクライアントに対して発行されたものである.

関連項目:

定数フィールド値

UNSUPPORTED_GRANT_TYPE

public static final String UNSUPPORTED_GRANT_TYPE

グラントタイプが認可サーバーによってサポートされていない.

関連項目:

定数フィールド値

メソッドの詳細

toStatusCode

public static int toStatusCode(String error)

エラーコードをHTTPステータスコードに変換します。
以下の変換を行います。

• 400 - invalid_request
• 401 - unauthorized_client
• 403 - access_denied
• 400 - unsupported_response_type
• 400 - invalid_scope
• 500 - server_error
• 503 - temporarily_unavailable
• 500 - それ以外

パラメータ:

error - エラーコード

戻り値:

HTTPステータスコード