JavaTM 2 Platform
Standard Ed. 6

javax.naming.ldap
類別 PagedResultsResponseControl

java.lang.Object
  繼承者 javax.naming.ldap.BasicControl
      繼承者 javax.naming.ldap.PagedResultsResponseControl
所有已實作的介面:
Serializable, Control

public final class PagedResultsResponseControl
extends BasicControl

指示一批搜尋結果的末尾。包含結果集中總項數的估計值和一個不透明 cookie。必須將 cookie 提供給下一個搜尋操作,這樣才能獲取下一批的結果。

PagedResultsControl 中的程式碼範例展示了使用此類別的方式。

此類別實作在 RFC 2696 中定義的分頁結果的 LDAPv3 回應控制元件。 控制元件值具有以下 ASN.1 定義:


     realSearchControlValue ::= SEQUENCE {
         size      INTEGER (0..maxInt),
                           -- requested page size from client
                           -- result set size estimate from server
         cookie    OCTET STRING
     }

 

從以下版本開始:
1.5
另請參見:
PagedResultsControl, 序列化表格

欄位摘要
static String OID
          分頁結果回應控制元件的分派物件標識符為 1.2.840.113556.1.4.319。
 
從類別 javax.naming.ldap.BasicControl 繼承的欄位
criticality, id, value
 
從介面 javax.naming.ldap.Control 繼承的欄位
CRITICAL, NONCRITICAL
 
建構子摘要
PagedResultsResponseControl(String id, boolean criticality, byte[] value)
          建構分頁結果回應控制元件。
 
方法摘要
 byte[] getCookie()
          檢索伺服器產生的 cookie。
 int getResultSize()
          檢索搜尋結果中的項數(估計值)。
 
從類別 javax.naming.ldap.BasicControl 繼承的方法
getEncodedValue, getID, isCritical
 
從類別 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

欄位詳細資訊

OID

public static final String OID
分頁結果回應控制元件的分派物件標識符為 1.2.840.113556.1.4.319。

另請參見:
常數欄位值
建構子詳細資訊

PagedResultsResponseControl

public PagedResultsResponseControl(String id,
                                   boolean criticality,
                                   byte[] value)
                            throws IOException
建構分頁結果回應控制元件。

參數:
id - 控制元件的物件標識符字元串。
criticality - 控制元件的關鍵性。
value - 控制元件的 ASN.1 BER 編碼值。它不是副本,對值進行的任何更改都將影響控制元件的內容。
拋出:
IOException - 如果在解碼控制元件值時遇到錯誤。
方法詳細資訊

getResultSize

public int getResultSize()
檢索搜尋結果中的項數(估計值)。

返回:
搜尋結果中的項數;如果未知,則為零。

getCookie

public byte[] getCookie()
檢索伺服器產生的 cookie。當不再有供伺服器返回的項時,返回 null。

返回:
伺服器產生 cookie(可能為 null)。它不是副本,對 cookie 進行的任何更改都將更新控制元件的狀態,因此不建議進行更改操作。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only