Класс InitialDirContext

java.lang.Object

javax.naming.InitialContext

javax.naming.directory.InitialDirContext

Все реализуемые интерфейсы:: Context, DirContext

Прямые известные подклассы:: InitialLdapContext

public class InitialDirContext extends InitialContext implements DirContext

Этот класс является исходным контекстом для выполнения операций с каталогами. Документация в описании класса InitialContext (включая сведения о синхронизации) применима и здесь.

Начиная с:

1.3

См. также:

Краткое описание полей

Поля, объявленные в классе InitialContext

defaultInitCtx, gotDefault, myProps

Модификатор и тип	Поле	Описание
`protected Context`	`defaultInitCtx`	Поле, содержащее результат вызова NamingManager.getInitialContext().
`protected boolean`	`gotDefault`	Поле, указывающее, был ли получен исходный контекст вызовом NamingManager.getInitialContext().
`protected Hashtable<Object,Object>`	`myProps`	Среда, связанная с этим InitialContext.

Поля, объявленные в интерфейсе Context

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

Модификатор и тип	Поле	Описание
`static final String`	`AUTHORITATIVE`	Константа, содержащая имя свойства среды, указывающего степень авторитетности запрошенной службы.
`static final String`	`BATCHSIZE`	Константа, содержащая имя свойства среды, указывающего размер пакета для возврата данных через протокол службы.
`static final String`	`DNS_URL`	Константа, содержащая имя свойства среды, указывающего имена узла и домена DNS для контекста URL JNDI (например, "dns://somehost/wiz.com").
`static final String`	`INITIAL_CONTEXT_FACTORY`	Константа, содержащая имя свойства среды, указывающего используемую фабрику исходного контекста.
`static final String`	`LANGUAGE`	Константа, содержащая имя свойства среды, указывающего предпочтительный язык для использования со службой.
`static final String`	`OBJECT_FACTORIES`	Константа, содержащая имя свойства среды, указывающего список используемых фабрик объектов.
`static final String`	`PROVIDER_URL`	Константа, содержащая имя свойства среды, указывающего сведения о конфигурации для поставщика службы.
`static final String`	`REFERRAL`	Константа, содержащая имя свойства среды, указывающего способ обработки переадресаций, обнаруженных поставщиком службы.
`static final String`	`SECURITY_AUTHENTICATION`	Константа, содержащая имя свойства среды, указывающего используемый уровень безопасности.
`static final String`	`SECURITY_CREDENTIALS`	Константа, содержащая имя свойства среды, указывающего учетные данные субъекта для аутентификации вызывающей стороны в службе.
`static final String`	`SECURITY_PRINCIPAL`	Константа, содержащая имя свойства среды, указывающего идентификатор субъекта для аутентификации вызывающей стороны в службе.
`static final String`	`SECURITY_PROTOCOL`	Константа, содержащая имя свойства среды, указывающего используемый протокол безопасности.
`static final String`	`STATE_FACTORIES`	Константа, содержащая имя свойства среды, указывающего список используемых фабрик состояний.
`static final String`	`URL_PKG_PREFIXES`	Константа, содержащая имя свойства среды, указывающего список префиксов пакетов, используемых при загрузке фабрик контекста URL.

Поля, объявленные в интерфейсе DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

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

Краткое описание конструкторов

InitialDirContext()

InitialDirContext(boolean lazy)

InitialDirContext(Hashtable<?,?> environment)

Модификатор	Конструктор	Описание
	Создает исходный DirContext.
`protected`	Создает исходный DirContext с возможностью не инициализировать его.
	Создает исходный DirContext, используя предоставленную среду.

Краткое описание методов

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

Методы, объявленные в классе InitialContext

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

Модификатор и тип	Метод	Описание
`Object`	`addToEnvironment(String propName, Object propVal)`	Добавляет новое свойство среды в среду этого контекста.
`void`	`bind(String name, Object obj)`	Связывает имя с объектом.
`void`	`bind(Name name, Object obj)`	Связывает имя с объектом.
`void`	`close()`	Закрывает этот контекст.
`String`	`composeName(String name, String prefix)`	Составляет имя этого контекста с именем относительно этого контекста.
`Name`	`composeName(Name name, Name prefix)`	Составляет имя этого контекста с именем относительно этого контекста.
`Context`	`createSubcontext(String name)`	Создает и связывает новый контекст.
`Context`	`createSubcontext(Name name)`	Создает и связывает новый контекст.
`void`	`destroySubcontext(String name)`	Уничтожает именованный контекст и удаляет его из пространства имен.
`void`	`destroySubcontext(Name name)`	Уничтожает именованный контекст и удаляет его из пространства имен.
`static <T> T`	`doLookup(String name)`	Статический метод для получения именованного объекта.
`static <T> T`	`doLookup(Name name)`	Статический метод для получения именованного объекта.
`protected Context`	`getDefaultInitCtx()`	Получает исходный контекст, вызывая `NamingManager.getInitialContext()`, и кэширует его в defaultInitCtx.
`Hashtable<?,?>`	`getEnvironment()`	Получает среду, действующую для этого контекста.
`String`	`getNameInNamespace()`	Получает полное имя этого контекста в его собственном пространстве имен.
`NameParser`	`getNameParser(String name)`	Получает анализатор, связанный с именованным контекстом.
`NameParser`	`getNameParser(Name name)`	Получает анализатор, связанный с именованным контекстом.
`protected Context`	`getURLOrDefaultInitCtx(String name)`	Получает контекст для разрешения строкового имени `name`.
`protected Context`	`getURLOrDefaultInitCtx(Name name)`	Получает контекст для разрешения `name`.
`protected void`	`init(Hashtable<?,?> environment)`	Инициализирует исходный контекст, используя предоставленную среду.
`NamingEnumeration<NameClassPair>`	`list(String name)`	Перечисляет имена, связанные в именованном контексте, а также имена классов привязанных к ним объектов.
`NamingEnumeration<NameClassPair>`	`list(Name name)`	Перечисляет имена, связанные в именованном контексте, а также имена классов привязанных к ним объектов.
`NamingEnumeration<Binding>`	`listBindings(String name)`	Перечисляет имена, связанные в именованном контексте, а также привязанные к ним объекты.
`NamingEnumeration<Binding>`	`listBindings(Name name)`	Перечисляет имена, связанные в именованном контексте, а также привязанные к ним объекты.
`Object`	`lookup(String name)`	Получает именованный объект.
`Object`	`lookup(Name name)`	Получает именованный объект.
`Object`	`lookupLink(String name)`	Получает именованный объект, переходя по ссылкам, кроме конечного атомарного компонента имени.
`Object`	`lookupLink(Name name)`	Получает именованный объект, переходя по ссылкам, кроме конечного атомарного компонента имени.
`void`	`rebind(String name, Object obj)`	Связывает имя с объектом, заменяя существующую привязку.
`void`	`rebind(Name name, Object obj)`	Связывает имя с объектом, заменяя существующую привязку.
`Object`	`removeFromEnvironment(String propName)`	Удаляет свойство среды из среды этого контекста.
`void`	`rename(String oldName, String newName)`	Связывает новое имя с объектом, привязанным к старому имени, и отменяет привязку старого имени.
`void`	`rename(Name oldName, Name newName)`	Связывает новое имя с объектом, привязанным к старому имени, и отменяет привязку старого имени.
`void`	`unbind(String name)`	Отменяет привязку именованного объекта.
`void`	`unbind(Name name)`	Отменяет привязку именованного объекта.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удален в будущей версии. Финализация устарела и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

Подробное описание конструкторов

InitialDirContext

protected InitialDirContext(boolean lazy) throws NamingException

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

Параметры:

lazy - true означает, что начальный DirContext не нужно инициализировать; false эквивалентно вызову new InitialDirContext()

Исключения:

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

Начиная с версии:

1.3

См. также:

InitialDirContext

public InitialDirContext() throws NamingException

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

Исключения:

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

См. также:

InitialDirContext

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

Создает начальный DirContext с использованием переданной environment. Свойства environment описаны в описании класса javax.naming.InitialContext.

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

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

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

Параметры:: environment - environment, используемая для создания начального DirContext. Значение null указывает на пустую environment.
Исключения:: NamingException - если возникло исключение именования

Подробное описание методов

getAttributes

public Attributes getAttributes(String name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

Определено в:: getAttributes в интерфейсе DirContext
Параметры:: name - имя объекта, атрибуты которого нужно получить
Возвращает:: набор атрибутов, связанных с name
Исключения:: NamingException - если возникло исключение именования

getAttributes

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: getAttributes в интерфейсе DirContext
Параметры:: name - имя объекта, атрибуты которого нужно получить; attrIds - идентификаторы атрибутов, которые нужно получить. Значение null указывает, что следует получить все атрибуты; пустой массив указывает, что не следует получать ни одного атрибута.
Возвращает:: запрошенные атрибуты; никогда не null
Исключения:: NamingException - если возникло исключение именования

getAttributes

public Attributes getAttributes(Name name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

Определено в:

getAttributes в интерфейсе DirContext

Параметры:

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

Возвращает:

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

Исключения:

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

См. также:

getAttributes

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

Описание скопировано из интерфейса: DirContext

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

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

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

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

Определено в:: getAttributes в интерфейсе DirContext
Параметры:: name - имя объекта, атрибуты которого нужно получить; attrIds - идентификаторы атрибутов, которые нужно получить. Значение null указывает, что следует получить все атрибуты; пустой массив указывает, что не следует получать ни одного атрибута.
Возвращает:: запрошенные атрибуты; никогда не null
Исключения:: NamingException - если возникло исключение именования

modifyAttributes

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: modifyAttributes в интерфейсе DirContext
Параметры:: name - имя объекта, атрибуты которого будут обновлены; mod_op - операция изменения: одна из следующих: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.; attrs - атрибуты, используемые для изменения; не может быть null
Исключения:: AttributeModificationException - если изменение не удалось успешно завершить; NamingException - если возникло исключение именования

modifyAttributes

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

modifyAttributes в интерфейсе DirContext

Параметры:

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

mod_op - операция изменения: одна из следующих: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, REMOVE_ATTRIBUTE.

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

Исключения:

AttributeModificationException - если изменение не удалось успешно завершить

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

См. также:

modifyAttributes

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: modifyAttributes в интерфейсе DirContext
Параметры:: name - имя объекта, атрибуты которого будут обновлены; mods - упорядоченная последовательность изменений; не может быть null
Исключения:: AttributeModificationException - если изменения не удалось успешно завершить; NamingException - если возникло исключение именования

modifyAttributes

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

modifyAttributes в интерфейсе DirContext

Параметры:

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

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

Исключения:

AttributeModificationException - если изменения не удалось успешно завершить

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

См. также:

bind

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: bind в интерфейсе DirContext
Параметры:: name - имя для связывания; не может быть пустым; obj - объект для связывания; возможно, null; attrs - атрибуты, связываемые с привязкой
Исключения:: NameAlreadyBoundException - если имя уже связано; InvalidAttributesException - если не указаны некоторые «обязательные» атрибуты привязки; NamingException - если возникло исключение именования

bind

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

bind в интерфейсе DirContext

Параметры:

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

obj - объект для связывания; возможно, null

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

Исключения:

NameAlreadyBoundException - если имя уже связано

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

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

См. также:

rebind

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: rebind в интерфейсе DirContext
Параметры:: name - имя для связывания; не может быть пустым; obj - объект для связывания; возможно, null; attrs - атрибуты, связываемые с привязкой
Исключения:: InvalidAttributesException - если не указаны некоторые «обязательные» атрибуты привязки; NamingException - если возникло исключение именования

rebind

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

rebind в интерфейсе DirContext

Параметры:

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

obj - объект для связывания; возможно, null

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

Исключения:

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

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

См. также:

createSubcontext

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: createSubcontext в интерфейсе DirContext
Параметры:: name - имя создаваемого контекста; не может быть пустым; attrs - атрибуты, связываемые с созданным контекстом
Возвращает:: созданный контекст
Исключения:: NameAlreadyBoundException - если имя уже связано; InvalidAttributesException - если attrs не содержит все обязательные для создания атрибуты; NamingException - если возникло исключение именования

createSubcontext

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

createSubcontext в интерфейсе DirContext

Параметры:

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

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

Возвращает:

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

Исключения:

NameAlreadyBoundException - если имя уже связано

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

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

См. также:

getSchema

public DirContext getSchema(String name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

Определено в:: getSchema в интерфейсе DirContext
Параметры:: name - имя объекта, схему которого нужно получить
Возвращает:: схему, связанную с контекстом; никогда не null
Исключения:: OperationNotSupportedException - если схемы не поддерживаются; NamingException - если возникло исключение именования

getSchema

public DirContext getSchema(Name name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

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

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

Определено в:: getSchema в интерфейсе DirContext
Параметры:: name - имя объекта, схему которого нужно получить
Возвращает:: схему, связанную с контекстом; никогда не null
Исключения:: OperationNotSupportedException - если схемы не поддерживаются; NamingException - если возникло исключение именования

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(String name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

Определено в:: getSchemaClassDefinition в интерфейсе DirContext
Параметры:: name - имя объекта, определение класса которого нужно получить
Возвращает:: DirContext, содержащий определения классов именованного объекта; никогда не null
Исключения:: OperationNotSupportedException - если схемы не поддерживаются; NamingException - если возникло исключение именования

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(Name name) throws NamingException

Описание скопировано из интерфейса: DirContext

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

Одна из категорий сведений, содержащихся в схемах каталогов, — это определения классов. Определение «класса объекта» задает тип объекта и атрибуты (обязательные и необязательные), которые объект должен или может иметь. Обратите внимание, что термин «класс объекта» здесь используется в контексте каталогов, а не Java. Например, если именованный объект является объектом каталога класса «Person», getSchemaClassDefinition() вернет DirContext, представляющий определение класса объекта «Person» в каталоге.

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

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

Определено в:: getSchemaClassDefinition в интерфейсе DirContext
Параметры:: name - имя объекта, определение класса которого нужно получить
Возвращает:: DirContext, содержащий определения классов именованного объекта; никогда не null
Исключения:: OperationNotSupportedException - если схемы не поддерживаются; NamingException - если возникло исключение именования

search

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: search в интерфейсе DirContext
Параметры:: name - имя контекста, в котором выполняется поиск; matchingAttributes - атрибуты для поиска
Возвращает:: перечисление объектов SearchResult
Исключения:: NamingException - если возникло исключение именования

search

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

Описание скопировано из интерфейса: DirContext

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

Определено в:

search в интерфейсе DirContext

Параметры:

name - имя контекста, в котором выполняется поиск

matchingAttributes - атрибуты для поиска

Возвращает:

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

Исключения:

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

См. также:

search

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: search в интерфейсе DirContext
Параметры:: name — имя контекста для поиска; matchingAttributes — атрибуты для поиска; attributesToReturn — возвращаемые атрибуты
Возвращает:: ненулевое перечисление объектов SearchResult
Вызывает исключение:: NamingException — при возникновении исключения именования

search

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

Описание скопировано из интерфейса: DirContext

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

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

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

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

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

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

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

Определено в:

search в интерфейсе DirContext

Параметры:

name — имя контекста для поиска

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

attributesToReturn — возвращаемые атрибуты. Значение null указывает, что следует вернуть все атрибуты; пустой массив указывает, что не следует возвращать ни одного атрибута.

Возвращает:

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

Вызывает исключение:

NamingException — при возникновении исключения именования

См. также:

search

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

Описание скопировано из интерфейса: DirContext

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

Определено в:: search в интерфейсе DirContext
Параметры:: name — имя контекста или объекта для поиска; filter — выражение фильтра для поиска; не может быть null; cons — элементы управления поиском. Если значение null, используются элементы управления поиском по умолчанию (эквивалентно (new SearchControls())).
Возвращает:: перечисление SearchResult для объектов, соответствующих фильтру.
Вызывает исключение:: InvalidSearchFilterException — если указанный фильтр поиска не поддерживается базовым каталогом или его смысл не распознан; InvalidSearchControlsException — если элементы управления поиском содержат недопустимые настройки; NamingException — при возникновении исключения именования

search

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

Описание скопировано из интерфейса: DirContext

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

Формат и интерпретация 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 указывает, что атрибуты нужно вернуть.

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

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

Определено в:

search в интерфейсе DirContext

Параметры:

name — имя контекста или объекта для поиска

filter — выражение фильтра для поиска; не может быть null

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

Возвращает:

перечисление SearchResult объектов, соответствующих фильтру; никогда не равно null

Вызывает исключение:

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

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

NamingException — при возникновении исключения именования

См. также:

search

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

Описание скопировано из интерфейса: DirContext

Определено в:: search в интерфейсе DirContext
Параметры:: name — имя контекста или объекта для поиска; filterExpr — выражение фильтра для поиска. Выражение может содержать переменные вида «{i}», где i — неотрицательное целое число. Не может быть null.; filterArgs — массив аргументов для подстановки вместо переменных в filterExpr. Значение filterArgs[i] заменяет каждое вхождение «{i}». Если значение равно null, это эквивалентно пустому массиву.; cons — элементы управления поиском. Если значение null, используются элементы управления поиском по умолчанию (эквивалентно (new SearchControls())).
Возвращает:: перечисление SearchResult объектов, соответствующих фильтру; никогда не равно null
Вызывает исключение:: InvalidSearchControlsException — если cons содержит недопустимые настройки; InvalidSearchFilterException — если filterExpr с filterArgs представляет собой недопустимый фильтр поиска; NamingException — при возникновении исключения именования

search

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

Описание скопировано из интерфейса: DirContext

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

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

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

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

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

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

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

Определено в:

search в интерфейсе DirContext

Параметры:

name — имя контекста или объекта для поиска

filterExpr — выражение фильтра для поиска. Выражение может содержать переменные вида «{i}», где i — неотрицательное целое число. Не может быть null.

filterArgs — массив аргументов для подстановки вместо переменных в filterExpr. Значение filterArgs[i] заменяет каждое вхождение «{i}». Если значение равно null, это эквивалентно пустому массиву.

Возвращает:

перечисление SearchResult объектов, соответствующих фильтру; никогда не равно null

Вызывает исключение:

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

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

NamingException — при возникновении исключения именования

См. также:

© 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.