compact3

javax.naming.directory

Интерфейс DirContext

Все Суперинтерфейсы:

Контекст

Все Известные Подынтерфейсы:

EventDirContext, LdapContext

Все Известные Классы с реализацией:

InitialDirContext, InitialLdapContext

public interface DirContext
extends Context

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

Имена

Каждое имя, которое передают как параметр методу DirContext, относительно того контекста. Пустое название используется, чтобы назвать контекст непосредственно. Параметр имени никогда, возможно, не нуль.

Большинство методов перегрузило версии с одним взятием a Name параметр и одно взятие a String. Эти перегруженные версии эквивалентны в этом если Name и String параметры являются только различными представлениями того же самого имени, тогда перегруженные версии тех же самых методов ведут себя то же самое. В описаниях метода ниже, документируется только одна версия. У второй версии вместо этого есть ссылка к первому: та же самая документация применяется к обоим.

См. Context для обсуждения интерпретации параметра имени методам Context. Эти те же самые правила применяются к параметру имени методам DirContext.

Модели атрибута

Есть две базовых модели того, с чем должны быть связаны атрибуты. Во-первых, атрибуты могут быть непосредственно связаны с объектом DirContext. В этой модели работа атрибута на именованном объекте примерно эквивалентна поиску на имени (который возвращает объект DirContext), сопровождаемый работой атрибута, вызванной на объект DirContext, в котором вызывающая сторона предоставляет пустое название. Атрибуты могут быть просмотрены как сохраненный наряду с объектом (отметьте, что это не подразумевает, что реализация должна сделать так).

Вторая модель - то, что атрибуты связываются с именем (обычно атомарное имя) в DirContext. В этой модели работа атрибута на именованном объекте примерно эквивалентна поиску на имени родительского DirContext именованного объекта, сопровождаемого работой атрибута, вызванной на родителя, в котором вызывающая сторона предоставляет терминальное атомарное имя. Атрибуты могут быть просмотрены как сохраненный в родительском DirContext (снова, это не подразумевает, что реализация должна сделать так). У объектов, которые не являются DirContexts, могут быть атрибуты, пока их родителями является DirContexts.

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

Припишите Имена типов

В методах getAttributes() И search() можно предоставить атрибуты, чтобы возвратиться, предоставляя список названий атрибута (строки). У атрибутов, которые Вы возвращаете, не могло бы быть тех же самых имен как названия атрибута, которые Вы определили. Это - то, потому что некоторые каталоги поддерживают функции, которые заставляют их возвращать другие атрибуты. Такие функции включают разделение на подклассы атрибута, синонимы названия атрибута, и приписывают коды языка.

В разделении на подклассы атрибута атрибуты определяются в иерархии class. В некоторых каталогах, например, атрибут "имени" мог бы быть суперклассом всех связанных с именем атрибутов, включая "commonName" и "фамилию". Выяснение атрибута "имени" могло бы возвратить и атрибуты "commonName" и "фамилии".

С синонимами типа атрибута каталог может присвоить многократные имена к тому же самому атрибуту. Например, "cn" и "commonName" мог бы оба обратиться к тому же самому атрибуту. Выяснение "cn" могло бы возвратить атрибут "commonName".

Некоторые каталоги поддерживают коды языка для атрибутов. Выяснение такого каталога для атрибута "описания", например, могло бы возвратить все следующие атрибуты:

• описание
• описание; Ланген
• описание; lang-de
• описание; lang-франк

Операционные Атрибуты

У некоторых каталогов есть понятие "операционных атрибутов", которые являются атрибутами, связанными с объектом каталога в административных целях. Примером операционных атрибутов является список управления доступом для объекта.

В методах getAttributes() И search() можно определить что все атрибуты, связанные с требуемыми объектами быть возвращенными предоставлением null как список атрибутов, чтобы возвратиться. Возвращенные атрибуты не включают операционные атрибуты. Чтобы получить операционные атрибуты, следует назвать их явно.

Названный Контекст

Есть определенные методы, в которых имя должно решить к контексту (например, ища единственный контекст уровня). Документация таких методов использует термин, названный контекстом, чтобы описать их параметр имени. Для этих методов, если именованным объектом не является DirContext, NotContextException бросается. Кроме этих методов, нет никакого требования что именованный объект быть DirContext.

Параметры

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

Исключения

Все методы в этом интерфейсе могут бросить NamingException или любой из его подклассов. См. NamingException и их подклассы для деталей о каждом исключении.

С тех пор:

1.3

См. Также:

Context

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static int	ADD_ATTRIBUTE Эта константа определяет, чтобы добавить атрибут с указанными значениями.
static int	REMOVE_ATTRIBUTE Эта константа определяет, чтобы удалить указанные значения атрибута из атрибута.
static int	REPLACE_ATTRIBUTE Эта константа определяет, чтобы заменить атрибут указанными значениями.

Поля, наследованные от интерфейса javax.naming. Контекст

APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

Сводка метода

Модификатор и Тип	Метод и Описание
void	bind(Name name, Object obj, Attributes attrs) Связывает имя к объекту, наряду со связанными атрибутами.
void	bind(String name, Object obj, Attributes attrs) Связывает имя к объекту, наряду со связанными атрибутами.
DirContext	createSubcontext(Name name, Attributes attrs) Создает и ограничивает новый контекст, наряду со связанными атрибутами.
DirContext	createSubcontext(String name, Attributes attrs) Создает и ограничивает новый контекст, наряду со связанными атрибутами.
Атрибуты	getAttributes(Name name) Получает все атрибуты, связанные с именованным объектом.
Атрибуты	getAttributes(Name name, String[] attrIds) Получает выбранные атрибуты, связанные с именованным объектом.
Атрибуты	getAttributes(String name) Получает все атрибуты, связанные с именованным объектом.
Атрибуты	getAttributes(String name, String[] attrIds) Получает выбранные атрибуты, связанные с именованным объектом.
DirContext	getSchema(Name name) Получает схему, связанную с именованным объектом.
DirContext	getSchema(String name) Получает схему, связанную с именованным объектом.
DirContext	getSchemaClassDefinition(Name name) Получает контекст, содержащий объекты схемы определений class именованного объекта.
DirContext	getSchemaClassDefinition(String name) Получает контекст, содержащий объекты схемы определений class именованного объекта.
void	modifyAttributes(Name name, int mod_op, Attributes attrs) Изменяет атрибуты, связанные с именованным объектом.
void	modifyAttributes(Name name, ModificationItem[] mods) Изменяет атрибуты, связанные с именованным объектом, используя упорядоченный список модификаций.
void	modifyAttributes(String name, int mod_op, Attributes attrs) Изменяет атрибуты, связанные с именованным объектом.
void	modifyAttributes(String name, ModificationItem[] mods) Изменяет атрибуты, связанные с именованным объектом, используя упорядоченный список модификаций.
void	rebind(Name name, Object obj, Attributes attrs) Связывает имя к объекту, наряду со связанными атрибутами, перезаписывая любую существующую привязку.
void	rebind(String name, Object obj, Attributes attrs) Связывает имя к объекту, наряду со связанными атрибутами, перезаписывая любую существующую привязку.
NamingEnumeration<SearchResult>	search(Name name, Attributes matchingAttributes) Поискы в единственном контексте для объектов, которые содержат указанный набор атрибутов.
NamingEnumeration<SearchResult>	search(Name name, Attributes matchingAttributes, String[] attributesToReturn) Поискы в единственном контексте для объектов, которые содержат указанный набор атрибутов, и получают выбранные атрибуты.
NamingEnumeration<SearchResult>	search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons) Поискы в именованном контексте или объекте для записей, которые удовлетворяют данный фильтр поиска.
NamingEnumeration<SearchResult>	search(Name name, String filter, SearchControls cons) Поискы в именованном контексте или объекте для записей, которые удовлетворяют данный фильтр поиска.
NamingEnumeration<SearchResult>	search(String name, Attributes matchingAttributes) Поискы в единственном контексте для объектов, которые содержат указанный набор атрибутов.
NamingEnumeration<SearchResult>	search(String name, Attributes matchingAttributes, String[] attributesToReturn) Поискы в единственном контексте для объектов, которые содержат указанный набор атрибутов, и получают выбранные атрибуты.
NamingEnumeration<SearchResult>	search(String name, String filterExpr, Object[] filterArgs, SearchControls cons) Поискы в именованном контексте или объекте для записей, которые удовлетворяют данный фильтр поиска.
NamingEnumeration<SearchResult>	search(String name, String filter, SearchControls cons) Поискы в именованном контексте или объекте для записей, которые удовлетворяют данный фильтр поиска.

Методы, наследованные от интерфейса javax.naming. Контекст

addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

Полевая Деталь

ADD_ATTRIBUTE

static final int ADD_ATTRIBUTE

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

Если атрибут не существует, создайте атрибут. У получающегося атрибута есть объединение указанного набора значений и предшествующего набора значений. Добавление атрибута без значения бросит InvalidAttributeValueException если у атрибута должно быть по крайней мере одно значение. Для однозначного атрибута, где тот атрибут уже существует, броски AttributeInUseException. Пытаясь добавить больше чем одно значение к однозначному атрибуту, броскам InvalidAttributeValueException.

Значением этой константы является 1.

См. Также:

ModificationItem, modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), Постоянные Значения полей

REPLACE_ATTRIBUTE

static final int REPLACE_ATTRIBUTE

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

Если атрибут уже существует, заменяет все существующие значения новыми указанными значениями. Если атрибут не существует, создает это. Если никакое значение не определяется, удаляет все значения атрибута. Удаление последнего значения удалит атрибут, если атрибут будет обязан иметь по крайней мере одно значение. Пытаясь добавить больше чем одно значение к однозначному атрибуту, броскам InvalidAttributeValueException.

Значением этой константы является 2.

См. Также:

ModificationItem, modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), Постоянные Значения полей

REMOVE_ATTRIBUTE

static final int REMOVE_ATTRIBUTE

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

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

Значением этой константы является 3.

См. Также:

ModificationItem, modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes), Постоянные Значения полей

Деталь метода

getAttributes

Attributes getAttributes(Name name)
                  throws NamingException

Получает все атрибуты, связанные с именованным объектом. См., что описание class расценивает модели атрибута, припишите имена типов, и операционные атрибуты.

Параметры:

name - имя объекта, от которого можно получить атрибуты

Возвраты:

набор атрибутов, связанных с name. Возвращает пустой набор атрибута, если у имени нет никаких атрибутов; никогда не обнуляйте.

Броски:

NamingException - если с исключением именования встречаются

См. Также:

getAttributes(String), getAttributes(Name, String[])

getAttributes

Attributes getAttributes(String name)
                  throws NamingException

Получает все атрибуты, связанные с именованным объектом. См. getAttributes(Name) для деталей.

Параметры:

name - имя объекта, от которого можно получить атрибуты

Возвраты:

набор атрибутов, связанных с name

Броски:

NamingException - если с исключением именования встречаются

getAttributes

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

Получает выбранные атрибуты, связанные с именованным объектом. См., что описание class расценивает модели атрибута, припишите имена типов, и операционные атрибуты.

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

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

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

Параметры:

name - имя объекта, от которого можно получить атрибуты

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

Возвраты:

требуемые атрибуты; никогда не обнуляйте

Броски:

NamingException - если с исключением именования встречаются

getAttributes

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

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

Параметры:

name - Имя объекта, от которого можно получить атрибуты

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

Возвраты:

требуемые атрибуты; никогда не обнуляйте

Броски:

NamingException - если с исключением именования встречаются

modifyAttributes

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

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

Параметры:

name - имя объекта, атрибуты которого будут обновлены

mod_op - работа модификации, один из: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.

attrs - атрибуты, которые будут использоваться для модификации; возможно, не нуль

Броски:

AttributeModificationException - если модификация не может быть завершена успешно

NamingException - если с исключением именования встречаются

См. Также:

modifyAttributes(Name, ModificationItem[])

modifyAttributes

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

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

Параметры:

name - имя объекта, атрибуты которого будут обновлены

mod_op - работа модификации, один из: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.

attrs - атрибуты, которые будут использоваться для модификации; возможно, не нуль

Броски:

AttributeModificationException - если модификация не может быть завершена успешно

NamingException - если с исключением именования встречаются

modifyAttributes

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

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

Параметры:

name - имя объекта, атрибуты которого будут обновлены

mods - упорядоченная последовательность модификаций, которые будут выполнены; возможно, не нуль

Броски:

AttributeModificationException - если модификации не могут быть завершены успешно

NamingException - если с исключением именования встречаются

См. Также:

modifyAttributes(Name, int, Attributes), ModificationItem

modifyAttributes

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

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

Параметры:

name - имя объекта, атрибуты которого будут обновлены

mods - упорядоченная последовательность модификаций, которые будут выполнены; возможно, не нуль

Броски:

AttributeModificationException - если модификации не могут быть завершены успешно

NamingException - если с исключением именования встречаются

связать

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

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

Параметры:

name - имя, чтобы связать; возможно, не пусто

obj - объект связать; возможно нуль

attrs - атрибуты, чтобы связаться с привязкой

Броски:

NameAlreadyBoundException - если имя уже связывается

InvalidAttributesException - если некоторые "обязательные" атрибуты привязки не предоставляются

NamingException - если с исключением именования встречаются

См. Также:

Context.bind(Name, Object), rebind(Name, Object, Attributes)

связать

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

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

Параметры:

name - имя, чтобы связать; возможно, не пусто

obj - объект связать; возможно нуль

attrs - атрибуты, чтобы связаться с привязкой

Броски:

NameAlreadyBoundException - если имя уже связывается

InvalidAttributesException - если некоторые "обязательные" атрибуты привязки не предоставляются

NamingException - если с исключением именования встречаются

снова переплести

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

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

Параметры:

name - имя, чтобы связать; возможно, не пусто

obj - объект связать; возможно нуль

attrs - атрибуты, чтобы связаться с привязкой

Броски:

InvalidAttributesException - если некоторые "обязательные" атрибуты привязки не предоставляются

NamingException - если с исключением именования встречаются

См. Также:

Context.bind(Name, Object), bind(Name, Object, Attributes)

снова переплести

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

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

Параметры:

name - имя, чтобы связать; возможно, не пусто

obj - объект связать; возможно нуль

attrs - атрибуты, чтобы связаться с привязкой

Броски:

InvalidAttributesException - если некоторые "обязательные" атрибуты привязки не предоставляются

NamingException - если с исключением именования встречаются

createSubcontext

DirContext createSubcontext(Name name,
                            Attributes attrs)
                     throws NamingException

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

Параметры:

name - имя контекста, чтобы создать; возможно, не пусто

attrs - атрибуты, чтобы связаться с недавно создаваемым контекстом

Возвраты:

недавно создаваемый контекст

Броски:

NameAlreadyBoundException - если имя уже связывается

InvalidAttributesException - если attrs не содержит все обязательные атрибуты, требуемые для создания

NamingException - если с исключением именования встречаются

См. Также:

Context.createSubcontext(Name)

createSubcontext

DirContext createSubcontext(String name,
                            Attributes attrs)
                     throws NamingException

Создает и ограничивает новый контекст, наряду со связанными атрибутами. См. createSubcontext(Name, Attributes) для деталей.

Параметры:

name - имя контекста, чтобы создать; возможно, не пусто

attrs - атрибуты, чтобы связаться с недавно создаваемым контекстом

Возвраты:

недавно создаваемый контекст

Броски:

NameAlreadyBoundException - если имя уже связывается

InvalidAttributesException - если attrs не содержит все обязательные атрибуты, требуемые для создания

NamingException - если с исключением именования встречаются

getSchema

DirContext getSchema(Name name)
              throws NamingException

Получает схему, связанную с именованным объектом. Схема описывает правила относительно структуры пространства имен и атрибутов, сохраненных в пределах этого. Схема определяет, какие типы объектов могут быть добавлены к каталогу и где они могут быть добавлены; какие обязательные и дополнительные атрибуты объект может иметь. Диапазон поддержки схем специфичен для каталога.

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

Проблемы, такие как структура и содержание дерева схемы, разрешение, чтобы изменить к содержанию дерева схемы, и эффекту таких модификаций на каталоге зависят от базового каталога.

Параметры:

name - имя объекта, схема которого должна быть получена

Возвраты:

схема связалась с контекстом; никогда не обнуляйте

Броски:

OperationNotSupportedException - если схема, не поддерживаемая

NamingException - если с исключением именования встречаются

getSchema

DirContext getSchema(String name)
              throws NamingException

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

Параметры:

name - имя объекта, схема которого должна быть получена

Возвраты:

схема связалась с контекстом; никогда не обнуляйте

Броски:

OperationNotSupportedException - если схема, не поддерживаемая

NamingException - если с исключением именования встречаются

getSchemaClassDefinition

DirContext getSchemaClassDefinition(Name name)
                             throws NamingException

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

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

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

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

Параметры:

name - имя объекта, объектное определение class которого должно быть получено

Возвраты:

DirContext, содержащий определения class именованного объекта; никогда не обнуляйте

Броски:

OperationNotSupportedException - если схема, не поддерживаемая

NamingException - если с исключением именования встречаются

getSchemaClassDefinition

DirContext getSchemaClassDefinition(String name)
                             throws NamingException

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

Параметры:

name - имя объекта, объектное определение class которого должно быть получено

Возвраты:

DirContext, содержащий определения class именованного объекта; никогда не обнуляйте

Броски:

OperationNotSupportedException - если схема, не поддерживаемая

NamingException - если с исключением именования встречаются

поиск

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

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

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

Атрибут A1 в matchingAttributes как полагают, соответствует атрибуту A2 объекта, если у A1 и A2 есть тот же самый идентификатор, и каждое значение A1 равно некоторому значению A2. Это подразумевает, что порядок значений не является существенным, и что A2 может содержать "дополнительные" значения, не найденные в A1, не влияя на сравнение. Это также подразумевает что, если у A1 нет никаких значений, то тестирование на соответствие эквивалентно тестированию на присутствие атрибута A2 с тем же самым идентификатором.

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

Когда изменения производятся в этом DirContext, эффект на перечисления, возвращенные предшествующими звонками в этот метод, неопределен.

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

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

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

Параметры:

name - имя контекста, чтобы искать

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

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

Возвраты:

ненулевое перечисление объектов SearchResult. Каждый SearchResult содержит атрибуты, идентифицированные attributesToReturn и имя соответствующего объекта, названного относительно контекста, названного name.

Броски:

NamingException - если с исключением именования встречаются

См. Также:

SearchControls, SearchResult, search(Name, String, Object[], SearchControls)

поиск

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

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

Параметры:

name - имя контекста, чтобы искать

matchingAttributes - атрибуты, чтобы искать

attributesToReturn - атрибуты, чтобы возвратиться

Возвраты:

ненулевое перечисление объектов SearchResult

Броски:

NamingException - если с исключением именования встречаются

поиск

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

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

Параметры:

name - имя контекста, чтобы искать

matchingAttributes - атрибуты, чтобы искать

Возвраты:

перечисление объектов SearchResult

Броски:

NamingException - если с исключением именования встречаются

См. Также:

search(Name, Attributes, String[])

поиск

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

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

Параметры:

name - имя контекста, чтобы искать

matchingAttributes - атрибуты, чтобы искать

Возвраты:

перечисление объектов SearchResult

Броски:

NamingException - если с исключением именования встречаются

поиск

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". Провайдер определяет, основанный на ID атрибута ("someCount") (и возможно его схема), что значение атрибута является целым числом. Это тогда анализирует строку "127" соответственно.

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

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

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

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

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

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

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

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

Параметры:

name - имя контекста или объекта искать

filter - выражение фильтра, чтобы использовать для поиска; возможно, не нуль

cons - средства управления поиском, которые управляют поиском. Если ноль, средства управления поиском значения по умолчанию используются (эквивалентный (new SearchControls())).

Возвраты:

перечисление SearchResult s объектов, которые удовлетворяют фильтр; никогда не обнуляйте

Броски:

InvalidSearchFilterException - если определенный фильтр поиска не поддерживается или понимается под базовым каталогом

InvalidSearchControlsException - если средства управления поиском содержат недопустимые настройки

NamingException - если с исключением именования встречаются

См. Также:

search(Name, String, Object[], SearchControls), SearchControls, SearchResult

поиск

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

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

Параметры:

name - имя контекста или объекта искать

filter - выражение фильтра, чтобы использовать для поиска; возможно, не нуль

cons - средства управления поиском, которые управляют поиском. Если ноль, средства управления поиском значения по умолчанию используются (эквивалентный (new SearchControls())).

Возвраты:

перечисление SearchResult s для объектов, которые удовлетворяют фильтр.

Броски:

InvalidSearchFilterException - если определенный фильтр поиска не поддерживается или понимается под базовым каталогом

InvalidSearchControlsException - если средства управления поиском содержат недопустимые настройки

NamingException - если с исключением именования встречаются

поиск

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] должен использоваться в том месте. Такие переменные могут использоваться везде, где attr, значение, или matchingrule производство появляются в грамматике фильтра RFC 2254, раздел 4. Когда оцененным строке параметром фильтра заменяют переменную, фильтр интерпретируется, как будто строка была дана вместо переменной с любыми символами, имеющими специальное значение в пределах фильтров (такой как '*') быть оставленным согласно правилам RFC 2254.

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

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

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

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

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

Если фильтр поиска с недопустимыми переменными заменами обеспечивается для этого метода, результат неопределен. Когда изменения производятся в этом DirContext, эффект на перечисления, возвращенные предшествующими звонками в этот метод, неопределен.

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

Параметры:

name - имя контекста или объекта искать

filterExpr - выражение фильтра, чтобы использовать для поиска. Выражение может содержать переменные формы"{i}"где i неотрицательное целое число., Возможно, не нуль.

filterArgs - массив параметров, чтобы заменить переменные в filterExpr. Значение filterArgs[i] заменит каждое возникновение"{i}". Если ноль, эквивалентный пустому массиву.

cons - средства управления поиском, которые управляют поиском. Если ноль, средства управления поиском значения по умолчанию используются (эквивалентный (new SearchControls())).

Возвраты:

перечисление SearchResult s объектов, которые удовлетворяют фильтр; никогда не обнуляйте

Броски:

ArrayIndexOutOfBoundsException - если filterExpr содержит {i} выражения, где i вне границ массива filterArgs

InvalidSearchControlsException - если cons содержит недопустимые настройки

InvalidSearchFilterException - если filterExpr с filterArgs представляет недопустимый фильтр поиска

NamingException - если с исключением именования встречаются

См. Также:

search(Name, Attributes, String[]), MessageFormat

поиск

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

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

Параметры:

name - имя контекста или объекта искать

filterExpr - выражение фильтра, чтобы использовать для поиска. Выражение может содержать переменные формы"{i}"где i неотрицательное целое число., Возможно, не нуль.

filterArgs - массив параметров, чтобы заменить переменные в filterExpr. Значение filterArgs[i] заменит каждое возникновение"{i}". Если ноль, эквивалентный пустому массиву.

cons - средства управления поиском, которые управляют поиском. Если ноль, средства управления поиском значения по умолчанию используются (эквивалентный (new SearchControls())).

Возвраты:

перечисление SearchResult s объектов, которые удовлетворяют фильтр; никогда не обнуляйте

Броски:

ArrayIndexOutOfBoundsException - если filterExpr содержит {i} выражения, где i вне границ массива filterArgs

InvalidSearchControlsException - если cons содержит недопустимые настройки

InvalidSearchFilterException - если filterExpr с filterArgs представляет недопустимый фильтр поиска

NamingException - если с исключением именования встречаются