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

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело и подлежит удалению: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

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.