Класс KeyManagerFactory

java.lang.Object

javax.net.ssl.KeyManagerFactory

public class KeyManagerFactory extends Object

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

Начиная с версии:

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

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

Параметры:

algorithm — стандартное название запрашиваемого алгоритма. Сведения о стандартных названиях алгоритмов см. в разделе KeyManagerFactory спецификации стандартных названий алгоритмов безопасности Java.

Возвращает:

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

Вызывает исключения:

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

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 — если в указанном объекте Provider отсутствует реализация @KeyManagerFactorySpi для указанного алгоритма

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, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/javax/net/ssl/KeyManagerFactory.html