Класс InitialLdapContext

javax.naming.ldap.InitialLdapContext

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

public class InitialLdapContext extends InitialDirContext implements LdapContext

Этот класс является контекстом начального уровня для выполнения расширенных операций LDAPv3 и управлениями.

Подробности о синхронизации и политике создания контекста начального уровня см. в javax.naming.InitialContext и javax.naming.InitialDirContext.

Управляющие элементы запроса

При создании контекста начального уровня (InitialLdapContext), вы можете указать список управляющих элементов запроса. Эти управляющие элементы будут использоваться в качестве управляющих элементов запроса для любой неявной операции "связывания" LDAP, выполняемой контекстом или контекстами, полученными из контекста. Они называются управляющими элементами запроса соединения. Используйте getConnectControls() для получения управляющих элементов запроса соединения контекста.

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

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

 InitialLdapContext lctx = new InitialLdapContext(env, critConnCtls);
 lctx.setRequestControls(critModCtls);
 lctx.modifyAttributes(name, mods);
 Controls[] respCtls =  lctx.getResponseControls();

Она сначала указывает критические управляющие элементы для создания контекста начального уровня (critConnCtls), а затем устанавливает управляющие элементы запроса контекста (critModCtls) для операции контекста. Если по какой-то причине lctx необходимо повторно подключиться к серверу, он будет использовать critConnCtls. Дополнительную информацию об управляющих элементах запроса см. в интерфейсе LdapContext.

Реализаторы поставщиков услуг должны ознакомиться с разделом "Поставщик услуг" в описании класса LdapContext для получения подробной информации об реализации.

С:

1.3

См. также:

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

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

defaultInitCtx, gotDefault, myProps

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

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

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

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Поля, объявленные в интерфейсе javax.naming.ldap.LdapContext

CONTROL_FACTORIES

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

Конструктор	Описание
`InitialLdapContext()`	Создаёт контекст начального уровня без свойств среды или управляющих элементов запроса соединения.
`InitialLdapContext(Hashtable<?,?> environment, Control[] connCtls)`	Создаёт контекст начального уровня с использованием свойств среды и управляющих элементов запроса соединения.

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

Модификатор и тип	Метод	Описание
`ExtendedResponse`	`extendedOperation(ExtendedRequest request)`	Выполняет расширенную операцию.
`Control[]`	`getConnectControls()`	Возвращает управляющие элементы запроса соединения, действующие для данного контекста.
`Control[]`	`getRequestControls()`	Возвращает управляющие элементы запроса, действующие для данного контекста.
`Control[]`	`getResponseControls()`	Возвращает управляющие элементы ответа, полученные в результате последнего вызова метода в этом контексте.
`LdapContext`	`newInstance(Control[] reqCtls)`	Создаёт новый экземпляр этого контекста, инициализированного с использованием управляющих элементов запроса.
`void`	`reconnect(Control[] connCtls)`	Подключается к серверу LDAP с использованием предоставленных управляющих элементов и среды данного контекста.
`void`	`setRequestControls(Control[] requestControls)`	Устанавливает управляющие элементы запроса для методов, вызываемых впоследствии в этом контексте.

Методы, объявленные в классе javax.naming.directory.InitialDirContext

bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

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

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

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

Методы, объявленные в интерфейсе javax.naming.Context

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

Методы, объявленные в интерфейсе javax.naming.directory.DirContext

bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

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

InitialLdapContext

public InitialLdapContext() throws NamingException

Создаёт контекст начального уровня без использования свойств среды или управляющих элементов запроса соединения. Эквивалентно new InitialLdapContext(null, null).

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

InitialLdapContext

public InitialLdapContext(Hashtable<?,?> environment, Control[] connCtls) throws NamingException

Создаёт контекст начального уровня с использованием свойств среды и управляющих элементов запроса соединения. Подробное описание свойств среды см. в javax.naming.InitialContext.

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

connCtls используются в качестве управляющих элементов запроса соединения для базового экземпляра контекста. Подробности см. в описании класса.

Параметры:

environment - среда, используемая для создания начального DirContext. Null указывает на пустую среду.

connCtls - управляющие элементы запроса соединения для начального контекста. Если null, управляющие элементы запроса соединения не используются.

Исключение:

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

См. также:

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

extendedOperation

public ExtendedResponse extendedOperation(ExtendedRequest request) throws NamingException

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

Выполняет расширенную операцию. Этот метод используется для поддержки расширенных операций LDAPv3.

Определено в:: extendedOperation в интерфейсе LdapContext
Параметры:: request - Запрос, который необходимо выполнить (не null).
Возвращает:: Возможный ответ операции (null). null означает, что операция не сгенерировала никакого ответа.
Исключение:: NamingException - если произошла ошибка при выполнении расширенной операции.

newInstance

public LdapContext newInstance(Control[] reqCtls) throws NamingException

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

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

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

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

newInstance в интерфейсе LdapContext

Параметры:

reqCtls - Возможно null, управляющие элементы запроса, используемые для нового контекста. Если null, контекст инициализируется без управляющих элементов запроса.

Возвращает:

Не null экземпляр LdapContext.

Исключение:

NamingException - если произошла ошибка при создании нового экземпляра.

См. также:

InitialLdapContext

reconnect

public void reconnect(Control[] connCtls) throws NamingException

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

Подключается к серверу LDAP с использованием предоставленных управляющих элементов и среды данного контекста.

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

Этот метод устанавливает управляющие элементы запроса соединения данного контекста в качестве новых управляющих элементов запроса соединения. Управляющие элементы запроса контекста данного контекста не затронуты. После вызова этого метода любые последующие неявные переподключения будут выполняться с использованием connCtls. connCtls также используются в качестве управляющих элементов запроса соединения для новых экземпляров контекста, полученных из этого контекста. Эти управляющие элементы запроса соединения не затронуты setRequestControls().

Реализаторы поставщиков услуг должны прочитать раздел "Поставщик услуг" в описании класса для получения подробностей об их реализации.

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

reconnect в интерфейсе LdapContext

Параметры:

connCtls - Возможно null, управляющие элементы. Если null, управляющие элементы не используются.

Исключение:

NamingException - если произошла ошибка во время переподключения.

См. также:

getConnectControls

public Control[] getConnectControls() throws NamingException

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

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

Определено в:: getConnectControls в интерфейсе LdapContext
Возвращает:: Возможный массив управляющих элементов (null). null означает, что для данного контекста не были установлены управляющие элементы подключения.
Исключение:: NamingException - если произошла ошибка при получении управляющих элементов запроса.

setRequestControls

public void setRequestControls(Control[] requestControls) throws NamingException

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

Устанавливает управляющие элементы запроса для методов, которые будут вызваны позже в этом контексте. Управляющие элементы принадлежат реализации JNDI и являются неизменяемыми. Массив и управляющие элементы не могут быть изменены вызывающим методом.

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

Обратите внимание, что requestControls будут действовать до следующего вызова setRequestControls(). Вам необходимо явно вызвать setRequestControls() с null или пустым массивом, чтобы очистить управляющие элементы, если вы не хотите, чтобы они больше влияли на методы контекста. Чтобы проверить, какие управляющие элементы запроса действуют для данного контекста, используйте getRequestControls().

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

setRequestControls в интерфейсе LdapContext

Параметры:

requestControls - Возможно null, управляющие элементы. Если null, управляющие элементы не используются.

Исключение:

NamingException - если произошла ошибка при установке управляющих элементов запроса.

См. также:

LdapContext.getRequestControls()

getRequestControls

public Control[] getRequestControls() throws NamingException

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

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

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

getRequestControls в интерфейсе LdapContext

Возвращает:

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

Исключение:

NamingException - если произошла ошибка при получении управляющих элементов запроса.

См. также:

LdapContext.setRequestControls(javax.naming.ldap.Control[])

getResponseControls

public Control[] getResponseControls() throws NamingException

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

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

Эти управляющие элементы ответа могут быть сгенерированы успешной или неудачной операцией.

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

Определено в:: getResponseControls в интерфейсе LdapContext
Возвращает:: Возможный массив управляющих элементов (null). Если null, предыдущий метод, вызванный в этом контексте, не сгенерировал никаких управляющих элементов.
Исключение:: NamingException - если произошла ошибка при получении управляющих элементов ответа.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.naming/javax/naming/ldap/InitialLdapContext.html