Класс SortControl
- Все реализованные интерфейсы:
Serializable, Control
public final class SortControl extends BasicControl
Следующий пример кода показывает, как можно использовать этот класс:
// 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();
...
Этот класс реализует управляющий элемент LDAPv3 для сортировки на стороне сервера, определенный в RFC 2891. Значение элемента управления имеет следующее определение ASN.1:
SortKeyList ::= SEQUENCE OF SEQUENCE {
attributeType AttributeDescription,
orderingRule [0] MatchingRuleId OPTIONAL,
reverseOrder [1] BOOLEAN DEFAULT FALSE }
- Начиная с версии:
- 1.5
- См. также:
Краткое описание полей
| Модификатор и тип | Поле | Описание |
|---|---|---|
static final String |
OID |
Идентификатор объекта, назначенный элементу управления сортировкой на стороне сервера: 1.2.840.113556.1.4.473. |
Поля, объявленные в классе BasicControl
criticality, id, value
Поля, объявленные в интерфейсе Control
CRITICAL, NONCRITICAL
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
SortControl |
Создает элемент управления для сортировки списка атрибутов по возрастанию. |
SortControl |
Создает элемент управления для сортировки одного атрибута по возрастанию. |
SortControl |
Создает элемент управления для сортировки по списку ключей сортировки. |
Краткое описание методов
Методы, объявленные в классе BasicControl
getEncodedValue, getID, isCritical
Подробное описание полей
OID
public static final String OID
- См. также:
Подробное описание конструкторов
SortControl
public SortControl(String sortBy, boolean criticality) throws IOException
- Параметры:
-
sortBy— идентификатор атрибута, по которому выполняется сортировка. -
criticality— если значение равно true, сервер должен обработать элемент управления и вернуть результаты поиска в запрошенном порядке сортировки либо отказаться от выполнения поиска. Если значение равно false, сервер не обязан обрабатывать элемент управления. - Исключения:
-
IOException— если при кодировании переданных аргументов в элемент управления произошла ошибка.
SortControl
public SortControl(String[] sortBy, boolean criticality) throws IOException
- Параметры:
-
sortBy— непустой список идентификаторов атрибутов, по которым выполняется сортировка. Элементы списка расположены в порядке убывания приоритета ключей сортировки. -
criticality— если значение равно true, сервер должен обработать элемент управления и вернуть результаты поиска в запрошенном порядке сортировки либо отказаться от выполнения поиска. Если значение равно false, сервер не обязан обрабатывать элемент управления. - Исключения:
-
IOException— если при кодировании переданных аргументов в элемент управления произошла ошибка.
SortControl
public SortControl(SortKey[] sortBy, boolean criticality) throws IOException
- Параметры:
-
sortBy— непустой список ключей, по которым выполняется сортировка. Элементы списка расположены в порядке убывания приоритета ключей сортировки. -
criticality— если значение равно true, сервер должен обработать элемент управления и вернуть результаты поиска в запрошенном порядке сортировки либо отказаться от выполнения поиска. Если значение равно false, сервер не обязан обрабатывать элемент управления. - Исключения:
-
IOException— если при кодировании переданных аргументов в элемент управления произошла ошибка.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/ldap/SortControl.html