Класс ReferralException

public abstract class ReferralException
extends NamingException

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

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

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

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

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

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

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

ReferralException

protected ReferralException(String explanation)

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

Параметры:

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

См. также:

Throwable.getMessage()

ReferralException

protected ReferralException()

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

Методы

getReferralInfo

public abstract Object getReferralInfo()

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

Возвращает:

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

getReferralContext

public abstract Context getReferralContext()
                                    throws NamingException

Возвращает:

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

Выбрасывает:

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

getReferralContext

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

Параметры:

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

Возвращает:

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

Выбрасывает:

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

skipReferral

public abstract boolean skipReferral()

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

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

Возвращает:

true, если требуется дальнейшая обработка перенаправлений; иначе — false.

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();
        }
    }
}