Paged search results control

Edit online

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

Description
The paged results control is enabled on a search operation and enables a client to request a subset of entries. Subsequent search requests for using this control continue to result in the next results page until the operation is canceled or the last result is returned. This control is supported by RDBM back-end and by Proxy server version 6.2 and later.
Note: This control can be disabled by setting the Paged result limit to 0.

There is also a configuration option which enables an administrator to grant or deny the use of this control to non-administrators. The administrators in this case refer to the primary directory administrator, local administration group members, and global administration group members. If the ibm-slapdPagedResAllowNonAdmin attribute in the cn=RDBM Backends, cn=IBM Directory, cn=Schemas, cn=Configuration entry is set to TRUE, all users can send paged search requests. If set to FALSE, only administrators can send paged search requests against RDBM back-end.

In a proxy server, if ibm-slapdPagedResAllowNonAdmin is set to FALSE, then only Global Administration Group members are allowed to do page search. If primary directory administrator or local administration group members runs page search when the attribute is set to FALSE, then LDAP_INSUFFICIENT_ACCESS is retuned.

OID
1.2.840.113556.1.4.319
Syntax
realSearchControlValue ::= SEQUENCE {
	Size		INTEGER(0..maxInt),
				-- requested page size from client
				-- result set size estimate from server
	Cookie		OCTET STRING }
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