Класс 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

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

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

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.

Возвращает:

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

Выбрасывает:

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

NullPointerException — если algorithm имеет значение null

Внешние спецификации

См. также:

getInstance

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

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

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

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

Параметры:

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.