Java 2 Platform SE 1.3: クラス DirectoryManager

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Std. Ed. v1.3

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.naming.spi
クラス DirectoryManager

java.lang.Object
  |
  +--javax.naming.spi.NamingManager
        |
        +--javax.naming.spi.DirectoryManager

public class DirectoryManager
extends NamingManager

このクラスは、DirContext 実装をサポートするメソッドを格納します。

このクラスは NamingManager を拡張したものです。サービスプロバイダがオブジェクトファクトリおよび状態ファクトリにアクセスするとき、および連合をサポートする継続コンテキストを取得するときに使用するメソッドを格納します。

DirectoryManager は、複数のスレッドによる並行アクセスでもセキュリティ上安全です。

別途注釈のある場合を除いて、Name、Attributes、またはメソッドに渡される環境パラメータは、呼び出し側が所有します。実装ではオブジェクトを変更せず、そのオブジェクトに対する参照も保持しませんが、複製またはコピーに対する参照を保持することがあります。

導入されたバージョン:: 1.3
関連項目:: DirObjectFactory, DirStateFactory

クラス javax.naming.spi.NamingManager から継承したフィールド

CPE

メソッドの概要

static DirContext getContinuationDirContext(CannotProceedException cpe)
          DirContext 操作を継続するコンテキストを生成します。

static Object getObjectInstance(Object refInfo, Name name, Context nameCtx, Hashtable environment, Attributes attrs)
          指定されたオブジェクト、属性、および環境にオブジェクトのインスタンスを生成します。

static DirStateFactory.Result getStateToBind(Object obj, Name name, Context nameCtx, Hashtable environment, Attributes attrs)
          元のオブジェクトおよびその属性が指定されたときに、オブジェクトのバインディングの状態を取得します。

クラス javax.naming.spi.NamingManager から継承したメソッド

getContinuationContext, getInitialContext, getObjectInstance, getStateToBind, getURLContext, hasInitialContextFactoryBuilder, setInitialContextFactoryBuilder, setObjectFactoryBuilder

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

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

メソッドの詳細

getContinuationDirContext

public static DirContext getContinuationDirContext(CannotProceedException cpe)
                                            throws NamingException

DirContext 操作を継続するコンテキストを生成します。NamingManager.getContinuationContext() と同じように動作します。返される継続コンテキストは DirContext だけです。

パラメータ:: cpe - この継続をトリガーした null 以外の例外
戻り値:: 操作を継続する null 以外の DirContext オブジェクト
例外:: NamingException - ネーミング例外が発生した場合
関連項目:: NamingManager.getContinuationContext(CannotProceedException)

getObjectInstance

public static Object getObjectInstance(Object refInfo,
                                       Name name,
                                       Context nameCtx,
                                       Hashtable environment,
                                       Attributes attrs)
                                throws Exception

指定されたオブジェクト、属性、および環境にオブジェクトのインスタンスを生成します。

このメソッドは NamingManager.getObjectInstance とほぼ同じですが、以下の点が違います。

オブジェクトに関連した属性を含む Attributes パラメータを受け入れる。DirObjectFactory はこれらの属性を使って、ディレクトリからこれらの属性を検索する手間を省く
試行するオブジェクトファクトリは、ObjectFactory または DirObjectFactory を実装する必要がある。DirObjectFactory を実装している場合は DirObjectFactory.getObjectInstance() が使用される。その他の場合は ObjectFactory.getObjectInstance() が使用される

NamingManager.getObjectInstance() インタフェースではなく DirContext インタフェースを実装しているサービスプロバイダがこのメソッドを使います。

パラメータ:: refInfo - null の可能性がある、オブジェクト生成対象のオブジェクト; name - nameCtx に関連するこのオブジェクトの名前。名前の指定は任意。省略する場合、name は null; nameCtx - name パラメータの指定に関連するコンテキスト。null の場合、name はデフォルトの初期コンテキストに関連する; environment - オブジェクトおよびオブジェクトファクトリの生成に使用される、null の可能性がある環境; attrs - null の可能性がある、refInfo に関連した属性。これは refInfo の完全属性セットではない場合がある。ディレクトリからさらに属性を読み込めることがある
戻り値:: refInfo および attrs を使って生成された属性、またはファクトリがオブジェクトを生成できない場合は refInfo
例外:: NamingException - URL コンテキストを取得するときにネーミング例外が見つかった場合、またはアクセスしたファクトリの 1 つが NamingException をスローした場合; Exception - アクセスしたファクトリの 1 つが例外をスローした場合、またはファクトリおよびオブジェクトクラスのロードおよびインスタンス化中にエラーが見つかった場合。ファクトリは、オブジェクト生成に他のファクトリを使用したくない場合に限り例外をスローするようにする。DirObjectFactory.getObjectInstance() を参照
導入されたバージョン:: 1.3
関連項目:: NamingManager.getURLContext(java.lang.String, java.util.Hashtable), DirObjectFactory, DirObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable, javax.naming.directory.Attributes)

getStateToBind

public static DirStateFactory.Result getStateToBind(Object obj,
                                                    Name name,
                                                    Context nameCtx,
                                                    Hashtable environment,
                                                    Attributes attrs)
                                             throws NamingException

元のオブジェクトおよびその属性が指定されたときに、オブジェクトのバインディングの状態を取得します。

このメソッドは NamingManager.getStateToBind に似ていますが、以下の点が違います。

DirContext.bind() メソッドに渡された属性を含む Attributes パラメータを受け入れる
バインドされるオブジェクトを含む null 以外の DirStateFactory.Result インスタンス、およびバインディングについてくる属性を返す。オブジェクトまたは属性のどちらかが null でもよい
試行する状態ファクトリはそれぞれ、StateFactory または DirStateFactory を実装する必要がある。DirStateFactory を実装している場合は DirStateFactory.getStateToBind() が呼び出される。その他の場合は StateFactory.getStateToBind() が呼び出される

NamingManager.getStateToBind() インタフェースではなく DirContext インタフェースを実装しているサービスプロバイダをこのメソッドに使います。

試行する状態ファクトリのリストを決定する方法の説明については、NamingManager.getStateToBind() を参照してください。

このメソッドによって返されるオブジェクトは呼び出し側が所有します。実装はその後このオブジェクトを変更しません。実装は、呼び出し側が所有するのと同じ新しい Attributes オブジェクトか、元の attrs パラメータへの参照のどちらかを含みます。

パラメータ:: obj - バインドする状態の取得対象となる null 以外のオブジェクト; name - nameCtx に関連するこのオブジェクトの名前、または名前を指定しない場合は null; nameCtx - name パラメータの指定に関連するコンテキスト、または name がデフォルトの初期コンテキストに関連する場合は null; environment - null の可能性がある、状態ファクトリおよびオブジェクトの状態の生成に使用される環境; attrs - null の可能性がある、オブジェクトにバインドされる Attribute
戻り値:: null 以外の DirStateFactory。結果にはバインドされるオブジェクトおよび属性を含む。null 以外の答を返す状態ファクトリがない場合、結果はオブジェクト (obj) 自体を元の属性とともに含む
例外:: NamingException - ファクトリを使用中にネーミング例外が見つかった場合。ファクトリは、オブジェクト生成に他のファクトリを使用したくない場合に限り例外をスローするようにする。DirStateFactory.getStateToBind() を参照
導入されたバージョン:: 1.3
関連項目:: DirStateFactory, DirStateFactory.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable, javax.naming.directory.Attributes), NamingManager.getStateToBind(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)

概要