org.springframework.ldap.control
Class PagedResultsRequestControl

java.lang.Object
  org.springframework.ldap.control.AbstractRequestControlDirContextProcessor
      org.springframework.ldap.control.PagedResultsRequestControl

All Implemented Interfaces:

DirContextProcessor

public class PagedResultsRequestControl
extends AbstractRequestControlDirContextProcessor

DirContextProcessor implementation for managing the paged results control.

Author:

Mattias Arthursson, Ulrik Sandberg

Field Summary

Fields inherited from class org.springframework.ldap.control.AbstractRequestControlDirContextProcessor

log

Constructor Summary

PagedResultsRequestControl(int pageSize)
Constructs a new instance.

PagedResultsRequestControl(int pageSize, PagedResultsCookie cookie)
Constructs a new instance with the supplied page size and cookie.

Method Summary

javax.naming.ldap.Control	createRequestControl() Create an instance of the appropriate RequestControl.
PagedResultsCookie	getCookie() Get the cookie.
int	getPageSize() Get the page size.
int	getResultSize() Get the total estimated number of entries that matches the issued search.
void	postProcess(javax.naming.directory.DirContext ctx) Perform post-processing on the supplied DirContext.
void	setResponseControlClass(java.lang.Class responseControlClass) Set the class of the expected ResponseControl for the paged results response.

Methods inherited from class org.springframework.ldap.control.AbstractRequestControlDirContextProcessor

preProcess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PagedResultsRequestControl

public PagedResultsRequestControl(int pageSize)

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)

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()

Get the cookie.

Returns:

the cookie.

getPageSize

public int getPageSize()

Get the page size.

Returns:

the page size.

getResultSize

public int getResultSize()

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)

Set the class of the expected ResponseControl for the paged results response. The default is PagedResultsResponseControl.

Parameters:

responseControlClass - Class of the expected response control.

createRequestControl

public javax.naming.ldap.Control createRequestControl()

Description copied from class: AbstractRequestControlDirContextProcessor

Create an instance of the appropriate RequestControl.

Specified by:

createRequestControl in class AbstractRequestControlDirContextProcessor

Returns:

the new instance.

postProcess

public void postProcess(javax.naming.directory.DirContext ctx)
                 throws javax.naming.NamingException

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.