Класс Authenticator

java.lang.Object

com.sun.net.httpserver.Authenticator

Прямые известные подклассы:: BasicAuthenticator

public abstract class Authenticator extends Object

Authenticator представляет собой реализацию механизма аутентификации HTTP. Подклассы предоставляют реализации конкретных механизмов, таких как Digest или Basic аутентификация. Экземпляры вызываются для проверки информации об аутентификации, предоставленной во всех входящих запросах. Примечание. Это подразумевает, что любой кэширование учетных данных или другой информации об аутентификации должно выполняться вне этого класса.

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

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

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

Authenticator()

Модификатор	Конструктор	Описание
`protected`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`abstract Authenticator.Result`	`authenticate(HttpExchange exch)`	Вызывается для аутентификации каждого входящего запроса.

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

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

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

Authenticator

protected Authenticator()

Конструктор для вызова подклассами.

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

authenticate

public abstract Authenticator.Result authenticate(HttpExchange exch)

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

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

Параметры:: exch - HttpExchange для которого вызывается authenticate
Возвращает:: результат

© 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/Authenticator.html