Класс Authenticator

java.lang.Object

com.sun.net.httpserver.Authenticator

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

public abstract class Authenticator extends Object

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

Начиная с:: 1.6

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static class`	`Authenticator.Failure`	Указывает на ошибку аутентификации.
`static class`	`Authenticator.Result`	Базовый класс для типа возвращаемого значения метода `authenticate(HttpExchange)`.
`static class`	`Authenticator.Retry`	Указывает, что необходимо повторить аутентификацию.
`static class`	`Authenticator.Success`	Указывает, что аутентификация прошла успешно и получить principal аутентифицированного пользователя можно, вызвав `Authenticator.Success.getPrincipal()`.

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

Authenticator()

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

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

Модификатор и тип	Метод	Описание
`abstract Authenticator.Result`	`authenticate(HttpExchange exch)`	Вызывается для аутентификации каждого входящего запроса.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова метода notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова метода notify или interrupt, либо до истечения заданного периода реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова метода notify или interrupt, либо до истечения заданного периода реального времени.

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

Authenticator

protected Authenticator()

Конструктор для вызова из подклассов.

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

authenticate

public abstract Authenticator.Result authenticate(HttpExchange exch)

Вызывается для аутентификации каждого входящего запроса. Реализация должна при необходимости возвращать объект Authenticator.Failure, Authenticator.Success или Authenticator.Retry:

Failure означает, что аутентификация завершена, но завершилась неудачей из-за недействительных учетных данных.
Success означает, что аутентификация прошла успешно, а объект Principal, представляющий пользователя, можно получить, вызвав Authenticator.Success.getPrincipal().
Retry означает, что требуется еще один HTTP-обмен. Все заголовки ответа, которые необходимо отправить клиенту, устанавливаются в переданном HttpExchange. Код ответа, который необходимо вернуть, должен быть указан в объекте Retry. Retry может происходить несколько раз.

Параметры:: exch — HttpExchange, для которого вызывается authenticate
Возвращает:: результат

© 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.