Класс Authenticator

java.lang.Object

java.net.Authenticator

public abstract class Authenticator extends Object

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

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

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

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

Since:

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-сервер запрашивает аутентификацию.

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

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

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

Authenticator

public Authenticator()

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

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

setDefault

public static void setDefault(Authenticator a)

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

Параметры:: a — аутентификатор, который нужно задать. Если значение 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()

Возвращает hostname сайта или прокси-сервера, запрашивающего аутентификацию, либо null, если оно недоступно.

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

getRequestingSite

protected final InetAddress getRequestingSite()

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

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

getRequestingPort

protected final int getRequestingPort()

Возвращает номер порта запрошенного подключения.

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

getRequestingProtocol

protected final String getRequestingProtocol()

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

Возвращает:

протокол, за которым может следовать «/версия», где версия — номер версии.

См. также:

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 не указан, этот метод возвращает null.

Возвращает:: URL запроса или null, если он недоступен.
С момента:: 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://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/net/Authenticator.html