Virtual List View Control


The virtual list view (VLV) is a supportedControl that can be attached to a searchRequest to indicate that only a subset of the results should be returned.

Virtual List View Control may be used to iterate through the search results a page at a time.

Virtual List View Control is similar to the simple paged results control with the exception that it can be used to retrieve an arbitrary subset of the results from the server, and it requires that the search Request also include the server-side sort control to ensure that the results are consistently sorted across requests.

The VLV control is defined in draft-ietf-ldapext-ldapv3-vlv.

As far as we can determine this is NOT an approved standard.

The request control has an OID of 2.16.840.1.113730.3.4.9 and the value is encoded as follows:

   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 } 

The response control has an OID of 2.16.840.1.113730.3.4.10 and the value is encoded as:

   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), 
               ... }, 
          contextID     OCTET STRING OPTIONAL } 

eDirectory LDAP Virtual List View And Server Side Sort Controls#

More Information#

There might be more information for this subject on one of the following: