Класс Authenticator

java.lang.Object

java.net.Authenticator

public abstract class Authenticator extends Object

Класс Authenticator представляет собой объект, который знает, как получить аутентификацию для сетевого соединения. Обычно это делается путем запроса информации у пользователя.

Приложения используют этот класс, переопределяя getPasswordAuthentication() в подклассе. Этот метод обычно использует различные методы доступа getXXX() для получения информации об объекте, запрашивающем аутентификацию. Затем он должен получить имя пользователя и пароль, либо взаимодействуя с пользователем, либо каким-то другим неинтерактивным способом. Данные учетных данных возвращаются как значение PasswordAuthentication.

Экземпляр этого конкретного подкласса затем регистрируется в системе путем вызова setDefault(Authenticator). Когда требуется аутентификация, система вызовет один из методов requestPasswordAuthentication(), которые в свою очередь вызовут метод getPasswordAuthentication() зарегистрированного объекта.

Все методы, запрашивающие аутентификацию, имеют реализацию по умолчанию, которая завершается ошибкой.

С тех пор:

1.2

См. также:

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

Модификатор и тип	Класс	Описание
`static enum`	`Authenticator.RequestorType`	Тип объекта, запрашивающего аутентификацию.

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

Конструктор	Описание
`Authenticator()`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`static Authenticator`	`getDefault()`	Возвращает дефолтный аутентификатор.
`protected PasswordAuthentication`	`getPasswordAuthentication()`	Вызывается, когда требуется аутентификация по паролю.
`protected final String`	`getRequestingHost()`	Возвращает `hostname` сайта или прокси, запрашивающего аутентификацию, или `null`, если он недоступен.
`protected final int`	`getRequestingPort()`	Возвращает номер порта для запрошенного соединения.
`protected final String`	`getRequestingPrompt()`	Возвращает строку запроса, предоставленную запрашивающим объектом.
`protected final String`	`getRequestingProtocol()`	Указывает протокол, запрашивающий подключение.
`protected final String`	`getRequestingScheme()`	Возвращает схему запрашивающего объекта (например, схему HTTP для HTTP-брандмауэра).
`protected final InetAddress`	`getRequestingSite()`	Возвращает `InetAddress` сайта, запрашивающего авторизацию, или `null`, если он недоступен.
`protected URL`	`getRequestingURL()`	Возвращает URL, который привел к этому запросу аутентификации.
`protected Authenticator.RequestorType`	`getRequestorType()`	Возвращает, является ли запрашивающий объект прокси или сервером.
`static PasswordAuthentication`	`requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)`	Запрашивает у зарегистрированного в системе аутентификатора пароль.
`static PasswordAuthentication`	`requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)`	Запрашивает у зарегистрированного в системе аутентификатора пароль.
`static PasswordAuthentication`	`requestPasswordAuthentication(Authenticator authenticator, String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)`	Запрашивает у данного `authenticator` пароль.
`static PasswordAuthentication`	`requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)`	Запрашивает у зарегистрированного в системе аутентификатора пароль.
`PasswordAuthentication`	`requestPasswordAuthenticationInstance(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)`	Запрашивает у этого аутентификатора пароль.
`static void`	`setDefault(Authenticator a)`	Устанавливает аутентификатор, который будет использоваться сетевым кодом, когда прокси или HTTP-сервер запрашивает аутентификацию.

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

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

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

Authenticator

public Authenticator()

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

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

setDefault

public static void setDefault(Authenticator a)

Устанавливает аутентификатор, который будет использоваться сетевым кодом, когда прокси или HTTP-сервер запрашивают аутентификацию.

Параметры:: a - Устанавливаемый аутентификатор. Если null, то любой ранее установленный аутентификатор удаляется.

getDefault

public static Authenticator getDefault()

Получает значение по умолчанию аутентификатора.

Возвращает:: Аутентификатор по умолчанию, если задан, null в противном случае.
С:: 9

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, int port, String protocol, String prompt, String scheme)

Запрос пароля у аутентификатора, зарегистрированного в системе.

Параметры:: addr - InetAddress сайта, запрашивающего авторизацию, или null, если неизвестен.; port - порт для запрошенного соединения; protocol - Протокол, запрашивающий соединение (getRequestingProtocol()); prompt - Строка запроса для пользователя; scheme - Схема аутентификации
Возвращает:: Имя пользователя/пароль, или null, если получить не удалось.

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme)

Запрос пароля у аутентификатора, зарегистрированного в системе. Этот метод предпочтительнее, поскольку имя хоста может быть предоставлено в тех случаях, когда InetAddress недоступен.

Параметры:: host - Имя хоста сайта, запрашивающего аутентификацию.; addr - InetAddress сайта, запрашивающего авторизацию, или null, если неизвестен.; port - порт для запрошенного соединения.; protocol - Протокол, запрашивающий соединение (getRequestingProtocol()); prompt - Строка запроса для пользователя, идентифицирующая область аутентификации.; scheme - Схема аутентификации
Возвращает:: Имя пользователя/пароль, или null, если получить не удалось.
С:: 1.4

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)

Запрос пароля у аутентификатора, зарегистрированного в системе.

Параметры:: host - Имя хоста сайта, запрашивающего аутентификацию.; addr - InetAddress сайта, запрашивающего авторизацию, или null, если неизвестен.; port - порт для запрошенного соединения; protocol - Протокол, запрашивающий соединение (getRequestingProtocol()); prompt - Строка запроса для пользователя; scheme - Схема аутентификации; url - URL запроса, вызвавший аутентификацию; reqType - Тип сущности (сервер или прокси), запрашивающей аутентификацию.
Возвращает:: Имя пользователя/пароль, или null, если получить не удалось.
С:: 1.5

requestPasswordAuthentication

public static PasswordAuthentication requestPasswordAuthentication(Authenticator authenticator, String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)

Запрос пароля у заданного authenticator. Если заданный authenticator null, используется аутентификатор, если таковой есть, зарегистрированный в системе с помощью setDefault.

Параметры:: authenticator - аутентификатор или null.; host - Имя хоста сайта, запрашивающего аутентификацию.; addr - InetAddress сайта, запрашивающего авторизацию, или null, если неизвестен.; port - порт для запрошенного соединения; protocol - Протокол, запрашивающий соединение (getRequestingProtocol()); prompt - Строка запроса для пользователя; scheme - Схема аутентификации; url - URL запроса, вызвавший аутентификацию; reqType - Тип сущности (сервер или прокси), запрашивающей аутентификацию.
Возвращает:: Имя пользователя/пароль, или null если получить не удалось.
С:: 9

requestPasswordAuthenticationInstance

public PasswordAuthentication requestPasswordAuthenticationInstance(String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, Authenticator.RequestorType reqType)

Запрос пароля у этого аутентификатора.

Параметры:: host - Имя хоста сайта, запрашивающего аутентификацию.; addr - InetAddress сайта, запрашивающего авторизацию, или null, если неизвестен.; port - порт для запрошенного соединения; protocol - Протокол, запрашивающий соединение (getRequestingProtocol()); prompt - Строка запроса для пользователя; scheme - Схема аутентификации; url - URL запроса, вызвавший аутентификацию; reqType - Тип сущности (сервер или прокси), запрашивающей аутентификацию.
Возвращает:: Имя пользователя/пароль, или null, если получить не удалось
С:: 9

getRequestingHost

protected final String getRequestingHost()

Получает имя хоста сайта или прокси, запрашивающего аутентификацию, или null если недоступно.

Возвращает:: имя хоста соединения, требующего аутентификации, или null, если недоступно.
С:: 1.4

getRequestingSite

protected final InetAddress getRequestingSite()

Получает адрес сайта, запрашивающего авторизацию, или null если недоступно.

Возвращает:: InetAddress сайта, запрашивающего авторизацию, или null, если недоступно.

getRequestingPort

protected final int getRequestingPort()

Получает номер порта для запрошенного соединения.

Возвращает:: число, указывающее порт для запрошенного соединения.

getRequestingProtocol

protected final String getRequestingProtocol()

Возвращает протокол, запрашивающий соединение. Часто он основан на URL, но в будущем JDK он может быть, например, "SOCKS" для защищенного паролем брандмауэра SOCKS5.

Возвращает:

протокол, необязательно с добавлением "/version", где version – номер версии.

См. также:

getRequestingPrompt

protected final String getRequestingPrompt()

Возвращает строку запроса, заданную запрашивающим объектом.

Возвращает:: строку запроса, заданную запрашивающим объектом (область для запросов http)

getRequestingScheme

protected final String getRequestingScheme()

Возвращает схему запрашивающего объекта (например, схему HTTP для HTTP-брандмауэра).

Возвращает:: схему запрашивающего объекта

getPasswordAuthentication

protected PasswordAuthentication getPasswordAuthentication()

Вызывается, когда требуется аутентификация по паролю. Подклассы должны переопределить стандартную реализацию, которая возвращает null.

Возвращает:: PasswordAuthentication, полученный от пользователя, или null, если он не предоставлен.

getRequestingURL

protected URL getRequestingURL()

Возвращает URL, который привел к этому запросу аутентификации.

Возвращает:: запрашиваемый URL
С:: 1.5

getRequestorType

protected Authenticator.RequestorType getRequestorType()

Возвращает, является ли запрашивающий объект прокси или сервером.

Возвращает:: тип аутентификации запрашивающего объекта
С:: 1.5

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