compact3

javax.naming

Класс ReferralException

java.lang. Объект

java.lang. Throwable

java.lang. Исключение

javax.naming. NamingException

javax.naming. ReferralException

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

Сериализуемый

Прямые Известные Подклассы:

LdapReferralException

public abstract class ReferralException
extends NamingException

Этот абстрактный class используется, чтобы представить исключение отсылки, которое сгенерировано в ответ на отсылку, такую как возвращенное LDAP v3 серверы.

Поставщик услуг обеспечивает подкласс ReferralException, обеспечивая реализации для getReferralInfo() и getReferralContext() (и соответствующие конструкторы и/или соответствующие методы "набора").

Следующий пример кода показывает, как ReferralException может использоваться.

      while (true) {
          try {
              bindings = ctx.listBindings(name);
              while (bindings.hasMore()) {
                  b = bindings.next();
                  ...
              }
              break;
          } catch (ReferralException e) {
              ctx = e.getReferralContext();
          }
      }
 

ReferralException является абстрактный class. Конкретные реализации определяют его свойства синхронизации и сериализации.

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

С тех пор:

1.3

См. Также:

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

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

Поля, наследованные от class javax.naming. NamingException

remainingName, resolvedName, resolvedObj, rootException

Сводка конструктора

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

Модификатор	Конструктор и Описание
protected	ReferralException() Создает новый экземпляр ReferralException.
protected	ReferralException(String explanation) Создает новый экземпляр ReferralException, используя предоставленное объяснение.

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

Модификатор и Тип	Метод и Описание
abstract Context	getReferralContext() Получает контекст, в котором можно продолжать метод.
abstract Context	getReferralContext(Hashtable<?,?> env) Получает контекст, в котором можно продолжать метод, используя свойства среды.
abstract Object	getReferralInfo() Получает информацию (такую как URL) связанный с этой отсылкой.
abstract void	retryReferral() Повторяет отсылку, в настоящий момент обрабатываемую.
abstract boolean	skipReferral() Отбрасывает отсылку, собирающуюся быть обработанным.

Методы, наследованные от class javax.naming. NamingException

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

Методы, наследованные от class java.lang. Throwable

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

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

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

Деталь конструктора

ReferralException

protected ReferralException(String explanation)

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

Параметры:

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

См. Также:

Throwable.getMessage()

ReferralException

protected ReferralException()

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

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

getReferralInfo

public abstract Object getReferralInfo()

Получает информацию (такую как URL) связанный с этой отсылкой. Программа может исследовать или вывести на экран эту информацию пользователю, чтобы определить, продолжать ли с отсылкой, или решить, что дополнительная информация должна быть предоставлена, чтобы продолжать с отсылкой.

Возвраты:

Ненулевая информация об отсылке, связанная с этой отсылкой.

getReferralContext

public abstract Context getReferralContext()
                                    throws NamingException

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

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

Возвраты:

Ненулевой контекст, в котором можно продолжать метод.

Броски:

NamingException - Если с исключением именования встретились. Вызов или retryReferral() или skipReferral(), чтобы продолжать обрабатывать отсылки.

getReferralContext

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

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

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

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

Параметры:

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

Возвраты:

Ненулевой контекст, в котором можно продолжать метод.

Броски:

NamingException - Если с исключением именования встретились. Вызов или retryReferral() или skipReferral(), чтобы продолжать обрабатывать отсылки.

skipReferral

public abstract boolean skipReferral()

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

  } catch (ReferralException e) {
      if (!shallIFollow(e.getReferralInfo())) {
          if (!e.skipReferral()) {
              return;
          }
      }
      ctx = e.getReferralContext();
  }
 

Возвраты:

истина, Если больше обработки отсылки находится на рассмотрении; ложь иначе.

retryReferral

public abstract void retryReferral()

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

  } catch (ReferralException e) {
      while (true) {
          try {
              ctx = e.getReferralContext(env);
              break;
          } catch (NamingException ne) {
              if (! shallIRetry()) {
                  return;
              }
              // modify environment properties (env), if necessary
              e.retryReferral();
          }
      }
  }