public final class SortControl extends BasicControl
The following code sample shows how the class may be used:
// Open an LDAP association
LdapContext ctx = new InitialLdapContext();
// Activate sorting
String sortKey = "cn";
ctx.setRequestControls(new Control[]{
new SortControl(sortKey, Control.CRITICAL) });
// Perform a search
NamingEnumeration results =
ctx.search("", "(objectclass=*)", new SearchControls());
// Iterate over search results
while (results != null && results.hasMore()) {
// Display an entry
SearchResult entry = (SearchResult)results.next();
System.out.println(entry.getName());
System.out.println(entry.getAttributes());
// Handle the entry's response controls (if any)
if (entry instanceof HasControls) {
// ((HasControls)entry).getControls();
}
}
// Examine the sort control response
Control[] controls = ctx.getResponseControls();
if (controls != null) {
for (int i = 0; i < controls.length; i++) {
if (controls[i] instanceof SortResponseControl) {
SortResponseControl src = (SortResponseControl)controls[i];
if (! src.isSorted()) {
throw src.getException();
}
} else {
// Handle other response controls (if any)
}
}
}
// Close the LDAP association
ctx.close();
...
This class implements the LDAPv3 Request Control for server-side sorting as defined in RFC 2891. The control's value has the following ASN.1 definition:
SortKeyList ::= SEQUENCE OF SEQUENCE {
attributeType AttributeDescription,
orderingRule [0] MatchingRuleId OPTIONAL,
reverseOrder [1] BOOLEAN DEFAULT FALSE }
SortKey,
SortResponseControl,
Serialized Form| Modifier and Type | Field and Description |
|---|---|
static String |
OID
The server-side sort control's assigned object identifier
is 1.2.840.113556.1.4.473.
|
criticality, id, valueCRITICAL, NONCRITICAL| Constructor and Description |
|---|
SortControl(SortKey[] sortBy,
boolean criticality)
Constructs a control to sort on a list of sort keys.
|
SortControl(String[] sortBy,
boolean criticality)
Constructs a control to sort on a list of attributes in ascending order.
|
SortControl(String sortBy,
boolean criticality)
Constructs a control to sort on a single attribute in ascending order.
|
public static final String OID
public SortControl(String sortBy, boolean criticality) throws IOException
sortBy - An attribute ID to sort by.criticality - If true then the server must honor the control
and return the search results sorted as
requested or refuse to perform the search.
If false, then the server need not honor the
control.IOException - If an error was encountered while encoding the
supplied arguments into a control.public SortControl(String[] sortBy, boolean criticality) throws IOException
sortBy - A non-null list of attribute IDs to sort by.
The list is in order of highest to lowest sort key
precedence.criticality - If true then the server must honor the control
and return the search results sorted as
requested or refuse to perform the search.
If false, then the server need not honor the
control.IOException - If an error was encountered while encoding the
supplied arguments into a control.public SortControl(SortKey[] sortBy, boolean criticality) throws IOException
sortBy - A non-null list of keys to sort by.
The list is in order of highest to lowest sort key
precedence.criticality - If true then the server must honor the control
and return the search results sorted as
requested or refuse to perform the search.
If false, then the server need not honor the
control.IOException - If an error was encountered while encoding the
supplied arguments into a control. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138