javax.naming.ldap

Интерфейсный LdapContext

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

Контекст, DirContext

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

InitialLdapContext

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 (конверт, 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[], возвращенный любым методом, является неизменным, и не может впоследствии быть изменен или вызывающей стороной или поставщиком услуг.

С тех пор:

1.3

См. Также:

InitialLdapContext, LdapReferralException.getReferralContext(java.util.Hashtable,javax.naming.ldap.Control[])

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

Поля

Модификатор и Тип	Поле и Описание
static String	CONTROL_FACTORIES Постоянный, который содержит имя свойства среды для того, чтобы определить список фабрик управления, чтобы использовать.

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

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, 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

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

Методы

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

Методы, наследованные от интерфейса 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

Методы, наследованные от интерфейса 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

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

CONTROL_FACTORIES

static final String CONTROL_FACTORIES

Постоянный, который содержит имя свойства среды для того, чтобы определить список фабрик управления, чтобы использовать. Значение свойства должно быть разделенным от двоеточия списком полностью определенных имен классов классов фабрики, которые создадут управление, данное другой контроль. См. ControlFactory.getControlInstance() для деталей. Это свойство может быть определено в среде, параметре апплета, системном свойстве, или одном или более файлах ресурсов.

Значение этой константы является "java.naming.factory.control".

См. Также:

ControlFactory, Context.addToEnvironment(java.lang.String, java.lang.Object), Context.removeFromEnvironment(java.lang.String), Постоянные Значения полей

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

extendedOperation

ExtendedResponse extendedOperation(ExtendedRequest request)
                                   throws NamingException

Выполняет расширенную работу. Этот метод используется, чтобы поддерживать LDAPv3 расширенные операции.

Параметры:

request - Ненулевой запрос, который будет выполнен.

Возвраты:

Возможно нулевой ответ работы. нуль означает, что работа не генерировала ответа.

Броски:

NamingException - Если ошибка произошла, выполняя расширенную работу.

newInstance

LdapContext newInstance(Control[] requestControls)
                        throws NamingException

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

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

Параметры:

requestControls - Возможно нуль запрашивают средства управления использовать для нового контекста. Если ноль, контекст инициализируется без средств управления запросом.

Возвраты:

Ненулевой экземпляр LdapContext.

Броски:

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

См. Также:

InitialLdapContext

переподключение

void reconnect(Control[] connCtls)
               throws NamingException

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

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

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

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

Параметры:

connCtls - Возможно нуль управляет, чтобы использовать. Если ноль, никакие средства управления не используются.

Броски:

NamingException - Если ошибка произошла, повторно соединяясь.

См. Также:

getConnectControls(), newInstance(javax.naming.ldap.Control[])

getConnectControls

Control[] getConnectControls()
                             throws NamingException

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

Возвраты:

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

Броски:

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

setRequestControls

void setRequestControls(Control[] requestControls)
                        throws NamingException

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

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

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

Параметры:

requestControls - Возможно нуль управляет, чтобы использовать. Если ноль, никакие средства управления не используются.

Броски:

NamingException - Если ошибка произошла, устанавливая средства управления запросом.

См. Также:

getRequestControls()

getRequestControls

Control[] getRequestControls()
                             throws NamingException

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

Возвраты:

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

Броски:

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

См. Также:

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

getResponseControls

Control[] getResponseControls()
                              throws NamingException

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

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

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

Возвраты:

Возможно нулевой массив средств управления. Если ноль, предыдущий метод, вызванный на этот контекст, не производил средств управления.

Броски:

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