- java.lang.Object
-
- javax.naming.ldap.BasicControl
-
- javax.naming.ldap.PagedResultsControl
-
- 实现的所有接口
-
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
-
-
字段汇总
字段 变量和类型 字段 描述 static String
OID
分页结果控件的分配对象标识符是1.2.840.113556.1.4.319。-
声明的属性在类 javax.naming.ldap.BasicControl
criticality, id, value
-
Fields declared in interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
-
-
构造方法摘要
构造方法 构造器 描述 PagedResultsControl(int pageSize, boolean criticality)
构造一个控件以设置每页结果返回的条目数。PagedResultsControl(int pageSize, byte[] cookie, boolean criticality)
构造一个控件以设置每页结果返回的条目数。
-
-
-
构造方法详细信息
-
PagedResultsControl
public PagedResultsControl(int pageSize, boolean criticality) throws IOException
构造一个控件以设置每页结果返回的条目数。- 参数
-
pageSize
- 页面中要返回的条目数。 -
criticality
- 如果为true,则服务器必须遵守控制并返回pageSize指示的搜索结果或拒绝执行搜索。 如果为false,则服务器不需要遵守控件。 - 异常
-
IOException
- 如果在将提供的参数编码到控件中时遇到错误。
-
PagedResultsControl
public PagedResultsControl(int pageSize, byte[] cookie, boolean criticality) throws IOException
构造一个控件以设置每页结果返回的条目数。 cookie由服务器提供,并且可以从分页结果响应控件获得。通过将pageSize设置为零并将cookie设置为从服务器接收的最后一个cookie,可以放弃一系列分页结果。
- 参数
-
pageSize
- 页面中要返回的条目数。 -
cookie
- 可能为null的服务器生成的cookie。 -
criticality
- 如果为true,则服务器必须遵守控制并返回pageSize指示的搜索结果或拒绝执行搜索。 如果为false,则服务器不需要遵守控件。 - 异常
-
IOException
- 如果在将提供的参数编码到控件中时遇到错误。
-
-