Package org.springframework.ldap.control

Class PagedResultsRequestControl

  • All Implemented Interfaces:
    DirContextProcessor
    public class PagedResultsRequestControl
extends AbstractRequestControlDirContextProcessor
    Deprecated.
    Use PagedResultsDirContextProcessor instead.
    DirContextProcessor implementation for managing the paged results control. Note that due to the internal workings of LdapTemplate, the target connection is closed after each LDAP call. The PagedResults control require the same connection be used for each call, which means we need to make sure the target connection is never actually closed. There's basically two ways of making this happen: use the SingleContextSource implementation or make sure all calls happen within a single LDAP transaction (using ContextSourceTransactionManager).

    • Constructor Detail

      • PagedResultsRequestControl

        public PagedResultsRequestControl​(int pageSize)
        Deprecated.
        Constructs a new instance. This constructor should be used when performing the first paged search operation, when no other results have been retrieved.
        Parameters:
        pageSize - the page size.

      • PagedResultsRequestControl

        public PagedResultsRequestControl​(int pageSize,
                                  PagedResultsCookie cookie)
        Deprecated.
        Constructs a new instance with the supplied page size and cookie. The cookie must be the exact same instance as received from a previous paged resullts search, or null if it is the first in an operation sequence.
        Parameters:
        pageSize - the page size.
        cookie - the cookie, as received from a previous search.

    • Method Detail

      • getCookie

        public PagedResultsCookie getCookie()
        Deprecated.
        Get the cookie.
        Returns:
        the cookie.

      • getPageSize

        public int getPageSize()
        Deprecated.
        Get the page size.
        Returns:
        the page size.

      • getResultSize

        public int getResultSize()
        Deprecated.
        Get the total estimated number of entries that matches the issued search. Note that this value is optional for the LDAP server to return, so it does not always contain any valid data.
        Returns:
        the estimated result size, if returned from the server.

      • setResponseControlClass

        public void setResponseControlClass​(java.lang.Class responseControlClass)
        Deprecated.
        Set the class of the expected ResponseControl for the paged results response.
        Parameters:
        responseControlClass - Class of the expected response control.

      • setRequestControlClass

        public void setRequestControlClass​(java.lang.Class requestControlClass)
        Deprecated.

      • postProcess

        public void postProcess​(javax.naming.directory.DirContext ctx)
                 throws javax.naming.NamingException
        Deprecated.
        Description copied from interface: DirContextProcessor
        Perform post-processing on the supplied DirContext.
        Parameters:
        ctx - the DirContext instance.
        Throws:
        javax.naming.NamingException - if thrown by the underlying operation.