Spec-Zone.ru › OpenJDK 21

Класс InitialLdapContext

java.lang.Object
javax.naming.InitialContext
javax.naming.directory.InitialDirContext
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
См. также:
  • LdapContext
  • InitialContext
  • InitialDirContext
  • NamingManager.setInitialContextFactoryBuilder(javax.naming.spi.InitialContextFactoryBuilder)

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

Поля, объявленные в классе 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 - если возникло исключение при работе с именами
См. также:
  • reconnect(javax.naming.ldap.Control[])
  • LdapContext.reconnect(javax.naming.ldap.Control[])

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

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, контекст инициализируется без управляющих элементов запроса.
Возвращает:
Экземпляр LdapContext класса.
Исключение:
NamingException - если произошла ошибка при создании нового экземпляра.
См. также:
  • InitialLdapContext

reconnect

public void reconnect(Control[] connCtls) throws NamingException
Описание скопировано из интерфейса: LdapContext
Подключается к серверу LDAP с использованием предоставленных управляющих элементов и среды текущего контекста.

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

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

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

Определено в:
reconnect в интерфейсе LdapContext
Параметры:
connCtls - Возможно null, управляющие элементы. Если null, управляющие элементы не используются.
Исключение:
NamingException - если произошла ошибка при переподключении.
См. также:
  • LdapContext.getConnectControls()
  • LdapContext.newInstance(javax.naming.ldap.Control[])

getConnectControls

public Control[] getConnectControls() throws NamingException
Описание скопировано из интерфейса: LdapContext
Возвращает управляющие элементы запроса соединения, действующие для этого контекста. Управляющие элементы принадлежат реализации JNDI и являются неизменяемыми. Массив и управляющие элементы не могут быть изменены вызывающим методом.
Определено в:
getConnectControls в интерфейсе LdapContext
Возвращает:
Возможный массив управляющих элементов. 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 означает, что для данного контекста управляющие элементы запроса не установлены.
Исключение:
NamingException - если произошла ошибка при получении управляющих элементов запроса.
См. также:
  • LdapContext.setRequestControls(javax.naming.ldap.Control[])

getResponseControls

public Control[] getResponseControls() throws NamingException
Описание скопировано из интерфейса: LdapContext
Возвращает управляющие элементы ответа, полученные в результате последнего метода, вызванного в этом контексте. Управляющие элементы ответа принадлежат реализации JNDI и являются неизменяемыми. Массив и управляющие элементы не могут быть изменены вызывающим методом.

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

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

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

© 1993, 2023, 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/21/docs/api/java.naming/javax/naming/ldap/InitialLdapContext.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API