Класс LdapReferralException

javax.naming.ldap.LdapReferralException

Все реализованные интерфейсы:: Serializable

public abstract class LdapReferralException extends ReferralException

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

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

Начиная с версии:

1.3

См. также:

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

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

remainingName, resolvedName, resolvedObj, rootException

Модификатор и тип	Поле	Описание
`protected Name`	`remainingName`	Содержит оставшуюся часть имени, которая еще не разрешена.
`protected Name`	`resolvedName`	Содержит часть имени, разрешенную успешно.
`protected Object`	`resolvedObj`	Содержит объект, разрешение имени которого завершилось успешно.
`protected Throwable`	`rootException`	Содержит исходное исключение, вызвавшее это исключение NamingException.

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

LdapReferralException()

LdapReferralException(String explanation)

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

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

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

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

getReferralInfo, retryReferral, skipReferral

Модификатор и тип	Метод	Описание
`abstract Object`	`getReferralInfo()`	Возвращает сведения (например, URL-адреса), относящиеся к этому перенаправлению.
`abstract void`	`retryReferral()`	Повторно выполняет обрабатываемое перенаправление.
`abstract boolean`	`skipReferral()`	Отменяет перенаправление, которое должно быть обработано.

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

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

Модификатор и тип	Метод	Описание
`void`	`appendRemainingComponent(String name)`	Добавляет имя в качестве последнего компонента оставшегося имени.
`void`	`appendRemainingName(Name name)`	Добавляет компоненты из 'name' в качестве последних компонентов оставшегося имени.
`Throwable`	`getCause()`	Возвращает причину этого исключения.
`String`	`getExplanation()`	Возвращает пояснение, связанное с этим исключением.
`Name`	`getRemainingName()`	Возвращает оставшуюся неразрешенную часть имени.
`Name`	`getResolvedName()`	Возвращает начальную часть имени, разрешенную успешно.
`Object`	`getResolvedObj()`	Возвращает объект, разрешение которого завершилось успешно.
`Throwable`	`getRootCause()`	Возвращает корневую причину этого исключения NamingException, если она есть.
`Throwable`	`initCause(Throwable cause)`	Инициализирует причину этого исключения указанным значением.
`void`	`setRemainingName(Name name)`	Задает поле оставшегося имени этого исключения.
`void`	`setResolvedName(Name name)`	Задает поле разрешенного имени этого исключения.
`void`	`setResolvedObj(Object obj)`	Задает поле разрешенного объекта этого исключения.
`void`	`setRootCause(Throwable e)`	Записывает корневую причину этого исключения NamingException.
`String`	`toString()`	Создает строковое представление этого исключения.
`String`	`toString(boolean detail)`	Создает более подробное строковое представление.

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

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

Модификатор и тип	Метод	Описание
`final void`	`addSuppressed(Throwable exception)`	Добавляет указанное исключение к исключениям, подавленным для передачи этого исключения.
`Throwable`	`fillInStackTrace()`	Заполняет трассировку стека выполнения.
`String`	`getLocalizedMessage()`	Создает локализованное описание этого объекта, выбрасываемого как исключение.
`String`	`getMessage()`	Возвращает строку подробного сообщения этого объекта, выбрасываемого как исключение.
`StackTraceElement[]`	`getStackTrace()`	Предоставляет программный доступ к сведениям трассировки стека, выводимым методом `Throwable.printStackTrace()`.
`final Throwable[]`	`getSuppressed()`	Возвращает массив, содержащий все исключения, которые были подавлены, обычно оператором `try`-with-resources, для передачи этого исключения.
`void`	`printStackTrace()`	Выводит этот объект, выбрасываемый как исключение, и его трассировку в стандартный поток ошибок.
`void`	`printStackTrace(PrintStream s)`	Выводит этот объект, выбрасываемый как исключение, и его трассировку в указанный поток печати.
`void`	`printStackTrace(PrintWriter s)`	Выводит этот объект, выбрасываемый как исключение, и его трассировку в указанный объект PrintWriter.
`void`	`setStackTrace(StackTraceElement[] stackTrace)`	Задает элементы трассировки стека, которые будут возвращаться методом `Throwable.getStackTrace()` и выводиться методом `Throwable.printStackTrace()` и связанными методами.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли другой объект этому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удален в будущей версии. Финализация устарела и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого объекта `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода для этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно в результате уведомления или прерывания, либо пока не истечет заданный промежуток реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ждать, пока он не будет разбужен, обычно в результате уведомления или прерывания, либо пока не истечет заданный промежуток реального времени.

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

LdapReferralException

protected LdapReferralException(String explanation)

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

Параметры:

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

См. также:

LdapReferralException

protected LdapReferralException()

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

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

getReferralContext

public abstract Context getReferralContext() throws NamingException

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

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

 getReferralContext(ctx.getEnvironment(), null);

где ctx — контекст, вызвавший ReferralException.

В этом классе метод переопределен исключительно для документирования. Описание использования этого метода см. в разделе ReferralException.

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

getReferralContext

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

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

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

 getReferralContext(env, null);

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

getReferralContext

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

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

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

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

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

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

© 1993, 2025, 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.