PagedResultsResponseControl (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • javax.naming.ldap.BasicControl
  • • javax.naming.ldap.PagedResultsResponseControl

• All Implemented Interfaces:
  [Serializable](../../../../java.base/java/io/Serializable.html "interface in java.io"), [Control](Control.html "interface in javax.naming.ldap")

public final class PagedResultsResponseControl
extends BasicControl
Indicates the end of a batch of search results. Contains an estimate of the total number of entries in the result set and an opaque cookie. The cookie must be supplied to the next search operation in order to get the next batch of results.
The code sample in PagedResultsControl shows how this class may be used.
This class implements the LDAPv3 Response Control for paged-results as defined inRFC 2696. The control's value has the following ASN.1 definition:
realSearchControlValue ::= SEQUENCE {
size INTEGER (0..maxInt),
-- requested page size from client
-- result set size estimate from server
cookie OCTET STRING
}
Since:
1.5
See Also:
PagedResultsControl, Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static String	OID	The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.

     * ### Fields declared in class javax.naming.ldap.[BasicControl](BasicControl.html "class in javax.naming.ldap")  
     `[criticality](BasicControl.html#criticality), [id](BasicControl.html#id), [value](BasicControl.html#value)`  
     * ### Fields declared in interface javax.naming.ldap.[Control](Control.html "interface in javax.naming.ldap")  
     `[CRITICAL](Control.html#CRITICAL), [NONCRITICAL](Control.html#NONCRITICAL)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  PagedResultsResponseControl​(String id, boolean criticality, byte[] value)	Constructs a paged-results response control.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  byte[]	getCookie()	Retrieves the server-generated cookie.
  int	getResultSize()	Retrieves (an estimate of) the number of entries in the search result.

     * ### Methods declared in class javax.naming.ldap.[BasicControl](BasicControl.html "class in javax.naming.ldap")  
     `[getEncodedValue](BasicControl.html#getEncodedValue%28%29), [getID](BasicControl.html#getID%28%29), [isCritical](BasicControl.html#isCritical%28%29)`  
     * ### Methods declared in class java.lang.[Object](../../../../java.base/java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)`

• • Field Detail

     * #### OID  
     public static final [String](../../../../java.base/java/lang/String.html "class in java.lang") OID  
     The paged-results response control's assigned object identifier is 1.2.840.113556.1.4.319.  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.naming.ldap.PagedResultsResponseControl.OID)  

  • Constructor Detail

    * #### PagedResultsResponseControl  
    public PagedResultsResponseControl​([String](../../../../java.base/java/lang/String.html "class in java.lang") id,  
                                       boolean criticality,  
                                       byte[] value)  
                                throws [IOException](../../../../java.base/java/io/IOException.html "class in java.io")  
    Constructs a paged-results response control.  
    Parameters:  
    `id` \- The control's object identifier string.  
    `criticality` \- The control's criticality.  
    `value` \- The control's ASN.1 BER encoded value. It is not cloned - any changes to value will affect the contents of the control.  
    Throws:  
    `[IOException](../../../../java.base/java/io/IOException.html "class in java.io")` \- If an error was encountered while decoding the control's value.  

  • Method Detail

    * #### getResultSize  
    public int getResultSize()  
    Retrieves (an estimate of) the number of entries in the search result.  
    Returns:  
    The number of entries in the search result, or zero if unknown.  
    * #### getCookie  
    public byte[] getCookie()  
    Retrieves the server-generated cookie. Null is returned when there are no more entries for the server to return.  
    Returns:  
    A possibly null server-generated cookie. It is not cloned - any changes to the cookie will update the control's state and thus are not recommended.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.