Класс BasicAuthenticator

java.lang.Object

com.sun.net.httpserver.Authenticator

com.sun.net.httpserver.BasicAuthenticator

public abstract class BasicAuthenticator extends Authenticator

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

С момента:: 1.6

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

Вложенные классы/интерфейсы, объявленные в классе com.sun.net.httpserver.Authenticator

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

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

Модификатор и тип	Поле	Описание
`protected final String`	`realm`	Сфера аутентификации HTTP Basic.

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

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

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

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

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

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

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

realm

protected final String realm

Сфера аутентификации HTTP Basic.

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

BasicAuthenticator

public BasicAuthenticator(String realm)

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

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

BasicAuthenticator

public BasicAuthenticator(String realm, Charset charset)

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

Примечание API:: UTF-8 является рекомендуемым кодированием, потому что его использование сообщается клиенту, и, следовательно, он, скорее всего, будет использоваться также клиентом.
Значение параметра realm будет вставлено в строку с кавычками.
Параметры:: realm - сфера аутентификации HTTP Basic; charset - кодировка для декодирования входящих учетных данных от клиента
Исключения:: NullPointerException - если сфера или кодировка являются null; IllegalArgumentException - если сфера пустая или не правильно обрамлена кавычками, как указано в 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.
https://download.java.net/java/early_access/jdk24/docs/api/jdk.httpserver/com/sun/net/httpserver/BasicAuthenticator.html