Package org.springframework.ldap.control

Class VirtualListViewControlDirContextProcessor

java.lang.Object

org.springframework.ldap.control.AbstractRequestControlDirContextProcessor

org.springframework.ldap.control.AbstractFallbackRequestAndResponseControlDirContextProcessor

org.springframework.ldap.control.VirtualListViewControlDirContextProcessor

All Implemented Interfaces:

DirContextProcessor

public class VirtualListViewControlDirContextProcessor
extends AbstractFallbackRequestAndResponseControlDirContextProcessor

DirContextProcessor implementation for managing a virtual list view.

This is the request control syntax:

 VirtualListViewRequest ::= SEQUENCE {
        beforeCount    INTEGER (0..maxInt),
        afterCount     INTEGER (0..maxInt),
        target       CHOICE {
                       byOffset        [0] SEQUENCE {
                            offset          INTEGER (1 .. maxInt),
                            contentCount    INTEGER (0 .. maxInt) },
                       greaterThanOrEqual [1] AssertionValue },
        contextID     OCTET STRING OPTIONAL }
 

This is the response control syntax:

 VirtualListViewResponse ::= SEQUENCE {
        targetPosition    INTEGER (0 .. maxInt),
        contentCount     INTEGER (0 .. maxInt),
        virtualListViewResult ENUMERATED {
             success (0),
             operationsError (1),
             protocolError (3),
             unwillingToPerform (53),
             insufficientAccessRights (50),
             timeLimitExceeded (3),
             adminLimitExceeded (11),
             innapropriateMatching (18),
             sortControlMissing (60),
             offsetRangeError (61),
             other(80),
             ... },
        contextID     OCTET STRING OPTIONAL }
 

See Also:

LDAP Extensions for Scrolling View Browsing of Search Results

Field Summary

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

critical, defaultRequestControl, defaultResponseControl, fallbackRequestControl, fallbackResponseControl, requestControlClass, responseControlClass

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

log

Constructor Summary

Constructors

Constructor	Description
VirtualListViewControlDirContextProcessor(int pageSize)
VirtualListViewControlDirContextProcessor(int pageSize, int targetOffset, int listSize, VirtualListViewResultsCookie cookie)

Method Summary

Modifier and Type	Method	Description
javax.naming.ldap.Control	createRequestControl()	Create an instance of the appropriate RequestControl.
VirtualListViewResultsCookie	getCookie()
javax.naming.NamingException	getException()
int	getListSize()
int	getPageSize()
int	getTargetOffset()
protected void	handleResponse(java.lang.Object control)
protected static java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.Class clazz, java.lang.Object control, java.lang.Class[] paramTypes, java.lang.Object[] paramValues)
boolean	isOffsetPercentage()
void	setOffsetPercentage(boolean isPercentage)	Set whether the targetOffset should be interpreted as percentage of the list or an offset into the list.

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

createRequestControl, invokeMethod, loadControlClasses, postProcess, setCritical, setRequestControlClass, setResponseControlClass

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

isReplaceSameControlEnabled, preProcess, setReplaceSameControlEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualListViewControlDirContextProcessor

public VirtualListViewControlDirContextProcessor(int pageSize)

VirtualListViewControlDirContextProcessor

public VirtualListViewControlDirContextProcessor(int pageSize,
                                                 int targetOffset,
                                                 int listSize,
                                                 VirtualListViewResultsCookie cookie)

Method Detail

getCookie

public VirtualListViewResultsCookie getCookie()

getPageSize

public int getPageSize()

getListSize

public int getListSize()

getException

public javax.naming.NamingException getException()

getTargetOffset

public int getTargetOffset()

setOffsetPercentage

public void setOffsetPercentage(boolean isPercentage)

Set whether the targetOffset should be interpreted as percentage of the list or an offset into the list.

Parameters:

isPercentage - true if targetOffset is a percentage

isOffsetPercentage

public boolean isOffsetPercentage()

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.

handleResponse

protected void handleResponse(java.lang.Object control)

Specified by:

handleResponse in class AbstractFallbackRequestAndResponseControlDirContextProcessor

invokeMethod

protected static java.lang.Object invokeMethod(java.lang.String methodName,
                                               java.lang.Class clazz,
                                               java.lang.Object control,
                                               java.lang.Class[] paramTypes,
                                               java.lang.Object[] paramValues)