Класс 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, полученная в результате поиска с использованием OBJECT_SCOPE, будет содержать один или ноль элементов. Перечисление содержит один элемент, если именованный объект удовлетворяет фильтру поиска, указанному в search(). Элемент будет иметь пустую строку в качестве имени, так как имена элементов в NamingEnumeration относительны к целевому контексту — в данном случае, целевым контекстом является именованный объект. Оно содержит ноль элементов, если именованный объект не удовлетворяет фильтру поиска, указанному в search().

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

См. также:

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

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

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

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

См. также:

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

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

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

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

NamingEnumeration, полученная в результате поиска с использованием 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, 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://download.java.net/java/early_access/jdk24/docs/api/java.naming/javax/naming/directory/SearchControls.html