Класс NamingException

Все реализованные интерфейсы:
Serializable
Прямые известные подклассы:
AttributeInUseException, AttributeModificationException, CannotProceedException, CommunicationException, ConfigurationException, ContextNotEmptyException, InsufficientResourcesException, InterruptedNamingException, InvalidAttributeIdentifierException, InvalidAttributesException, InvalidAttributeValueException, InvalidNameException, InvalidSearchControlsException, InvalidSearchFilterException, LimitExceededException, LinkException, NameAlreadyBoundException, NameNotFoundException, NamingSecurityException, NoInitialContextException, NoSuchAttributeException, NotContextException, OperationNotSupportedException, PartialResultException, ReferralException, SchemaViolationException, ServiceUnavailableException
public class NamingException
extends Exception

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

  • Разрешенное имя. Часть имени, которая была разрешена.
  • Разрешенный объект. Объект, к которому была выполнена резолюция имени.
  • Остаток имени. Часть имени, которая не была разрешена.
  • Объяснение. Подробное объяснение, почему не удалась резолюция имени.
  • Корневое исключение. Исключение, которое привело к возникновению этого исключения NamingException.
null является допустимым значением для любого из этих полей. При значении null это означает, что для данного поля такая информация не была зафиксирована.

Экземпляр NamingException не синхронизирован по отношению к одновременному доступу из нескольких потоков. Несколько потоков, пытающихся получить доступ и изменить один экземпляр NamingException, должны заблокировать объект.

Это исключение было адаптировано для соответствия общему механизму цепочки исключений. Корневое исключение (или причина ошибки) — это тот же объект, что и причина, возвращаемая методом Throwable.getCause().

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

Поля

Модификатор и тип Поле Описание
protected Name remainingName

Содержит оставшуюся часть имени, которая еще не была разрешена.

protected Name resolvedName

Содержит часть имени, которая была успешно разрешена.

protected Object resolvedObj

Содержит объект, к которому была успешно выполнена резолюция части имени.

protected Throwable rootException

Содержит исходное исключение, которое вызвало это NamingException.

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

Конструктор Описание
NamingException()

Создаёт новый NamingException.

NamingException​(String explanation)

Создаёт новый NamingException с объяснением.

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

Модификатор и тип Метод Описание
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)

Генерирует строковое представление более подробно.

Методы, объявленные в классе 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

Подробное описание полей

resolvedName

protected Name resolvedName

Содержит часть имени, которая была успешно разрешена. Это составное имя и может быть null. Это поле инициализируется конструкторами. Вы должны получать и изменять это поле через методы get и set.

См. также:
getResolvedName(), setResolvedName(javax.naming.Name)

resolvedObj

protected Object resolvedObj

Содержит объект, к которому была успешно выполнена резолюция части имени. Может быть null. Это поле инициализируется конструкторами. Вы должны получать и изменять это поле через методы get и set.

См. также:
getResolvedObj(), setResolvedObj(java.lang.Object)

remainingName

protected Name remainingName

Содержит оставшуюся часть имени, которая ещё не была разрешена. Это составное имя и может быть null. Это поле инициализируется конструкторами. Вы должны получать и изменять это поле через методы get, set, "append".

См. также:
getRemainingName(), setRemainingName(javax.naming.Name), appendRemainingName(javax.naming.Name), appendRemainingComponent(java.lang.String)

rootException

protected Throwable rootException

Содержит исходное исключение, вызвавшее это NamingException. Это поле устанавливается, если есть дополнительная информация, которая может быть получена от исходного исключения, или если исходное исключение не может быть отображено в подкласс NamingException. Может быть null.

Это поле существовало до общего механизма цепочки исключений. Методы initCause(Throwable) и getCause() в настоящее время являются предпочтительными способами доступа к этой информации.

См. также:
getRootCause(), setRootCause(Throwable), initCause(Throwable), getCause()

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

NamingException

public NamingException(String explanation)

Создаёт новый NamingException с объяснением. Все поля, не указанные явно, устанавливаются в null.

Параметры:
explanation - Возможно null строка, содержащая дополнительную информацию об этом исключении.
См. также:
Throwable.getMessage()

NamingException

public NamingException()

Создаёт новый NamingException. Все поля устанавливаются в null.

Методы

getResolvedName

public Name getResolvedName()

Возвращает начальную часть имени, успешно разрешенную.

Возвращает:
Часть имени, успешно разрешенная. Это составное имя. Может быть null, что означает, что поле разрешенного имени не было установлено.
См. также:
getResolvedObj(), setResolvedName(javax.naming.Name)

getRemainingName

public Name getRemainingName()

Возвращает оставшуюся неразрешенную часть имени.

Возвращает:
Часть имени, которая не была разрешена. Это составное имя. Может быть null, что означает, что поле оставшегося имени не было установлено.
См. также:
setRemainingName(javax.naming.Name), appendRemainingName(javax.naming.Name), appendRemainingComponent(java.lang.String)

getResolvedObj

public Object getResolvedObj()

Возвращает объект, которому успешно было произведено разрешение. Это объект, к которому привязано разрешенное имя.

Возвращает:
Возможный null-объект, который был разрешен до сих пор. null означает, что поле разрешенного объекта не было установлено.
См. также:
getResolvedName(), setResolvedObj(java.lang.Object)

getExplanation

public String getExplanation()

Возвращает объяснение, связанное с этим исключением.

Возвращает:
Возможная строка-описание, объясняющая подробнее об этом исключении. Если null, это означает, что нет подробного сообщения об этом исключении.
См. также:
Throwable.getMessage()

setResolvedName

public void setResolvedName(Name name)

Устанавливает поле разрешенного имени этого исключения.

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

Создается и сохраняется копия name. Последующие изменения в name не влияют на копию в этом NamingException, и наоборот.

Параметры:
name - Возможное имя, которое нужно установить для разрешенного имени. Если null, устанавливает поле разрешенного имени в null.
См. также:
getResolvedName()

setRemainingName

public void setRemainingName(Name name)

Устанавливает поле оставшегося имени этого исключения.

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

Создается и сохраняется копия name. Последующие изменения в name не влияют на копию в этом NamingException, и наоборот.

Параметры:
name - Возможное имя, которое нужно установить для оставшегося имени. Если null, устанавливает поле оставшегося имени в null.
См. также:
getRemainingName(), appendRemainingName(javax.naming.Name), appendRemainingComponent(java.lang.String)

setResolvedObj

public void setResolvedObj(Object obj)

Устанавливает поле объекта, которому было произведено разрешение, этого исключения.

Параметры:
obj - Возможный объект, который нужно установить для разрешенного объекта. Если null, поле разрешенного объекта устанавливается в null.
См. также:
getResolvedObj()

appendRemainingComponent

public void appendRemainingComponent(String name)

Добавить имя в качестве последнего компонента в оставшееся имя.

Параметры:
name - Компонент для добавления. Если имя null, этот метод ничего не делает.
См. также:
setRemainingName(javax.naming.Name), getRemainingName(), appendRemainingName(javax.naming.Name)

appendRemainingName

public void appendRemainingName(Name name)

Добавить компоненты из 'имени' в качестве последних компонентов в оставшееся имя.

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

Последующие изменения в name не влияют на поле оставшегося имени в этом NamingException, и наоборот.

Параметры:
name - Возможное имя, содержащее упорядоченные компоненты для добавления. Если имя null, этот метод ничего не делает.
См. также:
setRemainingName(javax.naming.Name), getRemainingName(), appendRemainingComponent(java.lang.String)

getRootCause

public Throwable getRootCause()

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

Этот метод предшествует общему механизму цепочки исключений. Метод getCause() теперь является предпочтительным средством получения этой информации.

Возвращает:
Возможная исключение, которое вызвало это исключение именования. Если null, это означает, что для этого исключения именования не была установлена корневая причина.
См. также:
setRootCause(java.lang.Throwable), rootException, getCause()

setRootCause

public void setRootCause(Throwable e)

Записывает корневую причину этого NamingException. Если e равно this, этот метод ничего не делает.

Этот метод предшествует общему механизму цепочки исключений. Метод initCause(Throwable) теперь является предпочтительным средством записи этой информации.

Параметры:
e - Возможная исключение, которая стала причиной того, что операция именования завершилась неудачно. Если null, это означает, что у этого исключения именования нет корневой причины.
См. также:
getRootCause(), rootException, initCause(java.lang.Throwable)

getCause

public Throwable getCause()

Возвращает причину этого исключения. Причина — это исключение, которое вызвало это исключение именования. Возвращает null если причина отсутствует или неизвестна.

Переопределяет:
getCause в классе Throwable
Возвращает:
причина этого исключения или null если причина отсутствует или неизвестна.
С:
1.4
См. также:
initCause(Throwable)

initCause

public Throwable initCause(Throwable cause)

Инициализирует причину этого исключения указанным значением. Причина — это исключение, которое вызвало это исключение именования.

Этот метод может быть вызван не более одного раза.

Переопределяет:
initCause в классе Throwable
Параметры:
cause — причина, которая сохраняется для последующего извлечения методом getCause(). Значение null указывает, что причина отсутствует или неизвестна.
Возвращает:
ссылка на этот экземпляр NamingException.
Выбрасывает:
IllegalArgumentException — если cause равно этому исключению. (Исключение не может быть своей же причиной.)
IllegalStateException — если этот метод уже был вызван для этого исключения.
С:
1.4
См. также:
getCause()

toString

public String toString()

Генерирует строковое представление этого исключения. Строковое представление состоит из имени класса этого исключения, его подробного сообщения и, если есть корневая причина, строкового представления исключения корневой причины, за которым следует оставшееся имя (если оно не null). Эта строка используется для отладки и не предназначена для программной интерпретации.

Переопределяет:
toString в классе Throwable
Возвращает:
Непустая строка, содержащая строковое представление этого исключения.

toString

public String toString(boolean detail)

Генерирует строковое представление с большей детализацией. Это строковое представление состоит из информации, возвращаемой методом toString(), который не принимает параметров, плюс строковое представление разрешенного объекта (если он не null). Эта строка используется для отладки и не предназначена для программной интерпретации.

Параметры:
detail - Если true, включать подробности о разрешенном объекте помимо другой информации.
Возвращает:
Непустая строка, содержащая строковое представление.

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

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