モジュール java.naming
パッケージ javax.naming.directory

クラスSearchControls

  • すべての実装されたインタフェース:
    Serializable
    public class SearchControls
extends Object
implements Serializable
    このクラスは、検索の範囲を決定する要因、および検索の結果として返されたものをカプセル化します。

    SearchControlsインスタンスは、並行マルチスレッド・アクセスに対して同期化されません。 複数のスレッドが同じSearchControlsインスタンスにアクセスして変更しようとすると、オブジェクトはロックされます。

    導入されたバージョン:
    1.3
    関連項目:
    直列化された形式

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      static int OBJECT_SCOPE
      名前付きオブジェクトを検索します。
      static int ONELEVEL_SCOPE
      名前付きコンテキストの1つのレベルを検索します。
      static int SUBTREE_SCOPE
      その名前付きオブジェクトをルートとするサブツリー全体を検索します。

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

      コンストラクタ 
      コンストラクタ 説明
      SearchControls()
      デフォルトを使用して検索条件を構築します。
      SearchControls​(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)
      引数を使用して検索条件を構築します。

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      long getCountLimit()
      検索の結果として返されるエントリの最大数を取得します。
      boolean getDerefLinkFlag()
      検索中にリンクが間接参照されるかどうかを判定します。
      String[] getReturningAttributes()
      検索の一部として返される属性を取得します。
      boolean getReturningObjFlag()
      結果の一部としてオブジェクトが返されるかどうかを判定します。
      int getSearchScope()
      これらのSearchControlsの検索範囲を取得します。
      int getTimeLimit()
      これらのSearchControlsの時間制限をミリ秒単位で取得します。
      void setCountLimit​(long limit)
      検索の結果として返されるエントリの最大数を設定します。
      void setDerefLinkFlag​(boolean on)
      検索中のリンクへの間接参照を有効または無効にします。
      void setReturningAttributes​(String[] attrs)
      検索の一部として返される属性を指定します。
      void setReturningObjFlag​(boolean on)
      結果の一部としてオブジェクトを返すことを有効または無効にします。
      void setSearchScope​(int scope)
      検索範囲を次のいずれかに設定します。OBJECT_SCOPE、ONELEVEL_SCOPE、SUBTREE_SCOPE。
      void setTimeLimit​(int ms)
      これらのSearchControlsの時間制限をミリ秒単位で設定します。

    • フィールドの詳細

      • OBJECT_SCOPE

        public static final int OBJECT_SCOPE
        名前付きオブジェクトを検索します。

        OBJECT_SCOPEを使用して、search()によって生成されたNamingEnumerationには、1またはゼロの要素が含まれています。 search()で指定された検索フィルタを名前付きオブジェクトが満たしている場合、列挙の中に1つの要素が含まれます。 要素はその名前として空の文字列を持ちます。これはNamingEnumerationの要素の名前がターゲット・コンテキストに関連しているためで、この場合、ターゲット・コンテキストは名前付きオブジェクトです。 search()で指定された検索フィルタを名前付きオブジェクトが満たしていない場合、列挙の中に要素は含まれません。

        この定数の値は0です。

        関連項目:
        定数フィールド値

      • ONELEVEL_SCOPE

        public static final int ONELEVEL_SCOPE
        名前付きコンテキストの1つのレベルを検索します。

        ONELEVEL_SCOPEを使用して、search()によって生成されたNamingEnumerationには、search()で指定された検索フィルタを満たす名前付きコンテキストのオブジェクトを持つ要素が含まれています。 NamingEnumerationの要素の名前は、名前付きコンテキストに関連した原子名です。

        この定数の値は1です。

        関連項目:
        定数フィールド値

      • SUBTREE_SCOPE

        public static final int SUBTREE_SCOPE
        その名前付きオブジェクトをルートとするサブツリー全体を検索します。

        名前付きオブジェクトがDirContextでない場合は、オブジェクトしか検索しません。 名前付きオブジェクトがDirContextの場合は、名前付きオブジェクト自体を含めて、名前付きオブジェクトをルートとするサブツリーを検索します。

        検索はネーミング・システムの範囲内で行われます。

        SUBTREE_SCOPEを使用して、search()によって生成されたNamingEnumerationには、search()で指定された検索フィルタを満たすサブツリー(名前付きコンテキストを含む)のオブジェクトの要素が含まれています。 NamingEnumerationの要素の名前は、名前付きコンテキストに関連しているか、URL文字列であるかのどちらかです。 名前付きコンテキストが検索フィルタを満たしている場合、名前付きコンテキストは、名前として空の文字列を持つ列挙の中に含まれます。

        この定数の値は2です。

        関連項目:
        定数フィールド値

    • コンストラクタの詳細

      • SearchControls

        public SearchControls()
        デフォルトを使用して検索条件を構築します。

        デフォルトは次のとおりです。

        • 1つのレベルを検索
        • 返す検索結果の最大数に制限なし
        • 検索の時間制約なし
        • 検索フィルタを満たすオブジェクトに関連付けられている属性をすべて返す
        • 名前付きオブジェクトは返さない(名前とクラスしか返さない)
        • 検索中にリンクを間接参照しない

      • SearchControls

        public SearchControls​(int scope,
                      long countlim,
                      int timelim,
                      String[] attrs,
                      boolean retobj,
                      boolean deref)
        引数を使用して検索条件を構築します。
        パラメータ:
        scope - 検索範囲。 OBJECT_SCOPE、ONELEVEL_SCOPE、SUBTREE_SCOPEのうちのいずれか。
        timelim - 結果が返されるまでのミリ秒数。 0の場合、無制限。
        deref - trueの場合、検索中にリンクを間接参照する。
        countlim - 返すエントリの最大数。 0の場合、フィルタを満たすエントリをすべて返す。
        retobj - trueの場合、エントリの名前にバインドされたオブジェクトを返す。false場合、オブジェクトを返さない。
        attrs - エントリとともに返す属性の識別子。 nullの場合、すべての属性を返す。 空の場合、属性を返さない。

    • メソッドの詳細

      • getSearchScope

        public int getSearchScope()
        これらのSearchControlsの検索範囲を取得します。

        OBJECT_SCOPE、ONELEVEL_SCOPE、SUBTREE_SCOPEのどれか1つ。

        戻り値:
        このSearchControlsの検索範囲。
        関連項目:
        setSearchScope(int)

      • getTimeLimit

        public int getTimeLimit()
        これらのSearchControlsの時間制限をミリ秒単位で取得します。

        値が0の場合、無制限に待つことを意味します。

        戻り値:
        これらのSearchControlsのミリ秒単位の時間制限。
        関連項目:
        setTimeLimit(int)

      • getDerefLinkFlag

        public boolean getDerefLinkFlag()
        検索中にリンクが間接参照されるかどうかを判定します。
        戻り値:
        リンクが間接参照される場合はtrue、そうでない場合はfalse。
        関連項目:
        setDerefLinkFlag(boolean)

      • getReturningObjFlag

        public boolean getReturningObjFlag()
        結果の一部としてオブジェクトが返されるかどうかを判定します。
        戻り値:
        オブジェクトが返される場合はtrue、そうでない場合はfalse。
        関連項目:
        setReturningObjFlag(boolean)

      • getCountLimit

        public long getCountLimit()
        検索の結果として返されるエントリの最大数を取得します。

        0はすべてのエントリが返されることを示します。

        戻り値:
        返されるエントリの最大数。
        関連項目:
        setCountLimit(long)

      • getReturningAttributes

        public String[] getReturningAttributes()
        検索の一部として返される属性を取得します。

        nullの値はすべての属性が返されることを示します。 空の配列は属性が何も返されないことを示します。

        戻り値:
        返される属性を識別する属性IDの配列。 nullも可。
        関連項目:
        setReturningAttributes(java.lang.String[])

      • setSearchScope

        public void setSearchScope​(int scope)
        検索範囲を次のいずれかに設定します。OBJECT_SCOPE、ONELEVEL_SCOPE、SUBTREE_SCOPE。
        パラメータ:
        scope - このSearchControlsの検索範囲。
        関連項目:
        getSearchScope()

      • setTimeLimit

        public void setTimeLimit​(int ms)
        これらのSearchControlsの時間制限をミリ秒単位で設定します。

        値が0の場合、無制限に待つことを意味します。

        パラメータ:
        ms - これらのSearchControlsのミリ秒単位の時間制限。
        関連項目:
        getTimeLimit()

      • setDerefLinkFlag

        public void setDerefLinkFlag​(boolean on)
        検索中のリンクへの間接参照を有効または無効にします。
        パラメータ:
        on - リンクを逆参照する場合はtrue、そうでない場合はfalse。
        関連項目:
        getDerefLinkFlag()

      • setReturningObjFlag

        public void setReturningObjFlag​(boolean on)
        結果の一部としてオブジェクトを返すことを有効または無効にします。

        無効にした場合、オブジェクトの名前およびクラスだけが返されます。 有効にした場合、オブジェクトが返されます。

        パラメータ:
        on - trueの場合、オブジェクトが返される。falseの場合、オブジェクトは返されない。
        関連項目:
        getReturningObjFlag()

      • setCountLimit

        public void setCountLimit​(long limit)
        検索の結果として返されるエントリの最大数を設定します。

        0は制限がないことを示します。すべてのエントリが返されます。

        パラメータ:
        limit - 返されるエントリの最大数。
        関連項目:
        getCountLimit()

      • setReturningAttributes

        public void setReturningAttributes​(String[] attrs)
        検索の一部として返される属性を指定します。

        nullはすべての属性が返されることを示します。 空の配列は属性が何も返されないことを示します。

        パラメータ:
        attrs - 返される属性を識別する属性IDの配列。 nullも可。
        関連項目:
        getReturningAttributes()