モジュール java.naming

パッケージ javax.naming.ldap

クラスLdapReferralException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.naming.NamingException

javax.naming.ReferralException

javax.naming.ldap.LdapReferralException

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

Serializable

public abstract class LdapReferralException extends ReferralException

このabstractクラスは、LDAP参照例外を表すために使用されます。 これは、リクエスト制御を受け入れるgetReferralContext()メソッドを提供することで、ベースReferralExceptionを拡張します。 LdapReferralExceptionは、abstractクラスです。 この具象実装によって、そのクラスの同期および直列化プロパティが決定します。

getReferralContext()メソッドにパラメータとして渡されたControl[]配列は、コール元によって所有されます。 サービス・プロバイダは、配列を変更したり、配列への参照を保持したりしませんが、配列内の個々のControlオブジェクトへの参照を保持する場合があります。

導入されたバージョン:

1.3

関連項目:

• 直列化された形式

フィールドのサマリー

クラスjavax.naming.NamingExceptionで宣言されたフィールド

remainingName, resolvedName, resolvedObj, rootException

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

コンストラクタ

修飾子	コンストラクタ	説明
protected	LdapReferralException()	LdapReferralExceptionのインスタンスを新しく構築します。
protected	LdapReferralException(String explanation)	指定された説明を使用して、LdapReferralExceptionのインスタンスを新たに構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
abstract Context	getReferralContext()	コントロールは使わずに、コンテキストの環境を使用してメソッドを継続する時点のコンテキストを検出します。
abstract Context	getReferralContext(Hashtable<?,?> env)	コントロールは使用せずに、環境プロパティを使用してメソッドを継続する時点のコンテキストを検出します。
abstract Context	getReferralContext(Hashtable<?,?> env, Control[] reqCtls)	要求コントロールおよび環境プロパティを使用して、メソッドを継続する時点のコンテキストを取り出します。

クラスjavax.naming.ReferralExceptionで宣言されたメソッド

getReferralInfo, retryReferral, skipReferral

クラスjavax.naming.NamingExceptionで宣言されたメソッド

appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, 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

コンストラクタの詳細

LdapReferralException

protected LdapReferralException(String explanation)

指定された説明を使用して、LdapReferralExceptionのインスタンスを新たに構築します。 ほかのフィールドはすべてnullに設定されます。

パラメータ:

explanation - この例外に関する追加の詳細情報。 nullも可。

関連項目:

• Throwable.getMessage()

LdapReferralException

protected LdapReferralException()

LdapReferralExceptionのインスタンスを新しく構築します。 フィールドはすべてnullに設定されます。

メソッドの詳細

getReferralContext

public abstract Context getReferralContext() throws NamingException

コントロールは使わずに、コンテキストの環境を使用してメソッドを継続する時点のコンテキストを検出します。 リフェラル・コンテキストは、ReferralExceptionをスローしたコンテキストの環境プロパティを使用して作成され、コントロールは使用されません。

このメソッドは、次と同等です。

 getReferralContext(ctx.getEnvironment(), null);

ctxは、ReferralException.をスローしたコンテキストです

このメソッドは、ドキュメントを目的とした場合に限り、このクラスでオーバーライドされます。 このメソッドの使用方法は、ReferralExceptionを参照してください。

定義:

getReferralContext、クラスReferralException

戻り値:

メソッドを継続する時点のnull以外のコンテキスト。

例外:

NamingException - ネーミング例外が検出された場合。 retryReferral()またはskipReferral()をコールして、リフェラル処理を続行します。

getReferralContext

public abstract Context getReferralContext(Hashtable<?,?> env) throws NamingException

コントロールは使用せずに、環境プロパティを使用してメソッドを継続する時点のコンテキストを検出します。 リフェラル・コンテキストは、環境プロパティとしてenvを使用して作成され、コントロールは使用されません。

このメソッドは、次と同等です。

 getReferralContext(env, null);

このメソッドは、ドキュメントを目的とした場合に限り、このクラスでオーバーライドされます。 このメソッドの使用方法は、ReferralExceptionを参照してください。

定義:

getReferralContext、クラスReferralException

パラメータ:

env - 参照コンテキストを取得するときに使用するnullの可能性がある環境。 nullの場合は、環境プロパティは使用されない。

戻り値:

メソッドを継続する時点のnull以外のコンテキスト。

例外:

NamingException - ネーミング例外が検出された場合。 retryReferral()またはskipReferral()をコールして、リフェラル処理を続行します。

getReferralContext

public abstract Context getReferralContext(Hashtable<?,?> env, Control[] reqCtls) throws NamingException

要求コントロールおよび環境プロパティを使用して、メソッドを継続する時点のコンテキストを取り出します。 参照の発生が、コンテキストの操作中直接であっても、間接的であっても、たとえば、検索列挙中でも、参照例外は操作を継続する時点のコンテキストを提供します。 操作を継続するには、クライアント・プログラムで、元の呼び出しと同じ引数を使用するメソッドを再度呼び出します。

reqCtlsは、参照されるサーバーへの接続を作成するときに使用されます。 これらのコントロールは、コンテキストから導出されたコンテキストおよびコンテキスト・インスタンスの接続リクエスト・コントロールとして使用されます。reqCtlsは、後続のコンテキスト操作に対するコンテキストのリクエスト・コントロールにもなります。 詳細は、LdapContextクラスの説明を参照してください。

呼出し側が参照コンテキスト作成のために要求コントロールを指定する必要があるときは、オーバーロードされたほかの2つの形式ではなく、このメソッドを使用します。 認証に関する特定のコントロールを指定しなければならない場合などに使用します。

サービス・プロバイダ実装者は、実装の詳細について、LdapContextクラス説明の"サービス・プロバイダ"セクションを読み取る必要があります。

パラメータ:

env - 新しいコンテキストの場合に使用するnullの可能性がある環境プロパティ。 nullの場合は、コンテキストが環境プロパティを使って初期化されていない。

reqCtls - 新しいコンテキストに使用するnullの可能性がある要求コントロール。 nullまたは空の配列の場合は、要求コントロールを使用していないことを示す。

戻り値:

メソッドを継続する時点のnull以外のコンテキスト。

例外:

NamingException - ネーミング例外が検出された場合。 retryReferral()またはskipReferral()をコールして、リフェラル処理を続行します。