Класс AuthProvider

java.security.AuthProvider

Все реализуемые интерфейсы:: Serializable, Cloneable, Map<Object,Object>

public abstract class AuthProvider extends Provider

Этот класс определяет методы входа в систему и выхода из неё для поставщика.

Вызывающие стороны могут вызывать login напрямую, однако поставщик также может вызывать login от имени вызывающих сторон, если определит, что перед выполнением некоторых операций необходимо выполнить вход в систему.

С версии:

1.5

См. также:

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

Вложенные классы и интерфейсы, объявленные в классе Provider

Provider.Service

Модификатор и тип	Класс	Описание
`static class`	`Provider.Service`	Описание службы безопасности.

Краткое описание полей

Поля, объявленные в классе Properties

defaults

Модификатор и тип	Поле	Описание
`protected Properties`	`defaults`	Список свойств, содержащий значения по умолчанию для всех ключей, не найденных в этом списке свойств.

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

AuthProvider(String name,
 double version,
 String info)

AuthProvider(String name,
 String versionStr,
 String info)

Модификатор	Конструктор	Описание
`protected`	Устарел. вместо него используйте `AuthProvider(String, String, String)`.
`protected`	Создаёт поставщика с указанными именем, строкой версии и сведениями.

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

Модификатор и тип	Метод	Описание
`abstract void`	`login(Subject subject, CallbackHandler handler)`	Выполняет вход в систему для этого поставщика.
`abstract void`	`logout()`	Выполняет выход из системы для этого поставщика.
`abstract void`	`setCallbackHandler(CallbackHandler handler)`	Задаёт `CallbackHandler`.

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

clear, compute, computeIfAbsent, computeIfPresent, configure, entrySet, forEach, getInfo, getName, getOrDefault, getService, getServices, getVersion, getVersionStr, isConfigured, keySet, load, merge, put, putAll, putIfAbsent, putService, remove, remove, removeService, replace, replace, replaceAll, toString, values

Модификатор и тип	Метод	Описание
`void`	`clear()`	Очищает этот `Provider`, удаляя свойства, используемые для поиска средств, реализованных `Provider`.
`Object`	`compute(Object key, BiFunction<? super Object, ? super Object, ? extends Object> remappingFunction)`	Пытается вычислить соответствие для указанного ключа и его текущего значения (или `null`, если соответствия нет).
`Object`	`computeIfAbsent(Object key, Function<? super Object, ? extends Object> mappingFunction)`	Если указанный ключ ещё не связан со значением (или ему сопоставлено `null`), пытается вычислить его значение с помощью заданной функции сопоставления и добавляет его в эту карту, если только `null`.
`Object`	`computeIfPresent(Object key, BiFunction<? super Object, ? super Object, ? extends Object> remappingFunction)`	Если для указанного ключа имеется ненулевое значение, пытается вычислить новое соответствие на основе ключа и его текущего значения.
`Provider`	`configure(String configArg)`	Применяет предоставленный аргумент конфигурации к этому экземпляру `Provider` и возвращает настроенный `Provider`.
`Set<Map.Entry<Object,Object>>`	`entrySet()`	Возвращает неизменяемое представление в виде Set записей свойств, содержащихся в этом `Provider`.
`void`	`forEach(BiConsumer<? super Object, ? super Object> action)`	Выполняет указанное действие для каждой записи этой карты, пока не будут обработаны все записи или действие не вызовет исключение.
`String`	`getInfo()`	Возвращает удобочитаемое описание `Provider` и его служб.
`String`	`getName()`	Возвращает имя этого `Provider`.
`Object`	`getOrDefault(Object key, Object defaultValue)`	Возвращает значение, которому сопоставлен указанный ключ, или `defaultValue`, если в этой карте нет соответствия для ключа.
`Provider.Service`	`getService(String type, String algorithm)`	Возвращает службу, описывающую реализацию этим Provider указанного типа алгоритма или псевдонима.
`Set<Provider.Service>`	`getServices()`	Возвращает неизменяемый Set всех служб, поддерживаемых этим `Provider`.
`double`	`getVersion()`	Устарел. вместо него используйте `Provider.getVersionStr()`.
`String`	`getVersionStr()`	Возвращает строку версии этого `Provider`.
`boolean`	`isConfigured()`	Проверяет, настроен ли этот экземпляр `Provider`.
`Set<Object>`	`keySet()`	Возвращает неизменяемое представление в виде Set ключей свойств, содержащихся в этом `Provider`.
`void`	`load(InputStream inStream)`	Считывает список свойств (пары ключей и элементов) из входного потока.
`Object`	`merge(Object key, Object value, BiFunction<? super Object, ? super Object, ? extends Object> remappingFunction)`	Если указанный ключ ещё не связан со значением или связан с `null`, связывает его с заданным значением.
`Object`	`put(Object key, Object value)`	Задаёт для свойства `key` указанное значение `value`.
`void`	`putAll(Map<?,?> t)`	Копирует все соответствия из указанной Map в этот `Provider`.
`Object`	`putIfAbsent(Object key, Object value)`	Если указанный ключ ещё не связан со значением (или ему сопоставлено `null`), связывает его с заданным значением и возвращает `null`, иначе возвращает текущее значение.
`protected void`	`putService(Provider.Service s)`	Добавляет службу.
`Object`	`remove(Object key)`	Удаляет свойство `key` (и соответствующее ему `value`).
`boolean`	`remove(Object key, Object value)`	Удаляет запись для указанного ключа, только если в данный момент ему сопоставлено указанное значение.
`protected void`	`removeService(Provider.Service s)`	Удаляет службу, ранее добавленную с помощью `putService()`.
`Object`	`replace(Object key, Object value)`	Заменяет запись для указанного ключа, только если в данный момент ему сопоставлено какое-либо значение.
`boolean`	`replace(Object key, Object oldValue, Object newValue)`	Заменяет запись для указанного ключа, только если в данный момент ему сопоставлено указанное значение.
`void`	`replaceAll(BiFunction<? super Object, ? super Object, ? extends Object> function)`	Заменяет значение каждой записи результатом вызова заданной функции для этой записи в порядке, в котором записи возвращаются итератором набора записей, пока не будут обработаны все записи или функция не вызовет исключение.
`String`	`toString()`	Возвращает строку с именем и строкой версии этого `Provider`.
`Collection<Object>`	`values()`	Возвращает неизменяемое представление в виде Collection значений свойств, содержащихся в этом `Provider`.

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

getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames

Модификатор и тип	Метод	Описание
`String`	`getProperty(String key)`	Ищет свойство с указанным ключом в этом списке свойств.
`String`	`getProperty(String key, String defaultValue)`	Ищет свойство с указанным ключом в этом списке свойств.
`void`	`list(PrintStream out)`	Выводит этот список свойств в указанный выходной поток.
`void`	`list(PrintWriter out)`	Выводит этот список свойств в указанный выходной поток.
`void`	`load(Reader reader)`	Считывает список свойств (пары ключей и элементов) из входного символьного потока в простом построчном формате.
`void`	`loadFromXML(InputStream in)`	Загружает в эту таблицу свойств все свойства, представленные XML-документом в указанном входном потоке.
`Enumeration<?>`	`propertyNames()`	Возвращает перечисление всех ключей этого списка свойств, включая уникальные ключи списка свойств по умолчанию, если ключ с таким же именем ещё не найден в основном списке свойств.
`void`	`save(OutputStream out, String comments)`	Устарел. Этот метод не выбрасывает IOException, если при сохранении списка свойств возникает ошибка ввода-вывода.
`Object`	`setProperty(String key, String value)`	Вызывает метод `Hashtable` `put`.
`void`	`store(OutputStream out, String comments)`	Записывает этот список свойств (пары ключей и элементов) из этой таблицы `Properties` в выходной поток в формате, пригодном для загрузки в таблицу `Properties` с помощью метода `load(InputStream)`.
`void`	`store(Writer writer, String comments)`	Записывает этот список свойств (пары ключей и элементов) из этой таблицы `Properties` в выходной символьный поток в формате, пригодном для использования метода `load(Reader)`.
`void`	`storeToXML(OutputStream os, String comment)`	Создаёт XML-документ, представляющий все свойства, содержащиеся в этой таблице.
`void`	`storeToXML(OutputStream os, String comment, String encoding)`	Создаёт XML-документ, представляющий все свойства, содержащиеся в этой таблице, с указанной кодировкой.
`void`	`storeToXML(OutputStream os, String comment, Charset charset)`	Создаёт XML-документ, представляющий все свойства, содержащиеся в этой таблице, с указанной кодировкой.
`Set<String>`	`stringPropertyNames()`	Возвращает неизменяемый набор ключей из этого списка свойств, у которых ключ и соответствующее ему значение являются строками; включает уникальные ключи списка свойств по умолчанию, если ключ с таким же именем ещё не найден в основном списке свойств.

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

clone, contains, containsKey, containsValue, elements, equals, get, hashCode, isEmpty, keys, rehash, size

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создаёт поверхностную копию этой хеш-таблицы.
`boolean`	`contains(Object value)`	Проверяет, сопоставлен ли какой-либо ключ с указанным значением в этой хеш-таблице.
`boolean`	`containsKey(Object key)`	Проверяет, является ли указанный объект ключом в этой хеш-таблице.
`boolean`	`containsValue(Object value)`	Возвращает true, если эта хеш-таблица сопоставляет одно или несколько значений с этим значением.
`Enumeration<Object>`	`elements()`	Возвращает перечисление значений в этой хеш-таблице.
`boolean`	`equals(Object o)`	Сравнивает указанный Object с этой Map на равенство согласно определению интерфейса Map.
`Object`	`get(Object key)`	Возвращает значение, которому сопоставлен указанный ключ, или `null`, если в этой карте нет соответствия для ключа.
`int`	`hashCode()`	Возвращает хеш-код этой Map согласно определению интерфейса Map.
`boolean`	`isEmpty()`	Проверяет, не сопоставляет ли эта хеш-таблица ни одного ключа со значениями.
`Enumeration<Object>`	`keys()`	Возвращает перечисление ключей в этой хеш-таблице.
`protected void`	`rehash()`	Увеличивает ёмкость этой хеш-таблицы и реорганизует её внутреннее устройство, чтобы обеспечить более эффективное хранение и доступ к записям.
`int`	`size()`	Возвращает количество ключей в этой хеш-таблице.

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

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

AuthProvider

@Deprecated(since="9") protected AuthProvider(String name, double version, String info)

Устарел.

вместо него используйте AuthProvider(String, String, String).

Создаёт поставщика с указанными именем, номером версии и сведениями.

Параметры:: name — имя поставщика.; version — номер версии поставщика.; info — описание поставщика и его служб.

AuthProvider

protected AuthProvider(String name, String versionStr, String info)

Создаёт поставщика с указанными именем, строкой версии и сведениями.

Параметры:: name — имя поставщика.; versionStr — строка версии поставщика.; info — описание поставщика и его служб.
С версии:: 9

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

login

public abstract void login(Subject subject, CallbackHandler handler) throws LoginException

Выполняет вход в систему для этого поставщика.

Для получения данных аутентификации от вызывающей стороны (например, PIN-кода) поставщик использует CallbackHandler. Если вызывающая сторона передаёт в этот метод обработчик null, поставщик использует обработчик, заданный методом setCallbackHandler. Если обработчик этим методом не задан, поставщик обращается к свойству безопасности auth.login.defaultCallbackHandler, чтобы получить полное имя класса реализации обработчика по умолчанию. Если свойство безопасности не задано, предполагается, что у поставщика есть альтернативные способы получения данных аутентификации.

Параметры:: subject — Subject, который может содержать субъектов/учётные данные, используемые для аутентификации, или может быть дополнен дополнительными субъектами/учётными данными после успешного завершения аутентификации. Этот параметр может быть null.; handler — CallbackHandler, используемый этим поставщиком для получения данных аутентификации от вызывающей стороны; может быть null
Выбрасывает:: IllegalStateException — если поставщику требуется настройка и метод Provider.configure(String) не был вызван; LoginException — если операция входа в систему завершается неудачно

logout

public abstract void logout() throws LoginException

Выполняет выход из системы для этого поставщика.

Выбрасывает:: IllegalStateException — если поставщику требуется настройка и метод Provider.configure(String) не был вызван; LoginException — если операция выхода из системы завершается неудачно

setCallbackHandler

public abstract void setCallbackHandler(CallbackHandler handler)

Задаёт CallbackHandler.

Поставщик использует этот обработчик, если он не передан методу login. Поставщик также использует этот обработчик, если вызывает login от имени вызывающих сторон. В обоих случаях, если обработчик не задан этим методом, поставщик обращается к свойству безопасности auth.login.defaultCallbackHandler, чтобы получить полное имя класса реализации обработчика по умолчанию. Если свойство безопасности не задано, предполагается, что у поставщика есть альтернативные способы получения данных аутентификации.

Параметры:: handler — CallbackHandler для получения данных аутентификации; может быть null
Выбрасывает:: IllegalStateException — если поставщику требуется настройка и метод Provider.configure(String) не был вызван

© 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.