javax.naming.spi

インタフェース DirStateFactory

すべてのスーパーインタフェース:

StateFactory

public interface DirStateFactory
extends StateFactory

このインタフェースは、オブジェクトと該当属性とのバインディングの状態を取得するファクトリを表します。

JNDI フレームワークでは、オブジェクトファクトリを使用してオブジェクト実装を動的にロードできます。

DirStateFactory は StateFactory を拡張して、getStateToBind() メソッドが Attributes インスタンスを指定して返すことができるようします。DirStateFactory 実装は DirContext サービスプロバイダが使用するものです。呼び出し側が DirContext.bind() を使ってオブジェクトをバインドするとき、属性のセットもそのオブジェクトにバインドされるよう指定できます。バインドされるオブジェクトと属性は、ファクトリの getStateToBind() メソッドに渡されます。ファクトリは、オブジェクトと属性を処理する場合はバインドされるオブジェクトと属性の該当ペアを返します。オブジェクトを処理しない場合、ファクトリは null を返す必要があります。

たとえば、呼び出し側がプリンタオブジェクトをプリンタ関連の属性とバインドすることがあります。

 ctx.rebind("inky", printer, printerAttrs);

ctx の LDAP サービスプロバイダは (DirectoryManager.getStateToBind() を使って間接的に) DirStateFactory を使用して、DirStateFactory に printer および printerAttrs を指定します。LDAP ディレクトリのファクトリは printer を属性のセットに変え、それを printerAttrs とマージします。続いてサービスプロバイダがその属性を使って LDAP エントリを生成し、ディレクトリを更新します。

DirStateFactory は StateFactory を拡張するので、2 つの getStateToBind() メソッドを持ちます。この 2 つのメソッドは属性引数が異なります。DirectoryManager.getStateToBind() は属性引数を受け入れる形式だけを使用し、NamingManager.getStateToBind() は属性引数を受け入れない形式だけを使用します。

DirStateFactory の getStateToBind() メソッドのどちらかの形式が、異なるパラメータを使って複数回呼び出されることがあります。実装はスレッドセーフです。

導入されたバージョン:

1.3

関連項目:

DirectoryManager.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>, javax.naming.directory.Attributes), DirObjectFactory

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェースと説明
static class	DirStateFactory.Result DirStateFactory.getStateToBind() の結果を返す、オブジェクトと属性のペアです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
DirStateFactory.Result	getStateToBind(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment, Attributes inAttrs) 変換対象のオブジェクトおよび属性を、バインディングするためにオブジェクトの状態を取得します。

インタフェース javax.naming.spi.StateFactory から継承されたメソッド

getStateToBind

メソッドの詳細

getStateToBind

DirStateFactory.Result getStateToBind(Object obj,
                                    Name name,
                                    Context nameCtx,
                                    Hashtable<?,?> environment,
                                    Attributes inAttrs)
                                      throws NamingException

変換対象のオブジェクトおよび属性を、バインディングするためにオブジェクトの状態を取得します。

DirectoryManager.getStateToBind() は、状態ファクトリに連続的にロードします。ファクトリが DirStateFactory を実装していれば、DirectoryManager はこのメソッドを呼び出します。そうでない場合は StateFactory.getStateToBind() を呼び出します。これは、ファクトリが null 以外の答えを生成するまで行われます。

ファクトリが例外をスローすると、その例外は DirectoryManager.getStateToBind() の呼び出し側に渡されます。null 以外の答えを生成する可能性のあるほかのファクトリの検索は停止します。ファクトリは、それが目的の唯一のファクトリであり、ほかのファクトリを検索する必要がないことが確実な場合にのみ、例外をスローするようにします。このファクトリが指定された引数でオブジェクトを生成できない場合は、null を返します。

作成されるオブジェクトの名前を指定するために、必要に応じて name パラメータや nameCtx パラメータを使用できます。詳細は、ObjectFactory.getObjectInstance() にある「名前パラメータとコンテキストパラメータ」の説明を参照してください。コンテキスト実装はスレッドセーフであることが保証されないため、nameCtx を使用する場合、ファクトリはその使用を並行アクセスに対して同期化するようにします。

name、inAttrs、および environment の各パラメータは、呼び出し側が所有します。実装はこれらのオブジェクトを変更せず、そのオブジェクトに対する参照も保持しませんが、複製またはコピーに対する参照を保持することがあります。このメソッドが返すオブジェクトは呼び出し側が所有します。実装は続いてこれを変更しません。実装には、呼び出し側が所有するのと同じ新しい Attributes オブジェクトか、あるいは元の inAttrs パラメータへの参照が含まれます。

パラメータ:

obj - 状態を取得する、null の可能性があるオブジェクト。

name - nameCtx を基準にしたこのオブジェクトの名前、または名前が指定されていない場合は null。

nameCtx - name パラメータが基準にして指定されているコンテキスト、または name がデフォルトの初期コンテキストを基準にしている場合は null。

environment - オブジェクトの状態の作成で使用される null の可能性がある環境。

inAttrs - オブジェクトにバインドされる、null の可能性がある属性。ファクトリは inAttrs を変更できない。

戻り値:

オブジェクトのバインディングの状態およびバインドされる該当の属性を含む Result オブジェクトがこのファクトリを使用しない場合は null。

例外:

NamingException - オブジェクトの状態を取得しようとしているときにこのファクトリが例外を検出し、ほかのファクトリが試行されない場合。

関連項目:

DirectoryManager.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>, javax.naming.directory.Attributes)