Класс 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-сервером.

Сначала, если существует менеджер безопасности, вызывается его метод checkPermission с разрешением NetPermission("setDefaultAuthenticator"). Это может привести к java.lang.SecurityException.

Параметры:

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

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkPermission не разрешает установку аутентификатора по умолчанию.

См. также:

getDefault

public static Authenticator getDefault()

Возвращает аутентификатор по умолчанию. Сначала, если существует менеджер безопасности, вызывается его метод checkPermission с разрешением NetPermission("requestPasswordAuthentication"). Это может привести к java.lang.SecurityException. Затем возвращается аутентификатор по умолчанию, если он установлен. В противном случае возвращается null.

Возвращаемое значение:

Аутентификатор по умолчанию, если установлен, null в противном случае.

Исключения:

SecurityException - если менеджер безопасности существует и его метод checkPermission не разрешает запрос аутентификации паролем.

С:

См. также:

requestPasswordAuthentication

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

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

Сначала, если существует менеджер безопасности, вызывается его метод checkPermission с разрешением NetPermission("requestPasswordAuthentication"). Это может привести к java.lang.SecurityException.

Параметры:

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 если получить их невозможно.

Исключения:

С:

См. также:

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()

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

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

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, 2023, 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/21/docs/api/java.base/java/net/Authenticator.html