javax.naming.ldap.LdapReferralException

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

public abstract class LdapReferralException extends ReferralException

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

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

導入されたバージョン:

1.3

関連項目:

フィールドのサマリー

クラスで宣言されたフィールド NamingException
remainingName, resolvedName, resolvedObj, rootException

修飾子と型

フィールド

説明

protected Name

remainingName

未解決の残りの名前を含みます。

protected Name

resolvedName

正常に解決された名前の部分を含みます。

protected Object

resolvedObj

名前の部分が正常に解決されたオブジェクトを含みます。

protected Throwable

rootException

このNamingExceptionがスローされる原因となった元の例外を含みます。
コンストラクタのサマリー

コンストラクタ

修飾子

コンストラクタ

説明

protected

LdapReferralException()

LdapReferralExceptionのインスタンスを新しく構築します。

protected

LdapReferralException(String explanation)

指定された説明を使用して、LdapReferralExceptionのインスタンスを新たに構築します。
メソッドのサマリー

修飾子と型

メソッド

説明

abstract Context

getReferralContext()

コントロールは使わずに、コンテキストの環境を使用してメソッドを継続する時点のコンテキストを検出します。

abstract Context

getReferralContext(Hashtable<?,?> env)

コントロールは使用せずに、環境プロパティを使用してメソッドを継続する時点のコンテキストを検出します。

abstract Context

getReferralContext(Hashtable<?,?> env, Control[] reqCtls)

要求コントロールおよび環境プロパティを使用して、メソッドを継続する時点のコンテキストを取り出します。

クラスで宣言されたメソッド ReferralException
getReferralInfo, retryReferral, skipReferral

修飾子と型

メソッド

説明

abstract Object

getReferralInfo()

この参照に関連する情報(URLなど)を取り出します。

abstract void

retryReferral()

現在処理中の参照を取り出します。

abstract boolean

skipReferral()

処理される参照を破棄します。

クラスで宣言されたメソッド NamingException
appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

修飾子と型

メソッド

説明

void

appendRemainingComponent(String name)

残りの名前の最後のコンポーネントとして名前を追加します。

void

appendRemainingName(Name name)

残りの名前の最後のコンポーネントとして「名前」からコンポーネントを追加します。

Throwable

getCause()

この例外の原因を返します。

String

getExplanation()

この例外に関連した説明を取得します。

Name

getRemainingName()

名前の残りの未解決部分を取得します。

Name

getResolvedName()

正常に解決された名前の先頭部分を取得します。

Object

getResolvedObj()

正常に解決されたオブジェクトを取得します。

Throwable

getRootCause()

このNamingExceptionの根本原因がある場合は、その根本原因を取得します。

Throwable

initCause(Throwable cause)

この例外の原因を、指定された値に初期化します。

void

setRemainingName(Name name)

この例外の残りの名前フィールドを設定します。

void

setResolvedName(Name name)

この例外の「resolvedName」フィールドを設定します。

void

setResolvedObj(Object obj)

この例外の「解決されたオブジェクト」フィールドを設定します。

void

setRootCause(Throwable e)

このNamingExceptionの根本原因を記録します。

String

toString()

この例外の文字列表現が生成されます。

String

toString(boolean detail)

より詳細な文字列表現が生成されます。

Throwableクラスで宣言されたメソッド
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

修飾子と型

メソッド

説明

final void

addSuppressed(Throwable exception)

この例外を提供する目的で抑制された例外に、指定された例外を追加します。

Throwable

fillInStackTrace()

実行スタック・トレースを埋め込みます。

String

getLocalizedMessage()

このスロー可能オブジェクトの、ローカライズされた記述を作成します。

String

getMessage()

このスロー可能オブジェクトの詳細メッセージ文字列を返します。

StackTraceElement[]

getStackTrace()

Throwable.printStackTrace()によって出力されるスタック・トレース情報にプログラムでアクセスできるようにします。

final Throwable[]

getSuppressed()

この例外を提供する目的で(通常try-with-resources文によって)抑制された例外をすべて含む配列を返します。

void

printStackTrace()

このスロー可能オブジェクトおよびそのバックトレースを標準エラー・ストリームに出力します。

void

printStackTrace(PrintStream s)

このスロー可能オブジェクトとそのバックトレースを指定された印刷ストリームに出力します。

void

printStackTrace(PrintWriter s)

このスロー可能オブジェクトとそのバックトレースを指定されたプリント・ライターに出力します。

void

setStackTrace(StackTraceElement[] stackTrace)

Throwable.getStackTrace()によって返され、Throwable.printStackTrace()と関連メソッドによって出力される、スタック・トレース要素を設定します。

クラスオブジェクトで宣言されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

修飾子と型

メソッド

説明

protected Object

clone()

このオブジェクトのコピーを作成して、返します。

boolean

equals(Object obj)

このオブジェクトと他のオブジェクトが等しいかどうかを示します。

protected void

finalize()

削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
最終決定は非推奨であり、将来のリリースで削除される可能性があります。

final Class<?>

getClass()

このObjectの実行時クラスを返します。

int

hashCode()

このオブジェクトに対するハッシュ・コード値を返します。

final void

notify()

このオブジェクトのモニターで待機中のスレッドを1つ再開します。

final void

notifyAll()

このオブジェクトのモニターで待機中のすべてのスレッドを再開します。

final void

wait()

現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。

final void

wait(long timeoutMillis)

現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

final void

wait(long timeoutMillis, int nanos)

現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

コンストラクタの詳細
- 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()をコールして、リフェラル処理を続行します。

クラスLdapReferralException

フィールドのサマリー

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

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

メソッドのサマリー

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

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

Throwableクラスで宣言されたメソッド

クラスオブジェクトで宣言されたメソッド

コンストラクタの詳細

LdapReferralException

LdapReferralException

メソッドの詳細

getReferralContext

getReferralContext

getReferralContext