Spec-Zone.ru › OpenJDK 8

Класс Authenticator

  • java.lang.Object
    • java.net.Authenticator

public abstract class Authenticator
extends Object

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

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

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

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

Since:
1.2
См. также:
setDefault(java.net.Authenticator), getPasswordAuthentication()

Вложенные классы

Модификатор и тип Класс и описание
static class  Authenticator.RequestorType

Тип сущности, запрашивающей аутентификацию.

Конструкторы

Конструктор и описание
Authenticator()

Методы

Модификатор и тип Метод и описание
protected PasswordAuthentication getPasswordAuthentication()

Вызывается при необходимости аутентификации паролем.

protected String getRequestingHost()

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

protected int getRequestingPort()

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

protected String getRequestingPrompt()

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

protected String getRequestingProtocol()

Указывает протокол, запрашивающий подключение.

protected String getRequestingScheme()

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

protected InetAddress getRequestingSite()

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

protected URL getRequestingURL()

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

protected Authenticator.RequestorType getRequestorType()

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

static PasswordAuthentication requestPasswordAuthentication(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)

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

static PasswordAuthentication requestPasswordAuthentication(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 не позволяет установить аутентификатор по умолчанию.
См. также:
SecurityManager.checkPermission(java.security.Permission), NetPermission

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, если их получить нельзя.
Исключения:
SecurityException - если менеджер безопасности существует и его метод checkPermission не позволяет запросить аутентификацию по паролю.
См. также:
SecurityManager.checkPermission(java.security.Permission), NetPermission

requestPasswordAuthentication

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

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

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

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

requestPasswordAuthentication

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

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

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

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

getRequestingHost

protected final String getRequestingHost()

Получает имя хоста сайта или прокси, запрашивающего аутентификацию, или 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.

Возвращает:
протокол, за которым необязательно следует "/версия", где версия — номер версии.
См. также:
URL.getProtocol()

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, 2020, 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API