Класс LdapReferralException

Все реализованные интерфейсы:
Serializable
public abstract class LdapReferralException
extends ReferralException

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

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

С:
1.3
См. также:
Сериализованная форма

Поля

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

remainingName, resolvedName, resolvedObj, rootException

Конструкторы

Модификатор Конструктор Описание
protected LdapReferralException()

Создаёт новый экземпляр LdapReferralException.

protected LdapReferralException​(String explanation)

Создаёт новый экземпляр 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);

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

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

getReferralContext

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

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

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

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

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

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

© 1993, 2020, 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/11/docs/api/java.naming/javax/naming/ldap/LdapReferralException.html

Spec-Zone .ru
спецификации, руководства, описания, API