Класс 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 в миллисекундах.

Методы, объявленные в классе 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)

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

Параметры:

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://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/directory/SearchControls.html