Класс SearchControls

java.lang.Object
- javax.naming.directory.SearchControls

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

public class SearchControls
extends Object
implements Serializable

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

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

С:: 1.3
См. также:: Сериализованная форма

Поля

Модификатор и тип	Поле	Описание
`static int`	`OBJECT_SCOPE`	Произвести поиск по указанному объекту.
`static int`	`ONELEVEL_SCOPE`	Произвести поиск на одном уровне от указанного контекста.
`static 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.; timelim - Количество миллисекунд ожидания перед возвратом. Если 0, ожидание неограниченное.; deref - Если true, ссылки разрешаются во время поиска.; countlim - Максимальное число записей для возврата. Если 0, возвращаются все записи, удовлетворяющие фильтру.; retobj - Если true, возвращается объект, связанный с именем записи; если false, объект не возвращается.; attrs - Идентификаторы атрибутов, которые нужно вернуть вместе с записью. Если null, возвращаются все атрибуты. Если пустой массив, атрибуты не возвращаются.

Методы

getSearchScope

public int getSearchScope()

Возвращает область поиска этих SearchControls.

Одно из значений: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Возвращает:: Область поиска этих SearchControls.
См. также:: setSearchScope(int)

getTimeLimit

public int getTimeLimit()

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

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

Возвращает:: Временное ограничение этих SearchControls в миллисекундах.
См. также:: setTimeLimit(int)

getDerefLinkFlag

public boolean getDerefLinkFlag()

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

Возвращает:: true, если ссылки разрешаются; false в противном случае.
См. также:: setDerefLinkFlag(boolean)

getReturningObjFlag

public boolean getReturningObjFlag()

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

Возвращает:: true, если объекты будут возвращены; false в противном случае.
См. также:: setReturningObjFlag(boolean)

getCountLimit

public long getCountLimit()

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

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

Возвращает:: Максимальное количество возвращаемых записей.
См. также:: setCountLimit(long)

getReturningAttributes

public String[] getReturningAttributes()

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

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

Возвращает:: Массив идентификаторов атрибутов, определяющих возвращаемые атрибуты. Может быть null.
См. также:: setReturningAttributes(java.lang.String[])

setSearchScope

public void setSearchScope(int scope)

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

Параметры:: scope - Область поиска этих SearchControls.
См. также:: getSearchScope()

setTimeLimit

public void setTimeLimit(int ms)

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

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

Параметры:: ms - Временное ограничение этих SearchControls в миллисекундах.
См. также:: getTimeLimit()

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)

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

Параметры:: on - true, если ссылки разрешаются; false, если нет.
См. также:: getDerefLinkFlag()

setReturningObjFlag

public void setReturningObjFlag(boolean on)

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

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

Параметры:: on - true, если объекты возвращаются; false, если нет.
См. также:: getReturningObjFlag()

setCountLimit

public void setCountLimit(long limit)

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

0 означает отсутствие ограничения: возвращаются все записи.

Параметры:: limit - Максимальное количество записей для возврата.
См. также:: getCountLimit()

setReturningAttributes

public void setReturningAttributes(String[] attrs)

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

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

Параметры:: attrs - Массив идентификаторов атрибутов, которые нужно вернуть. Может быть null.
См. также:: getReturningAttributes()

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