Result クラス
目次
casso126jjp
目次
結果クラスである SmApiResult には、
CA Single Sign-on
Java API 要求の結果が格納されます。CA Single Sign-on
の結果は、以下の要素で構成されます。- ファシリティ。結果の発生元。たとえば、結果はクライアントまたはサーバ上で発生する場合があります。
- 重大度。情報または警告のような結果の重大度。
- ステータス。結果のステータス コード。ステータス コードは各ファシリティ内で一意です。ファシリティの一意のステータス コードを使用して、特定の結果を同じファシリティで発生した他の結果と識別することができます。
- メッセージ。説明文または数値の詳細など結果に関する追加の情報。
結果には理由コードも含まれる場合があります。たとえば、パスワード ポリシー結果には、パスワードが必須最小文字数を満たしていないことを示す理由コード 1001 が含まれる場合があります。結果用の理由コードを検索するには、getReason() を呼び出します。
サーバ側のエラーがすべて例外ではなく結果として返されます。ただし、クライアント側の例外がスローされる場合、SmApiResult オブジェクトは例外に埋め込まれています。
結果オブジェクトの解釈
各結果オブジェクトおよびそのファシリティ/重大度/ステータスの組み合わせは一意の値によって表されます。これらの一意の値は、たとえば SERVER_CONFIGURATION_FAILURE のように、SmApiResult クラスで定義された事前定義済み定数と関連付けられます。
結果に対するファシリティ/重大度/ステータス情報を判断するには、equals() メソッドを呼び出してSmApiResult を結果定数と比較することができます。
- 機能: FACILITY_CONNECTION
- 重大度: SEVERITY_ERROR
- ステータス: 4
- メッセージ: サーバ設定を取得できません (Unable to get server configuration)
結果オブジェクトを文字列として出力できます。たとえば、SmApiResult オブジェクト上で toString() を呼び出すことで、結果文字列を生成できます。
結果文字列にはスペースで区切られた 5 つの名前/値ペアが以下の形式で含まれています。
[facility=facility severity=severity reason=reasonstatus=statusCode message=message]
たとえば、ユーザがパスワードの英数字数の下限より少ない文字数でパスワードを作成しようとした場合に発生する SmApiResult オブジェクトに対して toString() を呼び出したとします。メソッドは、以下のように見える結果文字列を返す場合があります。
[facility=4 severity=3 reason=1008 status=13 message=nArg=1,Arg1=3]
結果内のフィールドには以下の意味があります。
- facility=4。結果はサーバで発生しました。
- severity=3。結果はエラーです。
- reason=1008。要求されたパスワードの文字数がパスワードに必要な英数字の最小数より少ないため、エラーが発生しました。
- status=13。このファシリティに対する一意の結果ステータス コード。
- message=nArg=1,Arg1=3 結果の追加の説明。このフィールドの 2 つの部分には以下の意味があります。
- nArg1=1。エラーには単に 1 つのエラー説明が含まれます。
- Arg1=3。エラー説明は 3 です。理由コード 1008 のコンテキストでは、Arg1 値はパスワードに少なくとも 3 つの英数字が含まれる必要があることを示しています。
Result クラスの中心的なメソッド
Method | Description |
equals() | 現在のオブジェクトがメソッドに渡されたオブジェクトと等しいかどうかを示します。 |
getError() | 一意のエラー コードを取得します。 |
getFacility() | エラーと関連付けられたファシリティ コードを取得します。 |
getMessage() | エラーと関連付けられたメッセージを取得します。 |
getReason() | エラーの理由コードを取得します。 |
getSeverity() | エラーと関連付けられた重大度コードを取得します。 |
getStatus() | 現在のファシリティ内のステータス コードを取得します。このメソッドはサーバからのパラメータを結果コードとして使用することができます。 |
isSuccess() | 要求が成功したかどうかをレポートします。 |
toString() | SmApiResult オブジェクトの文字列の表現を返します。 |