javax.naming.directory
クラス SearchControls

java.lang.Object
  |
  +--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 のどれか 1 つに設定します。
void	setTimeLimit(int ms) これらの SearchControls の時間制限をミリ秒単位で設定します。

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

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

フィールドの詳細

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 のどれか 1 つ

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 のどれか 1 つに設定します。

パラメータ:

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()