javax.naming.ldap

クラス ControlFactory

java.lang.Object

javax.naming.ldap.ControlFactory

public abstract class ControlFactory
extends Object

この abstract クラスは、LDAPv3 コントロールの作成に使用するファクトリを表示します。LDAPv3 コントロールは RFC 2251 で定義されています。

サービスプロバイダが応答コントロールを受信すると、このプロバイダはコントロールファクトリを使って、特定または任意のコントロールクラスを返します。

導入されたバージョン:

1.3

関連項目:

Control

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

コンストラクタ

修飾子	コンストラクタと説明
protected	ControlFactory()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Control	getControlInstance(Control ctl) コントロールファクトリを使用するコントロールを作成します。
static Control	getControlInstance(Control ctl, Context ctx, Hashtable<?,?> env) 既知のコントロールファクトリを使用してコントロールを作成します。

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

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

コンストラクタの詳細

ControlFactory

protected ControlFactory()

メソッドの詳細

getControlInstance

public abstract Control getControlInstance(Control ctl)
                                    throws NamingException

コントロールファクトリを使用するコントロールを作成します。

このファクトリは、サービスプロバイダが、LDAP プロトコルから読み取るコントロールを特殊なコントロールクラスとして返すときに使用します。このメカニズムを使用しなければ、プロバイダは BER エンコード形式のデータだけを含むコントロールを返します。

一般に、ctl は、BER エンコードデータを含む基本的なコントロールです。ファクトリは、特殊なコントロールを実装するのに使用されますが、通常は、BER エンコードデータをデコードして、型保証された安全な方法で該当データにアクセスするメソッドを提供します。

たとえば、ファクトリは基本的なコントロールの BER エンコードデータを使用して VirtualListReplyControl のインスタンスを返す場合があります。

このファクトリが指定引数を使ってコントロールを作成できない場合、null を返します。例外がスローされるのは、このコントロールファクトリだけが使用され、ほかのコントロールファクトリが使用されないときだけです。コントロールの BER データが、指定された OID を持つとみなされているコントロールと一致しない場合に、例外がスローされます。このメソッドは NamingException をスローするため、内部的に生成される例外を伝達する必要がある場合は、NamingException にラップする必要があります。

パラメータ:

ctl - null 以外のコントロール。

戻り値:

null の可能性のあるコントロール。

例外:

NamingException - ctl が、コントロールの作成に使用できなくなる無効なデータを含んでいる場合。OID によって識別されるコントロールを生成できる場合、ファクトリは例外だけをスローするが、無効な BER データなどがあればスローできない。

getControlInstance

public static Control getControlInstance(Control ctl,
                         Context ctx,
                         Hashtable<?,?> env)
                                  throws NamingException

既知のコントロールファクトリを使用してコントロールを作成します。

コントロールを作成するには、次の規則が使用されます。

• 環境の LdapContext.CONTROL_FACTORIES プロパティーに指定されたコントロールファクトリを使用してから、ctx に関連付けられているプロバイダリソースファイルの同一プロパティーに指定されたコントロールファクトリを使用する。このプロパティーの値は、コロンで区切られたファクトリクラス名のリストである。ファクトリクラスは、リストに指定された順番に使用される。コントロールの作成に最初に成功したファクトリが実際に使用される。どのファクトリもロードできない場合は、ctl を返す。コントロール作成中に、例外が発生したら、例外は呼び出し側に引き渡される。

コントロールファクトリは public ですが、また引数を取らない public コンストラクタを持つ必要があります。

パラメータ:

ctl - OID および BER データを含む null 以外のコントロールオブジェクト。

ctx - コントロールが作成される null の可能性があるコンテキスト。null の場合は、この情報は利用できない。

env - null の可能性のあるコンテキスト環境。LdapContext.CONTROL_FACTORIES プロパティーの値を検索するのに使用される。

戻り値:

ctl を使って生成されたコントロールオブジェクト、または上記のアルゴリズムを使ってコントロールオブジェクトを生成できない場合は ctl。

例外:

NamingException - ネーミング例外が、コントロールオブジェクトを作成しようとするときに発生した場合。アクセスされたファクトリの 1 つが例外をスローすると、その例外は呼び出し側に送られる。ファクトリおよびオブジェクトクラスのロード中またはインスタンス生成中にエラーが発生すると、その例外は NamingException の内部にラップされてから再度スローされる。