Класс InitialDirContext

protected InitialDirContext(boolean lazy) throws NamingException

Создаёт начальный DirContext с возможностью не инициализировать его. Это может использоваться конструктором подкласса, когда значение параметра среды ещё неизвестно в момент вызова конструктора InitialDirContext. Конструктор подкласса вызовет этот конструктор, вычислит значение среды, а затем вызовет init() перед возвращением.

public InitialDirContext() throws NamingException

Создаёт начальный DirContext. Свойства среды не предоставляются. Эквивалентно new InitialDirContext(null).

public InitialDirContext(Hashtable<?,?> environment) throws NamingException

Создаёт начальный DirContext, используя предоставленную среду. Свойства среды описаны в описании класса javax.naming.InitialContext.

Если свойство java.naming.provider.url предоставленной среды состоит из URL (или списка URL) с использованием протокола ldap, то результирующий LdapContext будет использовать сервер LDAP, разрешённый настроенным LdapDnsProviders:

1. Если это первый InitialDirContext созданный с java.naming.provider.url, использующим протокол ldap, то используется механизм ServiceLoader для поиска реализаций LdapDnsProvider с использованием загрузчика класса системы. Порядок поиска поставщиков зависит от реализации, и реализация может кэшировать найденных поставщиков.
2. Метод lookupEndpoints каждого поставщика, если он инициализирован, вызывается один раз с комбинацией каждого из URL в свойстве java.naming.provider.url и среды, пока поставщик не вернёт непустой результат или все поставщики не будут исчерпаны. Если ни один из LdapDnsProviders не вернёт непустой результат, то реализация предпримет все усилия для определения конечной точки. ServiceConfigurationError, Error или RuntimeException, возникшие при загрузке или вызове LdapDnsProvider, будут переданы в поток вызова.

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

public Attributes getAttributes(String name) throws NamingException

Возвращает все атрибуты, связанные с объектом с именем. Подробнее см. DirContext.getAttributes(Name).

public Attributes getAttributes(String name, String[] attrIds) throws NamingException

Возвращает выбранные атрибуты, связанные с объектом с именем. Подробнее см. DirContext.getAttributes(Name, String[]).

public Attributes getAttributes(Name name) throws NamingException

Возвращает все атрибуты, связанные с объектом с именем. Смотрите описание класса относительно моделей атрибутов, имён типов атрибутов и операционных атрибутов.

public Attributes getAttributes(Name name, String[] attrIds) throws NamingException

Возвращает выбранные атрибуты, связанные с объектом с именем. Смотрите описание класса относительно моделей атрибутов, имён типов атрибутов и операционных атрибутов.

Если объект не имеет указанного атрибута, каталог проигнорирует несуществующий атрибут и вернёт те запрашиваемые атрибуты, которые у объекта есть.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

public void modifyAttributes(String name, int mod_op, Attributes attrs) throws NamingException

Изменяет атрибуты, связанные с объектом с именем. Подробности см. в DirContext.modifyAttributes(Name, int, Attributes).

public void modifyAttributes(Name name, int mod_op, Attributes attrs) throws NamingException

Изменяет атрибуты, связанные с объектом с именем. Порядок модификаций не определён. Там, где это возможно, модификации выполняются атомарно.

public void modifyAttributes(String name, ModificationItem[] mods) throws NamingException

Изменяет атрибуты, связанные с объектом с заданным именем, используя упорядоченный список изменений. Подробности см. в DirContext.modifyAttributes(Name, ModificationItem[]).

public void modifyAttributes(Name name, ModificationItem[] mods) throws NamingException

Изменяет атрибуты, связанные с объектом с заданным именем, используя упорядоченный список изменений. Изменения выполняются в указанном порядке. Каждое изменение указывает код операции изменения и атрибут, над которым необходимо выполнить операцию. По возможности, изменения выполняются атомарно.

public void bind(String name, Object obj, Attributes attrs) throws NamingException

Связывает имя с объектом вместе с ассоциированными атрибутами. Подробности см. в DirContext.bind(Name, Object, Attributes).

public void bind(Name name, Object obj, Attributes attrs) throws NamingException

Связывает имя с объектом вместе с ассоциированными атрибутами. Если attrs равно null, результирующая привязка будет иметь атрибуты, связанные с obj, если obj является DirContext, и без атрибутов в противном случае. Если attrs не null, результирующая привязка будет иметь attrs в качестве атрибутов; любые атрибуты, связанные с obj, игнорируются.

public void rebind(String name, Object obj, Attributes attrs) throws NamingException

Связывает имя с объектом вместе с ассоциированными атрибутами, перезаписывая любую существующую привязку. Подробности см. в DirContext.rebind(Name, Object, Attributes).

public void rebind(Name name, Object obj, Attributes attrs) throws NamingException

Связывает имя с объектом вместе с ассоциированными атрибутами, перезаписывая любую существующую привязку. Если attrs равно null и obj является DirContext, используются атрибуты из obj. Если attrs равно null и obj не является DirContext, любые существующие атрибуты, связанные с объектом, уже привязанным в каталоге, остаются неизменными. Если attrs не null, любые существующие атрибуты, связанные с объектом, уже привязанным в каталоге, удаляются, и attrs связывается с именованным объектом. Если obj является DirContext и attrs не null, атрибуты obj игнорируются.

public DirContext createSubcontext(String name, Attributes attrs) throws NamingException

Создаёт и связывает новый контекст вместе с ассоциированными атрибутами. Подробности см. в DirContext.createSubcontext(Name, Attributes).

public DirContext createSubcontext(Name name, Attributes attrs) throws NamingException

Создаёт и связывает новый контекст вместе с ассоциированными атрибутами. Этот метод создаёт новый подконтекст с заданным именем, связывает его в целевом контексте (определяемом всеми, кроме конечного атомарного компонента имени), и связывает предоставленные атрибуты с новым созданным объектом. Все промежуточные и целевые контексты должны уже существовать. Если attrs равно null, этот метод эквивалентен Context.createSubcontext().

public DirContext getSchema(String name) throws NamingException

Извлекает схему, связанную с объектом с указанным именем. См. DirContext.getSchema(Name) для получения подробностей.

public DirContext getSchema(Name name) throws NamingException

Извлекает схему, связанную с объектом с указанным именем. Схема описывает правила, касающиеся структуры пространства имён и атрибутов, хранящихся в нём. Схема определяет, какие типы объектов могут быть добавлены в директорию и куда, какие обязательные и необязательные атрибуты может иметь объект. Диапазон поддержки схем зависит от директории.

Этот метод возвращает корень дерева информации схемы, применимой к объекту с указанным именем. Несколько объектов с указанным именем (или даже вся директория) могут использовать одну и ту же схему.

Такие вопросы, как структура и содержимое дерева схемы, разрешение на изменение содержимого дерева схемы и влияние таких изменений на директорию зависят от базовой директории.

public DirContext getSchemaClassDefinition(String name) throws NamingException

Извлекает контекст, содержащий объекты схемы определений классов указанного объекта. См. DirContext.getSchemaClassDefinition(Name) для получения подробностей.

public DirContext getSchemaClassDefinition(Name name) throws NamingException

Извлекает контекст, содержащий объекты схемы определений классов указанного объекта.

Одна категория информации в схемах директорий - это определения классов. Определение "класса объекта" задаёт тип объекта и какие атрибуты (обязательные и необязательные) объект должен/может иметь. Обратите внимание, что термин "класс объекта" здесь используется в смысле директории, а не в смысле Java. Например, если объект с именем - объект директории класса "Человек", getSchemaClassDefinition() вернёт DirContext, представляющий определение класса объекта "Человек" (директории).

Информация, которая может быть извлечена из определения класса объекта, зависит от директории.

До JNDI 1.2 этот метод возвращал один объект схемы, представляющий определение класса указанного объекта. Начиная с JNDI 1.2, этот метод возвращает DirContext, содержащий все определения классов указанного объекта.

public NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes) throws NamingException

Ищет в одном контексте объекты, содержащие указанный набор атрибутов. См. DirContext.search(Name, Attributes) для получения подробностей.

public NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes) throws NamingException

Ищет в одном контексте объекты, содержащие указанный набор атрибутов. Этот метод возвращает все атрибуты таких объектов. Эквивалентно передаче null в качестве параметра attributesToReturn методу search(Name, Attributes, String[]).
См. DirContext.search(Name, Attributes, String[]) для полного описания.

public NamingEnumeration<SearchResult> search(String name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException

Ищет в одном контексте объекты, содержащие указанный набор атрибутов, и извлекает выбранные атрибуты. См. DirContext.search(Name, Attributes, String[]) для получения подробностей.

public NamingEnumeration<SearchResult> search(Name name, Attributes matchingAttributes, String[] attributesToReturn) throws NamingException

Ищет в одном контексте объекты, содержащие указанный набор атрибутов, и извлекает выбранные атрибуты. Поиск выполняется с использованием стандартных SearchControls настроек.

Для выбора объекта каждый атрибут в matchingAttributes должен соответствовать какому-либо атрибуту объекта. Если matchingAttributes пусто или равно null, возвращаются все объекты в целевом контексте.

Атрибут A₁ в matchingAttributes считается соответствующим атрибуту A₂ объекта, если A₁ и A₂ имеют одинаковый идентификатор, и каждое значение A₁ равно какому-либо значению A₂. Это подразумевает, что порядок значений несущественен и что A₂ может содержать «дополнительные» значения, отсутствующие в A₁, без влияния на сравнение. Это также подразумевает, что если A₁ не имеет значений, то проверка соответствия эквивалентна проверке наличия атрибута A₂ с тем же идентификатором.

Точное определение «равенства», используемого при сравнении значений атрибутов, определяется базовой службой каталогов. Например, она может использовать метод Object.equals, или может использовать схему для указания другой операции равенства. Для сопоставления, основанного на операциях, отличных от равенства (например, сравнение подстрок), используйте версию метода search, принимающую аргумент фильтра.

При внесении изменений в этот DirContext, влияние на перечисления, возвращенные предыдущими вызовами этого метода, не определено.

Если у объекта отсутствует указанный атрибут, служба каталогов проигнорирует несуществующий атрибут и вернет запрашиваемые атрибуты, которые у объекта есть.

Служба каталогов может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

public NamingEnumeration<SearchResult> search(String name, String filter, SearchControls cons) throws NamingException

Ищет в указанном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с настройками поиска. См. DirContext.search(Name, String, SearchControls) для получения подробной информации.

public NamingEnumeration<SearchResult> search(Name name, String filter, SearchControls cons) throws NamingException

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

Формат и интерпретация filter следуют RFC 2254 с последующими интерпретациями attr и value, упомянутых в RFC.

attr — идентификатор атрибута.

value — строковое представление значения атрибута. Преобразование этого строкового представления в значение атрибута зависит от службы каталогов.

Например, для утверждения «someCount=127», attr — «someCount», а value — «127». Предоставитель определяет на основе идентификатора атрибута («someCount») (и, возможно, его схемы), что значение атрибута является целым числом. Затем он должным образом анализирует строку «127».

Любые не-ASCII символы в строке фильтра должны быть представлены соответствующими символами Java (Unicode), а не кодированы в виде UTF-8 октетов. В качестве альтернативы можно использовать обозначение «обратная косая черта-шестнадцатеричный код», описанное в RFC 2254.

Если служба каталогов не поддерживает строковое представление некоторых или всех своих атрибутов, можно использовать форму search, которая принимает аргументы фильтра в виде объектов. В таком случае поставщик услуг для данной службы каталогов преобразует аргументы фильтра в свою специфическую форму представления для оценки фильтра. См. search(Name, String, Object[], SearchControls).

RFC 2254 определяет определенные операторы для фильтра, включая совпадение подстрок, равенство, приблизительное совпадение, больше, меньше. Эти операторы отображаются на операторы с соответствующей семантикой в базовой службе каталогов. Например, для оператора равенства предположим, что служба каталогов имеет правило соответствия, определяющее «равенство» атрибутов в фильтре. Это правило будет использоваться для проверки равенства атрибутов, указанных в фильтре, с атрибутами объектов в каталоге. Аналогично, если служба каталогов имеет правило сопоставления для упорядочения, это правило будет использоваться для выполнения сравнений «больше» и «меньше».

Не все операторы, определенные в RFC 2254, применимы ко всем атрибутам. Если оператор неприменим, выбрасывается исключение InvalidSearchFilterException.

Результат возвращается в перечислении объектов SearchResult. Каждый объект SearchResult содержит имя объекта и другую информацию об объекте (см. SearchResult). Имя либо относительно целевого контекста поиска (которое задается параметром name), либо является строкой URL. Если целевой контекст включен в перечисление (что возможно, когда cons задает область поиска SearchControls.OBJECT_SCOPE или SearchControls.SUBSTREE_SCOPE), его имя — пустая строка. Объект SearchResult также может содержать атрибуты соответствующего объекта, если аргумент cons указал, что атрибуты должны быть возвращены.

Если у объекта отсутствует запрашиваемый атрибут, этот несуществующий атрибут будет проигнорирован. Запрашиваемые атрибуты, которые у объекта есть, будут возвращены.

Служба каталогов может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

См. также Операционные атрибуты в описании класса.

public NamingEnumeration<SearchResult> search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException

Ищет в заданном контексте или объекте записи, удовлетворяющие заданному фильтру поиска. Выполняет поиск в соответствии с заданными параметрами поиска. См. DirContext.search(Name, String, Object[], SearchControls) для получения подробностей.

public NamingEnumeration<SearchResult> search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) throws NamingException

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

Интерпретация filterExpr основана на RFC 2254. Она может дополнительно содержать переменные вида {i} — где i является целым числом — которые ссылаются на объекты в массиве filterArgs. Интерпретация filterExpr в остальном идентична параметру filter метода search(Name, String, SearchControls).

Когда переменная {i} появляется в фильтре поиска, это указывает на то, что аргумент фильтра filterArgs[i] должен использоваться на этом месте. Такие переменные могут использоваться там, где в грамматике фильтра RFC 2254, раздел 4, появляются конструкции attr, value или matchingrule. Когда строковый аргумент фильтра подставляется вместо переменной, фильтр интерпретируется так, как если бы строка была указана вместо переменной, а все символы, имеющие специальное значение в фильтрах (например, '*'), были экранированы в соответствии с правилами RFC 2254.

Для каталогов, которые не используют строковое представление для некоторых или всех своих атрибутов, аргумент фильтра, соответствующий значению атрибута, может иметь тип, отличный от String. Например, каталоги, поддерживающие несвязанные бинарные атрибуты, должны принимать массивы байтов в качестве аргументов фильтра. Интерпретация (если таковая имеется) аргументов фильтра любого другого типа определяется поставщиком услуг для данного каталога, который отображает операции фильтра на операции с соответствующей семантикой в базовом каталоге.

Этот метод возвращает перечисление результатов. Каждый элемент перечисления содержит имя объекта и другую информацию об объекте (см. SearchResult). Имя является либо относительным к целевому контексту поиска (названному параметром name), либо строкой URL. Если целевой контекст включён в перечисление (как возможно, когда cons задаёт область поиска SearchControls.OBJECT_SCOPE или SearchControls.SUBSTREE_SCOPE), его имя — пустая строка.

SearchResult также может содержать атрибуты соответствия объекта, если аргумент cons указывает на возврат атрибутов.

Если объект не имеет запрошенного атрибута, этот несуществующий атрибут будет проигнорирован. Запрошенные атрибуты, которые есть у объекта, будут возвращены.

Каталог может вернуть больше атрибутов, чем было запрошено (см. Имена типов атрибутов в описании класса), но не имеет права возвращать произвольные, не связанные атрибуты.

Если в этот метод передаётся фильтр поиска с некорректными подстановками переменных, результат не определён. При внесении изменений в этот DirContext, влияние на перечисления, возвращаемые предыдущими вызовами этого метода, не определено.

См. также Операционные атрибуты в описании класса.