Package org.apache.directory.api.ldap.model.message.controls

Interface PagedResults

  • All Superinterfaces:
    Control
    All Known Implementing Classes:
    PagedResultsImpl
    public interface PagedResults
extends Control
    A request/response control used to implement a simple paging of search results. This is an implementation of RFC 2696 : LDAP Control Extension for Simple Paged Results Manipulation 
        This control is included in the searchRequest and searchResultDone
    messages as part of the controls field of the LDAPMessage, as defined
    in Section 4.1.12 of [LDAPv3]. The structure of this control is as
    follows:

 pagedResultsControl ::= SEQUENCE {
         controlType     1.2.840.113556.1.4.319,
         criticality     BOOLEAN DEFAULT FALSE,
         controlValue    searchControlValue
 }

 The searchControlValue is an OCTET STRING wrapping the BER-encoded
 version of the following SEQUENCE:

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

    • Method Detail

      • getSize

        int getSize()
        Returns:
        The requested or returned number of entries

      • setSize

        void setSize​(int size)
        Set the number of entry requested or returned
        Parameters:
        size - The number of entries

      • getCookie

        byte[] getCookie()
        Returns:
        The stored cookie

      • setCookie

        void setCookie​(byte[] cookie)
        Set the cookie
        Parameters:
        cookie - The cookie to store in this control

      • getCookieValue

        int getCookieValue()
        This method is ApacheDS specific, do not use for other LDAP servers.
        Returns:
        The integer value for the current cookie