Sorted search results control

Edit online

The Sorted search results control explains its use with the server and provides the results.

Description
The sorted search results control enables a client to receive search results that are sorted by a sort key.
Note: This control can be disabled by setting the ibm-slapdSortKeyLimit to 0.

There is also a configuration option which enables an administrator to grant or deny the use of this control to non-administrators. In this case, administrators refer to the primary directory administrator, local administration group members, and global administration group members. If the ibm-slapdSortSrchAllowNonAdmin attribute in the cn=RDBM Backends, cn=IBM Directory, cn=Schemas, cn=Configuration entry is set to TRUE, then all users are enabled to use the sorted search. If set to FALSE, only administrators can use the sorted search.

OID
1.2.840.113556.1.4.473
Syntax
The controlValue is an OCTET STRING who value is the 
BER encoding of a value with the following SEQUENCE:

SortKeyList ::= SEQUENCE of SEQUENCE {
	AttributeType 	AttributeDescription,
	OrderingRule	[0] MatchingRuleId OPTIONAL,
	ReverseOrder	[1] BOOLEAN DEFAULT FALSE }
Behavior
This control is registered for the following operations:
  • Search
In a default user installation, any user can send this control. If the ibm-slapdSortSrchAllowNonAdmin is set to FALSE, the use of this control is restricted to administrative users:
  • Primary Directory Administrator
  • Local Administration Group members
  • Global Administration Group members
Note: If the control is sent by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
If more information is required for the control, and there is an error in the formatting of that information, the following error returns might occur:
  • Missing information – LDAP_DECODING_ERROR
  • Additional information – LDAP_DECODING_ERROR
  • Invalid information – LDAP_DECODING_ERROR
This control has the following possible return codes:
  • LDAP_SUCCESS
  • LDAP_DECODING_ERROR
  • LDAP_OPERATIONS_ERROR
  • LDAP_INSUFFICIENT_ACCESS
  • LDAP_OTHER

The Administration Server does not support this control.

Scope
The control lasts for the term of one operation. The control changes the behavior of a search operation that goes against the RDBM back-end. The control requests that the server return the entries in a sorted order. The configuration back-end and schema back-ends do no support this control.
Auditing
When the server receives this control, the audit plug-in adds the following lines to the audit entry: 
controlType: control ID
criticality: true | false