Spec-Zone.ru › OpenJDK 17

Класс KeyManagerFactory

java.lang.Object
javax.net.ssl.KeyManagerFactory
public class KeyManagerFactory extends Object
Этот класс выступает в качестве фабрики для менеджеров ключей, основанных на источнике ключевого материала. Каждый менеджер ключей управляет конкретным типом ключевого материала, используемого защищенными сокетами. Ключевой материал основан на KeyStore и/или источниках, специфичных для поставщика.
С момента:
1.4
См. также:
  • KeyManager

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

KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Модификатор Конструктор Описание
protected
Создает объект KeyManagerFactory.

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

Модификатор и тип Метод Описание
final String getAlgorithm()
Возвращает имя алгоритма этого объекта KeyManagerFactory.
static final String getDefaultAlgorithm()
Получает имя алгоритма по умолчанию для KeyManagerFactory.
static final KeyManagerFactory getInstance(String algorithm)
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.
static final KeyManagerFactory getInstance(String algorithm, String provider)
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.
static final KeyManagerFactory getInstance(String algorithm, Provider provider)
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.
final KeyManager[] getKeyManagers()
Возвращает один менеджер ключей для каждого типа ключевого материала.
final Provider getProvider()
Возвращает поставщика этого объекта KeyManagerFactory.
final void init(KeyStore ks, char[] password)
Инициализирует эту фабрику с источником ключевого материала.
final void init(ManagerFactoryParameters spec)
Инициализирует эту фабрику с источником ключевого материала, специфичного для поставщика.

Методы, унаследованные от класса java.lang.Object

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

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

KeyManagerFactory

protected KeyManagerFactory(KeyManagerFactorySpi factorySpi, Provider provider, String algorithm)
Создаёт объект KeyManagerFactory.
Параметры:
factorySpi - делегат
provider - поставщик
algorithm - алгоритм

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

getDefaultAlgorithm

public static final String getDefaultAlgorithm()
Получает имя алгоритма KeyManagerFactory по умолчанию.

Алгоритм по умолчанию может быть изменён во время выполнения, установив значение свойства безопасности ssl.KeyManagerFactory.algorithm на желаемое имя алгоритма.

Возвращает:
имя алгоритма по умолчанию, указанное в свойстве безопасности ssl.KeyManagerFactory.algorithm, или реализационно-специфический алгоритм по умолчанию, если такого свойства нет.
См. также:
  • security properties

getAlgorithm

public final String getAlgorithm()
Возвращает имя алгоритма этого объекта KeyManagerFactory.

Это то же имя, которое было указано в одном из вызовов getInstance, создавших этот объект KeyManagerFactory.

Возвращает:
имя алгоритма этого объекта KeyManagerFactory.

getInstance

public static final KeyManagerFactory getInstance(String algorithm) throws NoSuchAlgorithmException
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.

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

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Примечание реализации:
Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security для определения приоритетного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().
Параметры:
algorithm - стандартное имя запрашиваемого алгоритма. См. раздел KeyManagerFactory в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Возвращает:
новый объект KeyManagerFactory
Исключения:
NoSuchAlgorithmException - если ни один Provider не поддерживает реализацию KeyManagerFactorySpi для указанного алгоритма
NullPointerException - если algorithm не null
См. также:
  • Provider

getInstance

public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.

Возвращается новый объект KeyManagerFactory, инкапсулирующий реализацию KeyManagerFactorySpi от указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Параметры:
algorithm - стандартное имя запрашиваемого алгоритма. См. раздел KeyManagerFactory в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
provider - имя поставщика.
Возвращает:
новый объект KeyManagerFactory
Исключения:
IllegalArgumentException - если имя поставщика null или пустое
NoSuchAlgorithmException - если реализация KeyManagerFactorySpi для указанного алгоритма недоступна от указанного поставщика
NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException - если algorithm null
См. также:
  • Provider

getInstance

public static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Возвращает объект KeyManagerFactory, который действует как фабрика для менеджеров ключей.

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

Параметры:
algorithm - стандартное имя запрашиваемого алгоритма. См. раздел KeyManagerFactory в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
provider - экземпляр поставщика.
Возвращает:
новый объект KeyManagerFactory
Исключения:
IllegalArgumentException - если поставщик null
NoSuchAlgorithmException - если реализация @KeyManagerFactorySpi для указанного алгоритма недоступна от указанного объекта Provider
NullPointerException - если algorithm null
См. также:
  • Provider

getProvider

public final Provider getProvider()
Возвращает поставщика этого объекта KeyManagerFactory.
Возвращает:
поставщик этого объекта KeyManagerFactory

init

public final void init(KeyStore ks, char[] password) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableKeyException
Инициализирует эту фабрику с источником материала ключа.

Поставщик обычно использует KeyStore для получения материала ключа, используемого во время переговоров безопасного сокета. KeyStore, как правило, защищен паролем.

Для более гибкой инициализации см. init(ManagerFactoryParameters).

Параметры:
ks - хранилище ключей или null
password - пароль для извлечения ключей из KeyStore
Исключения:
KeyStoreException - если данная операция не выполнена
NoSuchAlgorithmException - если указанный алгоритм недоступен от указанного поставщика.
UnrecoverableKeyException - если ключ не может быть извлечен (например, указанный пароль неверный).

init

public final void init(ManagerFactoryParameters spec) throws InvalidAlgorithmParameterException
Инициализирует эту фабрику с источником материала ключа, специфичного для поставщика.

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

Параметры:
spec - реализация спецификации параметров, специфичных для поставщика
Исключения:
InvalidAlgorithmParameterException - если возникает ошибка

getKeyManagers

public final KeyManager[] getKeyManagers()
Возвращает один менеджер ключей для каждого типа материала ключа.
Возвращает:
менеджеры ключей
Исключения:
IllegalStateException - если KeyManagerFactory не инициализирован

© 1993, 2021, 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/17/docs/api/java.base/javax/net/ssl/KeyManagerFactory.html

Spec-Zone.ru

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