Класс 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), который вызывается для проверки каждого входящего запроса.

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

Вложенные классы/интерфейсы, объявленные в классе 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 Note:: Значение параметра realm будет встроено в строку в кавычках.
Параметры:: realm - область аутентификации HTTP Basic
Исключения:: NullPointerException - если область null; IllegalArgumentException - если область пустая или не правильно обрамлена, как указано в RFC 7230 section-3.2. Обратите внимание, что любой \ символ, используемый для обрамления, должен сам быть обрамлен в исходном коде.

BasicAuthenticator

public BasicAuthenticator(String realm, Charset charset)

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

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

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

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, 2023, 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/21/docs/api/jdk.httpserver/com/sun/net/httpserver/BasicAuthenticator.html