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 搜尋一級命名物件。
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 以毫秒為單位的時間限制。

從類別 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 將包含一個或零個元素。如果命名的物件符合 search() 中指定的搜尋過濾器，則列舉包含一個元素。元素中的名稱將是一個空字元串，因為 NamingEnumeration 中的元素名稱是相對於目標上下文的，在此情況下，目標上下文就是命名的物件。如果命名物件不符合 search() 中指定的搜尋過濾器，則其包含零個元素。

此常數的值為 0。

另請參見：

常數欄位值

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

搜尋一級命名物件。

從使用 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()

使用預設值建構搜尋約束。

預設值為：

• 搜尋一級
• 搜尋結果不存在最大返回數限制
• 搜尋不存在時間限制
• 返回所有符合搜尋過濾器的與物件關聯的屬性
• 不返回命名物件（僅返回名稱和類別）
• 在搜尋期間不取消對連接的參考

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 之一。

返回：

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