Класс LdapReferralException

javax.naming.ldap.LdapReferralException

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

public abstract class LdapReferralException extends ReferralException

Этот абстрактный класс используется для представления исключения LDAP-перенаправления. Он расширяет базовый ReferralException класс, предоставляя метод getReferralContext(), который принимает управляющие данные запроса. LdapReferralException — абстрактный класс. Конкретные реализации определяют его свойства синхронизации и сериализации.

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

С момента:

1.3

См. также:

Сериализованная форма

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

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

remainingName, resolvedName, resolvedObj, rootException

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

LdapReferralException()

LdapReferralException(String explanation)

Модификатор	Конструктор	Описание
`protected`	Создаёт новый экземпляр LdapReferralException.
`protected`	Создаёт новый экземпляр LdapReferralException с предоставленным пояснением.

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

Модификатор и тип	Метод	Описание
`abstract Context`	`getReferralContext()`	Возвращает контекст, в котором следует продолжить метод, используя среду контекста и без управляющих данных.
`abstract Context`	`getReferralContext(Hashtable<?,?> env)`	Возвращает контекст, в котором следует продолжить метод, используя свойства среды и без управляющих данных.
`abstract Context`	`getReferralContext(Hashtable<?,?> env, Control[] reqCtls)`	Возвращает контекст, в котором следует продолжить метод, используя управляющие данные запроса и свойства среды.

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

getReferralInfo, retryReferral, skipReferral

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

appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

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

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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

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

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

LdapReferralException

protected LdapReferralException(String explanation)

Создаёт новый экземпляр LdapReferralException с предоставленным пояснением. Все остальные поля устанавливаются в null.

Параметры:

explanation - Дополнительные сведения об этом исключении. Может быть null.

См. также:

Throwable.getMessage()

LdapReferralException

protected LdapReferralException()

Создаёт новый экземпляр LdapReferralException. Все поля устанавливаются в null.

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

getReferralContext

public abstract Context getReferralContext() throws NamingException

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

Этот метод эквивалентен

 getReferralContext(ctx.getEnvironment(), null);

где ctx — контекст, который вызвал ReferralException. исключение

Он переопределён в этом классе только для целей документации. См. ReferralException для получения информации о использовании этого метода.

Определяется в:: getReferralContext в классе ReferralException
Возвращает:: Непустой контекст, в котором следует продолжить метод.
Исключения:: NamingException - Если было обнаружено исключение имени. Вызовите либо retryReferral() , либо skipReferral() для продолжения обработки перенаправлений.

getReferralContext

public abstract Context getReferralContext(Hashtable<?,?> env) throws NamingException

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

Этот метод эквивалентен

 getReferralContext(env, null);

Определяется в:: getReferralContext в классе ReferralException
Параметры:: env - Возможно нулевая среда, используемая при получении контекста перенаправления. Если null, свойства среды не будут использоваться.
Возвращает:: Непустой контекст, в котором следует продолжить метод.
Исключения:: NamingException - Если было обнаружено исключение имени. Вызовите либо retryReferral() , либо skipReferral() для продолжения обработки перенаправлений.

getReferralContext

public abstract Context getReferralContext(Hashtable<?,?> env, Control[] reqCtls) throws NamingException

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

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

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

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

Параметры:: reqCtls - Возможно нулевые управляющие данные запроса, используемые для нового контекста. Если null или пустой массив, не используются управляющие данные запроса.; env - Возможно нулевые свойства среды, используемые для нового контекста. Если null, контекст инициализируется без свойств среды.
Возвращает:: Непустой контекст, в котором следует продолжить метод.
Исключения:: NamingException - Если было обнаружено исключение имени. Вызовите либо retryReferral() , либо skipReferral() для продолжения обработки перенаправлений.

© 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/LdapReferralException.html