compact3

javax.naming.ldap

Class PagedResultsControl

java.lang.Object

javax.naming.ldap.BasicControl

javax.naming.ldap.PagedResultsControl

All Implemented Interfaces:

Serializable ， Control

public final class PagedResultsControl
extends BasicControl

请求LDAP服务器以指定大小的批量返回搜索操作的结果。 请求者按照调用搜索操作的速率来控制批次返回的速率。

以下代码示例显示了如何使用类：

   // Open an LDAP association LdapContext ctx = new InitialLdapContext(); // Activate paged results int pageSize = 20; // 20 entries per page byte[] cookie = null; int total; ctx.setRequestControls(new Control[]{ new PagedResultsControl(pageSize, Control.CRITICAL) }); do { // Perform the search NamingEnumeration results = ctx.search("", "(objectclass=*)", new SearchControls()); // Iterate over a batch of search results while (results != null && results.hasMore()) { // Display an entry SearchResult entry = (SearchResult)results.next(); System.out.println(entry.getName()); System.out.println(entry.getAttributes()); // Handle the entry's response controls (if any) if (entry instanceof HasControls) { // ((HasControls)entry).getControls(); } } // Examine the paged results control response Control[] controls = ctx.getResponseControls(); if (controls != null) { for (int i = 0; i < controls.length; i++) { if (controls[i] instanceof PagedResultsResponseControl) { PagedResultsResponseControl prrc = (PagedResultsResponseControl)controls[i]; total = prrc.getResultSize(); cookie = prrc.getCookie(); } else { // Handle other response controls (if any) } } } // Re-activate paged results ctx.setRequestControls(new Control[]{ new PagedResultsControl(pageSize, cookie, Control.CRITICAL) }); } while (cookie != null); // Close the LDAP association ctx.close(); ...  

此类实现中定义为分页结果的LDAPv3的控制RFC 2696 。 控件的值具有以下ASN.1定义：

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

从以下版本开始：

1.5

另请参见：

PagedResultsResponseControl ， Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	OID 分页结果控件的分配对象标识符为1.2.840.113556.1.4.319。

Fields inherited from class javax.naming.ldap.BasicControl

criticality, id, value

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

构造方法摘要

构造方法

Constructor and Description
PagedResultsControl(int pageSize, boolean criticality) 构造一个控件以设置每页结果返回的条目数。
PagedResultsControl(int pageSize, byte[] cookie, boolean criticality) 构造一个控件以设置每页结果返回的条目数。

方法摘要

Methods inherited from class javax.naming.ldap.BasicControl

getEncodedValue, getID, isCritical

Methods inherited from class 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。

另请参见：

Constant Field Values

构造方法详细信息

PagedResultsControl

public PagedResultsControl(int pageSize,
                           boolean criticality)
                    throws IOException

构造一个控件以设置每页结果返回的条目数。

参数

pageSize - 页面中要返回的条目数。

criticality - 如果为true，则服务器必须遵守由pageSize所指示的控制并返回搜索结果，否则拒绝执行搜索。 如果是虚假的，那么服务器不需要尊重控制权。

异常

IOException - 如果在将所提供的参数编码到控件中时遇到错误。

PagedResultsControl

public PagedResultsControl(int pageSize,
                           byte[] cookie,
                           boolean criticality)
                    throws IOException

构造一个控件以设置每页结果返回的条目数。 cookie由服务器提供，可以从分页结果响应控件获取。

通过将pageSize设置为零并将cookie设置为从服务器接收的最后一个cookie，可以放弃一系列分页结果。

参数

pageSize - 页面返回的条目数。

cookie - 可能为空的服务器生成的cookie。

criticality - 如果为true，则服务器必须遵守由pageSize所指示的控制和返回搜索结果，否则拒绝执行搜索。 如果是虚假的，那么服务器不需要尊重控制权。

异常

IOException - 如果在将所提供的参数编码到控件中时遇到错误。