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

Параметры:: realm - область действия HTTP Basic аутентификации
Исключения:: NullPointerException - если realm null; IllegalArgumentException - если realm пустая строка

BasicAuthenticator

public BasicAuthenticator(String realm, Charset charset)

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

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

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

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