Browse Prior Art Database

LDAP Control Extension for Server Side Sorting of Search Results (RFC2891)

IP.com Disclosure Number: IPCOM000005010D
Original Publication Date: 2000-Aug-01
Included in the Prior Art Database: 2001-Jul-13
Document File: 9 page(s) / 16K

Publishing Venue

Internet Society Requests For Comment (RFCs)

Related People

T. Howes: AUTHOR [+3]

Abstract

This document describes two LDAPv3 control extensions for server side sorting of search results. These controls allows a client to specify the attribute types and matching rules a server should use when returning the results to an LDAP search request. The controls may be useful when the LDAP client has limited functionality or for some other reason cannot sort the results but still needs them sorted. Other permissible controls on search operations are not defined in this extension.

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

Network Working Group T. Howes Request for Comments: 2891 Loudcloud Category: Standards Track M. Wahl Sun Microsystems A. Anantha

Microsoft August 2000

LDAP Control Extension for Server Side Sorting of Search Results

Status of this Memo

This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited.

Copyright Notice

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

Abstract

This document describes two LDAPv3 control extensions for server side sorting of search results. These controls allows a client to specify the attribute types and matching rules a server should use when returning the results to an LDAP search request. The controls may be useful when the LDAP client has limited functionality or for some other reason cannot sort the results but still needs them sorted. Other permissible controls on search operations are not defined in this extension.

The sort controls allow a server to return a result code for the sorting of the results that is independent of the result code returned for the search operation.

The key words "MUST", "SHOULD", and "MAY" used in this document are to be interpreted as described in [bradner97].

Howes, et al. Standards Track [Page 1]

RFC 2891 LDAP Control Extension for Server Side Sorting August 2000

1. The Controls

1.1 Request Control

This control is included in the searchRequest message as part of the controls field of the LDAPMessage, as defined in Section 4.1.12 of [LDAPv3].

The controlType is set to "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or FALSE (where absent is also equivalent to FALSE) at the client's option. The controlValue is an OCTET STRING, whose value is the BER encoding of a value of the following SEQUENCE:

SortKeyList ::= SEQUENCE OF SEQUENCE attributeType AttributeDescription, orderingRule [0] MatchingRuleId OPTIONAL, reverseOrder [1] BOOLEAN DEFAULT FALSE

The SortKeyList sequence is in order of highest to lowest sort key precedence.

The MatchingRuleId, as defined in section 4.1.9 of [LDAPv3], SHOULD be one that is valid for the attribute type it applies to. If it is not, the server will return inappropriateMatching.

Each attributeType should only occur in the SortKeyList once. If an attributeType is included in the sort key list multiple times, the server should return an error in the sortResult of unwillingToPerform.

If the orderingRule is omitted, the ordering MatchingRule defined for use with this attribute MUST be used.

Any conformant implementation of this control MUST allow a sort key list with at least one key.

1.2 Re...