javax.security.sasl

クラス SaslException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

javax.security.sasl.SaslException

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

Serializable

直系の既知のサブクラス:

AuthenticationException

public class SaslException
extends IOException

このクラスは、SASL の使用時に発生したエラーを表します。

導入されたバージョン:

1.5

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
SaslException() SaslException の新しいインスタンスを構築します。
SaslException(String detail) 詳細メッセージを含む SaslException の新しいインスタンスを構築します。
SaslException(String detail, Throwable ex) 詳細メッセージとルート例外を含む SaslException の新しいインスタンスを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Throwable	getCause() このスロー可能オブジェクトの原因を返しますが、原因が存在しないか不明な場合は null を返します。
Throwable	initCause(Throwable cause) このスロー可能オブジェクトの原因を、指定された値に初期化します。
String	toString() この例外の文字列表現を返します。

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

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

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

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

コンストラクタの詳細

SaslException

public SaslException()

SaslException の新しいインスタンスを構築します。ルート例外や詳細メッセージは null です。

SaslException

public SaslException(String detail)

詳細メッセージを含む SaslException の新しいインスタンスを構築します。ルート例外は null です。

パラメータ:

detail - この例外に関する詳細情報を含む文字列。null の場合もある。

関連項目:

Throwable.getMessage()

SaslException

public SaslException(String detail,
             Throwable ex)

詳細メッセージとルート例外を含む SaslException の新しいインスタンスを構築します。たとえば、SaslException はコールバックハンドラに問題がある場合にスローされることがあり、要求されたコールバックをサポートしていない場合は NoSuchCallbackException がスローされ、コールバック用のデータを取得しているときに問題が発生した場合は IOException がスローされます。その際、SaslException のルート例外は、コールバックハンドラによってスローされた例外となります。

パラメータ:

detail - この例外に関する詳細情報を含む文字列。null の場合もある。

ex - この例外がスローされる原因となったルート例外。null の場合もある。

関連項目:

Throwable.getMessage(), getCause()

メソッドの詳細

getCause

public Throwable getCause()

次のクラスからコピーされた説明: Throwable

このスロー可能オブジェクトの原因を返しますが、原因が存在しないか不明な場合は null を返します。原因はこの Throwable をスローさせた Throwable です。

この実装は、Throwable を要求するいずれかのコンストラクタ経由で提供された原因、または Throwable.initCause(Throwable) メソッドを使用して作成後に設定された原因を返します。通常、このメソッドをオーバーライドする必要はありませんが、サブクラスはこのメソッドをオーバーライドして、ほかの何らかの方法で設定された原因を返すことができます。これは、チェーンされた例外の Throwable への追加前に実行される「レガシー連鎖スロー可能オブジェクト」の場合に適切な動作です。PrintStackTrace メソッドのいずれかをオーバーライドする必要はありません。これらのメソッドはすべて getCause メソッドを呼び出して、スロー可能オブジェクトの原因を判別します。

オーバーライド:

getCause、クラス: Throwable

戻り値:

このスロー可能オブジェクトの原因。原因が存在しないか不明の場合は null。

initCause

public Throwable initCause(Throwable cause)

次のクラスからコピーされた説明: Throwable

このスロー可能オブジェクトの原因を、指定された値に初期化します。原因はこの Throwable をスローさせた Throwable です。

このメソッドは最大で 1 回しか呼び出すことができません。通常は、コンストラクタ内から、または Throwable の作成直後に呼び出されます。このスロー可能オブジェクトが Throwable.Throwable(Throwable) または Throwable.Throwable(String,Throwable) を使用して作成された場合、このメソッドは 1 回も呼び出すことができません。

原因を設定するためのその他のサポートを含まないレガシースロー可能型でこのメソッドを使用する例を、次に示します。

 try {
     lowLevelOp();
 } catch (LowLevelException le) {
     throw (HighLevelException)
           new HighLevelException().initCause(le); // Legacy constructor
 }
 

オーバーライド:

initCause、クラス: Throwable

パラメータ:

cause - 原因 (あとで Throwable.getCause() メソッドで取得できるように保存される)。(null 値が許可されており、原因が存在しないか不明であることを示す)

戻り値:

この Throwable インスタンスへの参照。

toString

public String toString()

この例外の文字列表現を返します。文字列表現には、この例外のクラス名、詳細メッセージ、およびルート例外の文字列表現 (ルート例外がある場合) が含まれています。この文字列表現は、デバッグ専用であり、プログラムによって解釈されるものではありません。

オーバーライド:

toString、クラス: Throwable

戻り値:

この例外の null 以外の文字列表現。

関連項目:

Throwable.getMessage()