Класс 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

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

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

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

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 является пустой строкой или заключено в кавычки неправильно, как указано в разделе 3.2 RFC 7230. Обратите внимание: любой символ \, используемый для заключения в кавычки, сам должен быть экранирован в исходном коде.

BasicAuthenticator

public BasicAuthenticator(String realm, Charset charset)

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

Примечание по API:: UTF-8 — рекомендуемая кодировка, поскольку информация о ее использовании передается клиенту и поэтому клиент с большей вероятностью также будет ее использовать.
Значение параметра realm будет включено в строку в кавычках.
Параметры:: realm — область базовой HTTP-аутентификации; charset — Charset для декодирования учетных данных, получаемых от клиента
Исключения:: NullPointerException — если realm или charset равны null; IllegalArgumentException — если realm является пустой строкой или заключено в кавычки неправильно, как указано в разделе 3.2 RFC 7230. Обратите внимание: любой символ \, используемый для заключения в кавычки, сам должен быть экранирован в исходном коде.
Начиная с версии:: 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-обмен. Все заголовки ответа, которые необходимо отправить клиенту, задаются в указанном 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.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.httpserver/com/sun/net/httpserver/BasicAuthenticator.html