Класс KeyManagerFactory

java.lang.Object

javax.net.ssl.KeyManagerFactory

public class KeyManagerFactory extends Object

Этот класс выступает в качестве фабрики для менеджеров ключей на основе источника ключевого материала. Каждый менеджер ключей управляет определённым типом ключевого материала, используемого для безопасных сокетов. Ключевой материал базируется на KeyStore и/или специфичных для поставщика источниках.

Since:

1.4

См. также:

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

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

См. также:

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 Reference Implementation также использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

algorithm - стандартное имя запрошенного алгоритма. См. раздел «KeyManagerFactory» в спецификации имен стандартных алгоритмов Java Security здесь, чтобы узнать о стандартных именах алгоритмов.

Возвращает:

новый объект KeyManagerFactory

Исключения:

NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию Provider для указанного алгоритма

NullPointerException - если algorithm является null

См. также:

getInstance

public static final KeyManagerFactory getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

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

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

Параметры:

provider - имя поставщика.

Возвращает:

новый объект KeyManagerFactory

Исключения:

IllegalArgumentException - если имя поставщика является null или пустым

NoSuchAlgorithmException - если реализация KeyManagerFactorySpi для указанного алгоритма недоступна от указанного поставщика

NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности

NullPointerException - если algorithm является null

См. также:

getInstance

public static final KeyManagerFactory getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException

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

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

Параметры:

provider - экземпляр поставщика.

Возвращает:

новый объект KeyManagerFactory

Исключения:

IllegalArgumentException - если поставщик null

NoSuchAlgorithmException - если реализация @KeyManagerFactorySpi для указанного алгоритма недоступна от указанного объекта Provider

NullPointerException - если algorithm является null

См. также:

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, 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/javax/net/ssl/KeyManagerFactory.html