org.springframework.ldap.support.control
Class PagedResultsRequestControl

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

All Implemented Interfaces:

DirContextProcessor

public class PagedResultsRequestControl
extends AbstractRequestControlDirContextProcessor

DirContextProcessor implementation for managing the paged results.

Author:

Mattias Arthursson, Ulrik Sandberg

Field Summary

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

log

Constructor Summary

PagedResultsRequestControl(int pageSize)

PagedResultsRequestControl(int pageSize, PagedResultsCookie cookie)

Method Summary

javax.naming.ldap.Control	createRequestControl() Create an instance of the appropriate RequestControl.
PagedResultsCookie	getCookie()
int	getPageSize()
int	getResultSize()
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.support.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)

PagedResultsRequestControl

public PagedResultsRequestControl(int pageSize,
                                  PagedResultsCookie cookie)

Method Detail

getCookie

public PagedResultsCookie getCookie()

getPageSize

public int getPageSize()

getResultSize

public int getResultSize()

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.