Класс BasicAuthenticator

java.lang.Object

com.sun.net.httpserver.Authenticator

com.sun.net.httpserver.BasicAuthenticator

public abstract class BasicAuthenticator extends Authenticator

BasicAuthenticator предоставляет реализацию базовой HTTP-аутентификации. Это абстрактный класс, который необходимо расширить, чтобы реализовать checkCredentials(String, String); этот метод вызывается для проверки каждого входящего запроса.

Начиная с:: 1.6

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

Вложенные классы и интерфейсы, объявленные в классе Authenticator

Authenticator.Failure, Authenticator.Result, Authenticator.Retry, Authenticator.Success

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

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

Модификатор и тип	Поле	Описание
`protected final String`	`realm`	Область базовой HTTP-аутентификации.

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

Конструктор	Описание
`BasicAuthenticator(String realm)`	Создает `BasicAuthenticator` для указанной области HTTP-аутентификации.
`BasicAuthenticator(String realm, Charset charset)`	Создает `BasicAuthenticator` для указанной области HTTP-аутентификации и использует заданную `Charset` для декодирования учетных данных базовой аутентификации (имени пользователя и пароля).

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

Модификатор и тип	Метод	Описание
`Authenticator.Result`	`authenticate(HttpExchange t)`	Вызывается для аутентификации каждого входящего запроса.
`abstract boolean`	`checkCredentials(String username, String password)`	Вызывается для каждого входящего запроса, чтобы проверить указанное имя и пароль в контексте области аутентификации этого объекта-аутентификатора.
`String`	`getRealm()`	Возвращает область аутентификации, с которой был создан этот `BasicAuthenticator`.

Методы, объявленные в классе 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 или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или прерывания, либо истечения заданного периода реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или прерывания, либо истечения заданного периода реального времени.

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

realm

protected final String realm

Область базовой HTTP-аутентификации.

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

BasicAuthenticator

public BasicAuthenticator(String realm)

Создает BasicAuthenticator для указанной области HTTP-аутентификации. Учетные данные базовой аутентификации (имя пользователя и пароль) декодируются с использованием default character set платформы.

Примечание к API:: Значение параметра realm будет включено в строку в кавычках.
Параметры:: realm — область базовой HTTP-аутентификации
Исключения:: NullPointerException — если realm имеет значение null; IllegalArgumentException — если realm является пустой строкой или заключен в кавычки некорректно, как указано в RFC 7230, раздел 3.2. Обратите внимание: любой символ \, используемый для заключения в кавычки, должен быть заключен в кавычки и в исходном коде.

BasicAuthenticator

public BasicAuthenticator(String realm, Charset charset)

Создает BasicAuthenticator для указанной области HTTP-аутентификации и использует заданную Charset для декодирования учетных данных базовой аутентификации (имени пользователя и пароля).

Примечание к API:: UTF-8 — рекомендуемая кодировка, поскольку информация о ее использовании передается клиенту, и поэтому клиент с большей вероятностью также будет ее использовать.
Значение параметра realm будет включено в строку в кавычках.
Параметры:: realm — область базовой HTTP-аутентификации; charset — Charset для декодирования учетных данных, полученных от клиента
Исключения:: NullPointerException — если realm или charset имеют значение null; IllegalArgumentException — если realm является пустой строкой или заключен в кавычки некорректно, как указано в RFC 7230, раздел 3.2. Обратите внимание: любой символ \, используемый для заключения в кавычки, должен быть заключен в кавычки и в исходном коде.
Начиная с:: 14

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

getRealm

public String getRealm()

Возвращает область аутентификации, с которой был создан этот BasicAuthenticator.

Возвращает:: строку области аутентификации объекта-аутентификатора

authenticate

public Authenticator.Result authenticate(HttpExchange t)

Описание скопировано из класса: Authenticator

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

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

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

checkCredentials

public abstract boolean checkCredentials(String username, String password)

Вызывается для каждого входящего запроса, чтобы проверить указанные имя и пароль в контексте области аутентификации этого объекта-аутентификатора. Кэширование учетных данных должно выполняться в реализации этого метода.

Параметры:: username — имя пользователя из запроса; password — пароль из запроса
Возвращает:: true, если учетные данные верны, и false в противном случае

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