Класс SearchControls

java.lang.Object

javax.naming.directory.SearchControls

Все реализованные интерфейсы:: Serializable

public class SearchControls extends Object implements Serializable

Этот класс инкапсулирует факторы, определяющие область поиска и то, что возвращается в результате поиска.

Объект SearchControls не синхронизирован для одновременного доступа в нескольких потоках. Несколько потоков, пытающихся получить доступ к одному экземпляру SearchControls и изменить его, должны заблокировать объект.

С:

1.3

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`OBJECT_SCOPE`	Поиск по имени объекта.
`static final int`	`ONELEVEL_SCOPE`	Поиск на одном уровне от указанного контекста.
`static final int`	`SUBTREE_SCOPE`	Поиск по всему поддереву, укоренённому в указанном объекте.

Краткое описание конструкторов

Конструктор	Описание
`SearchControls()`	Создаёт ограничения поиска по умолчанию.
`SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)`	Создаёт ограничения поиска с аргументами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`long`	`getCountLimit()`	Возвращает максимальное количество записей, которые будут возвращены в результате поиска.
`boolean`	`getDerefLinkFlag()`	Определяет, будут ли ссылки разыменовываться во время поиска.
`String[]`	`getReturningAttributes()`	Возвращает атрибуты, которые будут возвращены в ходе поиска.
`boolean`	`getReturningObjFlag()`	Определяет, будут ли возвращены объекты в качестве части результата.
`int`	`getSearchScope()`	Возвращает область поиска этих SearchControls.
`int`	`getTimeLimit()`	Возвращает временной лимит этих SearchControls в миллисекундах.
`void`	`setCountLimit(long limit)`	Устанавливает максимальное количество записей, которые должны быть возвращены в результате поиска.
`void`	`setDerefLinkFlag(boolean on)`	Включает/выключает разыменование ссылок во время поиска.
`void`	`setReturningAttributes(String[] attrs)`	Устанавливает атрибуты, которые будут возвращены в результате поиска.
`void`	`setReturningObjFlag(boolean on)`	Включает/выключает возврат объектов в результате поиска.
`void`	`setSearchScope(int scope)`	Устанавливает область поиска на один из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
`void`	`setTimeLimit(int ms)`	Устанавливает временной лимит этих SearchControls в миллисекундах.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

OBJECT_SCOPE

public static final int OBJECT_SCOPE

Поиск по заданному объекту.

NamingEnumeration, полученная в результате вызова search() с OBJECT_SCOPE, будет содержать один или ноль элементов. Перечисление содержит один элемент, если заданный объект удовлетворяет фильтру поиска, указанному в search(). Элемент будет иметь пустое имя, так как имена элементов в NamingEnumeration относительны к контексту назначения — в данном случае, контекстом назначения является заданный объект. Перечисление содержит ноль элементов, если заданный объект не удовлетворяет фильтру поиска, указанному в search().

Значение этой константы — 0.

См. также:

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

Поиск в одном уровне от заданного контекста.

NamingEnumeration, полученная в результате вызова search() с ONELEVEL_SCOPE, содержит элементы с объектами в заданном контексте, удовлетворяющими фильтру поиска, указанному в search(). Имена элементов в NamingEnumeration являются атомными именами, относительными к заданному контексту.

Значение этой константы — 1.

См. также:

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

Поиск по всему поддереву, укоренённому в заданном объекте.

Если заданный объект не является DirContext, поиск выполняется только по этому объекту. Если заданный объект является DirContext, поиск выполняется по всему поддереву, укоренённому в заданном объекте, включая сам заданный объект.

Поиск не пересекает границы систем именования.

NamingEnumeration, полученная в результате вызова search() с SUBTREE_SCOPE, содержит элементы объектов из поддерева (включая сам контекст), которые удовлетворяют фильтру поиска, указанному в search(). Имена элементов в NamingEnumeration либо относительны к заданному контексту, либо являются строками URL. Если сам заданный контекст удовлетворяет фильтру поиска, он включается в перечисление с пустым именем.

Значение этой константы — 2.

См. также:

Подробное описание конструкторов

SearchControls

public SearchControls()

Создаёт ограничения поиска с использованием значений по умолчанию.

Значения по умолчанию:

поиск в одном уровне
нет максимального ограничения на количество результатов поиска
нет ограничения по времени для поиска
возвращаются все атрибуты, связанные с объектами, удовлетворяющими фильтру поиска
заданный объект не возвращается (возвращаются только имя и класс)
связи не разрешаются во время поиска

SearchControls

public SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref)

Создаёт ограничения поиска с использованием аргументов.

Параметры:: scope - Область поиска. Одно из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.; countlim - Максимальное число записей для возврата. Если 0, возвращаются все записи, удовлетворяющие фильтру.; timelim - Количество миллисекунд ожидания перед возвратом. Если 0, ожидание неограниченно.; attrs - Идентификаторы атрибутов, которые нужно вернуть вместе с записью. Если null, возвращаются все атрибуты. Если пустой массив, то атрибуты не возвращаются.; retobj - Если true, возвращается объект, связанный с именем записи; если false, объект не возвращается.; deref - Если true, связи разрешаются во время поиска.

Подробное описание методов

getSearchScope

public int getSearchScope()

Получает область поиска этих SearchControls.

Одно из OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Возвращает:

Область поиска этого SearchControls.

См. также:

getTimeLimit

public int getTimeLimit()

Получает ограничение по времени для этих SearchControls в миллисекундах.

Если значение равно 0, это означает неограниченное ожидание.

Возвращает:

Ограничение по времени этих SearchControls в миллисекундах.

См. также:

getDerefLinkFlag

public boolean getDerefLinkFlag()

Определяет, будут ли ссылки разрешаться во время поиска.

Возвращает:

true, если ссылки будут разрешаться; false в противном случае.

См. также:

getReturningObjFlag

public boolean getReturningObjFlag()

Определяет, будут ли возвращаться объекты как часть результата.

Возвращает:

true, если объекты будут возвращены; false в противном случае.

См. также:

getCountLimit

public long getCountLimit()

Получает максимальное количество записей, которые будут возвращены в результате поиска.

0 означает, что будут возвращены все записи.

Возвращает:

Максимальное количество записей, которые будут возвращены.

См. также:

getReturningAttributes

public String[] getReturningAttributes()

Получает атрибуты, которые будут возвращены как часть результата поиска.

Значение null указывает, что будут возвращены все атрибуты. Пустой массив указывает, что атрибуты не должны возвращаться.

Возвращает:

Массив идентификаторов атрибутов, определяющих атрибуты, которые будут возвращены. Может быть null.

См. также:

setSearchScope

public void setSearchScope(int scope)

Устанавливает область поиска на одно из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Параметры:

scope - Область поиска этого SearchControls.

См. также:

setTimeLimit

public void setTimeLimit(int ms)

Устанавливает ограничение по времени для этих SearchControls в миллисекундах.

Если значение равно 0, это означает неограниченное ожидание.

Параметры:

ms - Ограничение по времени этих SearchControls в миллисекундах.

См. также:

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)

Включает/выключает разрешение ссылок во время поиска.

Параметры:

on - если true, ссылки будут разрешены; если false, не будут следовать.

См. также:

setReturningObjFlag

public void setReturningObjFlag(boolean on)

Включает/выключает возврат объектов как часть результата.

Если отключено, возвращаются только имя и класс объекта. Если включено, возвращается сам объект.

Параметры:

on - если true, объекты будут возвращены; если false, объекты не будут возвращены.

См. также:

setCountLimit

public void setCountLimit(long limit)

Устанавливает максимальное количество записей, которые должны быть возвращены в результате поиска.

0 указывает на отсутствие ограничения: будут возвращены все записи.

Параметры:

limit - Максимальное количество записей, которые будут возвращены.

См. также:

setReturningAttributes

public void setReturningAttributes(String[] attrs)

Устанавливает атрибуты, которые будут возвращены в результате поиска.

null указывает, что будут возвращены все атрибуты. Пустой массив указывает, что атрибуты не возвращаются.

Параметры:

attrs - Массив идентификаторов атрибутов, определяющих атрибуты, которые будут возвращены. Может быть null.

См. также:

© 1993, 2023, 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/21/docs/api/java.naming/javax/naming/directory/SearchControls.html