Browse Prior Art Database

LDAP Control Extension for Simple Paged Results Manipulation (RFC2696)

IP.com Disclosure Number: IPCOM000003289D
Original Publication Date: 1999-Sep-01
Included in the Prior Art Database: 2000-Sep-13
Document File: 5 page(s) / 12K

Publishing Venue

Internet Society Requests For Comment (RFCs)

Related People

C. Weider: AUTHOR [+4]

Abstract

This document describes an LDAPv3 control extension for simple paging of search results. This control extension allows a client to control the rate at which an LDAP server returns the results of an LDAP search operation. This control may be useful when the LDAP client has limited resources and may not be able to process the entire result set from a given LDAP query, or when the LDAP client is connected over a low-bandwidth connection. Other operations on the result set are not defined in this extension. This extension is not designed to provide more sophisticated result set management.

This text was extracted from a ASCII Text document.
This is the abbreviated version, containing approximately 25% of the total text.

Network Working Group C. Weider

Request for Comments: 2696 A. Herron

Category: Informational A. Anantha

Microsoft

T. Howes

Netscape

September 1999

LDAP Control Extension for Simple Paged Results Manipulation

Status of this Memo

This memo provides information for the Internet community. It does

not specify an Internet standard of any kind. Distribution of this

memo is unlimited.

Copyright Notice

Copyright (C) The Internet Society (1999). All Rights Reserved.

1. Abstract

This document describes an LDAPv3 control extension for simple paging

of search results. This control extension allows a client to control

the rate at which an LDAP server returns the results of an LDAP

search operation. This control may be useful when the LDAP client has

limited resources and may not be able to process the entire result

set from a given LDAP query, or when the LDAP client is connected

over a low-bandwidth connection. Other operations on the result set

are not defined in this extension. This extension is not designed to

provide more sophisticated result set management.

The key words "MUST", "SHOULD", and "MAY" used in this document are

to be interpreted as described in [bradner97].

2. The Control

This control is included in the searchRequest and searchResultDone

messages as part of the controls field of the LDAPMessage, as defined

in Section 4.1.12 of [LDAPv3]. The structure of this control is as

follows:

pagedResultsControl ::= SEQUENCE {

controlType 1.2.840.113556.1.4.319,

criticality BOOLEAN DEFAULT FALSE,

controlValue searchControlValue

}

The searchControlValue is an OCTET STRING wrapping the BER-encoded

version of the following SEQUENCE:

realSearchControlValue ::= SEQUENCE {

size INTEGER (0..maxInt),

-- requested page size from client

-- result set size estimate from server

cookie OCTET STRING

}

3. Client-Server Interaction

An LDAP client application that needs to control the rate at which

results are returned MAY specify on the searchRequest a

pagedResultsControl with size set to the desired page size and cookie

set to the zero-length string. The page size specified MAY be greater

than zero and less than the sizeLimit value specified in the

searchRequest.

If the page size is greater than or equal to the sizeLimit value, the

server should ignore the control as the request can be satisfied in a

single page. If the server does not support this control, the server

MUST return an error of unsupportedCriticalExtension if the client

requested it a...