Интерфейс LdapContext

public interface LdapContext
extends DirContext

Этот интерфейс представляет контекст, в котором можно выполнять операции с управлениями LDAPv3-стиля и выполнять расширенные операции LDAPv3-стиля. Для приложений, которым не нужны такие управления или расширенные операции, следует использовать более общий интерфейс javax.naming.directory.DirContext.

Подробности использования управлений

Этот интерфейс предоставляет поддержку управлений LDAP v3. В общем случае эта поддержка позволяет программе-пользователю устанавливать управления запроса для операций LDAP, которые выполняются в ходе вызова методами Context/DirContext программы-пользователя, и читать управления ответа, полученные в результате операций LDAP. На уровне реализации существуют некоторые детали, которые должны понимать разработчики как программы-пользователя, так и поставщики услуг, для корректного использования управлений запроса и ответа.

Управления запроса

Существует два типа управлений запроса:

• Управления запроса, влияющие на создание соединения
• Управления запроса, влияющие на методы контекста

Первый тип используется всякий раз, когда требуется установить или повторно установить соединение с сервером LDAP. Второй тип используется, когда все остальные операции LDAP отправляются на сервер LDAP. Причина, по которой необходимо разграничивать эти два типа управлений запроса, заключается в том, что JNDI — это API высокого уровня, который не работает напрямую с соединениями. Задача поставщиков услуг — выполнять все необходимые операции управления соединениями. Следовательно, одно соединение может быть разделено несколькими экземплярами контекста, и поставщик услуг свободен использовать свои собственные алгоритмы для сохранения соединений и сетевого использования. Таким образом, при вызове метода на экземпляре контекста поставщик услуг, возможно, должен выполнить некоторые операции управления соединениями помимо выполнения соответствующих операций LDAP. Для управления соединениями используется управление запросом соединения, а для обычных операций LDAP используется управление запросом контекста.

Если не указано иное, термин «управления запроса» относится к управлениям запроса контекста.

Управления запроса контекста

Существует два способа, которыми экземпляр контекста получает управления запроса:

1. ldapContext.newInstance(reqCtls)
2. ldapContext.setRequestControls(reqCtls)

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

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

Управления запроса экземпляра контекста извлекаются с помощью метода getRequestControls().

Управления запроса соединения

Существует три способа установки управлений запроса соединения:

1. new InitialLdapContext(env, connCtls)
2. refException.getReferralContext(env, connCtls)
3. ldapContext.reconnect(connCtls);

где refException — экземпляр LdapReferralException, а ldapContext — экземпляр LdapContext. Указание null или пустого массива для connCtls означает отсутствие управлений запроса соединения.

Как и свойства среды, управления запроса соединения контекста наследуются контекстами, которые производятся из него. Обычно вы инициализируете управления запроса соединения, используя конструктор InitialLdapContext или LdapReferralContext.getReferralContext(). Эти управления запроса соединения наследуются контекстами, которые используют одно и то же соединение — то есть контекстами, производными от исходного или контекстов пересылки.

Используйте reconnect() для изменения управлений запроса соединения контекста. Вызов ldapContext.reconnect() влияет только на соединение, используемое ldapContext и любыми новыми экземплярами контекста, которые производятся от ldapContext. Контексты, которые ранее использовали соединение с ldapContext остаются неизменными. То есть управления запроса соединения контекста должны быть явно изменены и не влияют на изменения управлений запроса соединения другого контекста.

Управления запроса соединения экземпляра контекста извлекаются с помощью метода getConnectControls().

Требования к поставщику услуг

Поставщик услуг поддерживает управления запросом соединения и контекста следующим образом. Управления запроса контекста должны быть связаны на основе каждого экземпляра контекста, а управления запросом соединения — на основе каждого экземпляра соединения. Поставщик услуг должен искать управления запросом соединения в свойстве среды «java.naming.ldap.control.connect» и передавать это свойство среды экземплярам контекста, которые он создает.

Управления ответа

Метод LdapContext.getResponseControls() используется для получения управлений ответа, сгенерированных операциями LDAP, выполненными в результате вызова операции Context/DirContext. Результатом являются все управления ответа, сгенерированные базовыми операциями LDAP, включая любое неявное повторное подключение. Чтобы получить только управления ответа повторного подключения, используйте reconnect() и затем getResponseControls().

Параметры

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