jp.co.intra_mart.foundation.salesforce.exception

クラス SalesforceOAuthRequestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

jp.co.intra_mart.foundation.salesforce.exception.SalesforceClientException

jp.co.intra_mart.foundation.salesforce.exception.SalesforceOAuthRequestException

すべての実装されたインタフェース:

Serializable

public class SalesforceOAuthRequestException
extends SalesforceClientException

SalesforceのOAuth認証処理で発生する例外クラスです。
この例外は、認可サーバでエラーが発生した場合にスローされます。

バージョン:

8.0.0

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SalesforceOAuthRequestException(String message, int statusCode, Map<String,Object> parameters) OAuth 2.0 のエラーレスポンスを使用して、例外クラスを作成します。
SalesforceOAuthRequestException(String message, int statusCode, Map<String,Object> parameters, Throwable cause) OAuth 2.0 のエラーレスポンスおよび原因を使用して、例外クラスを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getError() エラーコードを取得します。
String	getErrorDescription() エラーの追加テキスト情報を取得します。
String	getErrorUri() エラーの追加情報を得ることができるWebページのURIを取得します。
<T> T	getParameter(String key) エラーレスポンスの情報を取得します。
Map<String,Object>	getParameters() エラーレスポンスの全ての情報を取得します。
int	getStatusCode() HTTPステータスコードを取得します。
String	toString()

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

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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

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

コンストラクタの詳細

SalesforceOAuthRequestException

public SalesforceOAuthRequestException(String message,
                                       int statusCode,
                                       Map<String,Object> parameters)

OAuth 2.0 のエラーレスポンスを使用して、例外クラスを作成します。

パラメータ:

message - メッセージ

statusCode - HTTPステータスコード

parameters - エラーレスポンス情報

SalesforceOAuthRequestException

public SalesforceOAuthRequestException(String message,
                                       int statusCode,
                                       Map<String,Object> parameters,
                                       Throwable cause)

OAuth 2.0 のエラーレスポンスおよび原因を使用して、例外クラスを作成します。

パラメータ:

message - メッセージ

statusCode - HTTPステータスコード

parameters - エラーレスポンス情報

cause - 原因

メソッドの詳細

getError

public String getError()

エラーコードを取得します。
仕様に定義されたエラーコードは、定数クラス OAuthErrorCode に定義されています。
OAuth 2.0 の仕様では、拡張エラーコードも定義可能なため、OAuthErrorCode 以外のエラーコードが設定される場合もあります。

戻り値:

エラーコード

getErrorDescription

public String getErrorDescription()

エラーの追加テキスト情報を取得します。
オプショナルです。

戻り値:

エラーの追加テキスト情報

getErrorUri

public String getErrorUri()

エラーの追加情報を得ることができるWebページのURIを取得します。
オプショナルです。

戻り値:

エラーの追加情報を得ることができるWebページのURI

getParameter

public <T> T getParameter(String key)

エラーレスポンスの情報を取得します。
認可サーバごとに固有の追加エラー情報を取得したい場合に利用します。

型パラメータ:

T - エラーレスポンス情報の型

パラメータ:

key - エラーレスポンス情報のキー

戻り値:

エラーレスポンスの情報

getParameters

public Map<String,Object> getParameters()

エラーレスポンスの全ての情報を取得します。

戻り値:

エラーレスポンスの全ての情報

getStatusCode

public int getStatusCode()

HTTPステータスコードを取得します。

戻り値:

HTTPステータスコード

toString

public String toString()

オーバーライド:

toString クラス内 Throwable