SortKeyResponse

  • Name: SortKeyResponse
  • Description: Used on a SearchResultDone message to return the result of a sorted search.
  • Assigned object identifier: 1.2.840.113556.1.4.474
  • Target of control: Client
  • Control criticality: Never critical
  • Values: The following ASN.1 (Abstract Syntax Notation One) syntax describes the BER (Basic Encoding Rules) encoding of the control value:
    ControlValue ::= SEQUENCE {
		sortResult ENUMERATED {
			success                     (0),   -- results are sorted
			operationsError             (1),   -- server internal failure
			timeLimitExceeded           (3),   -- timelimit reached 
                                         before sorting was completed
			adminLimitExceeded         (11),   -- too many matching entries 
                                         for the server to sort
			noSuchAttribute            (16),   -- unrecognized attribute type 
                                         in sort key
			inappropriateMatching      (18),   -- unrecognized or inappropriate 
                                         matching rule in sort key
			insufficientAccessRights   (50),   -- refused to return sorted results 
                                         to this client
			busy                       (51),   -- too busy to process
			unwillingToPerform         (53),   -- unable to sort
			other                      (80)
		},
		attributeType[0]         AttributeDescription         OPTIONAL
}
    where,
    • sortResult - Specifies the sort result return code.
    • attributeType - An optional field that specifies the returned attribute name that is associated with a sort error.
  • Detailed description: This response control allows a client to determine the result of a sorted search request. The control is included in the server's SearchResultDone message. Support is provided in the z/OS® LDAP client to parse this control. See the ldap_parse_sort_control() API and the ldapsearch client utility in the z/OS IBM Tivoli Directory Server Client Programming for z/OS and SortKeyRequest for more information.

    See RFC 2891 for more information about the sorted search controls.

  • Server behavior: See the server behavior for SortKeyRequest.