Класс KeyStore.Builder

java.lang.Object

java.security.KeyStore.Builder

Внешний класс:: KeyStore

public abstract static class KeyStore.Builder extends Object

Описание объекта KeyStore, который будет создан.

Экземпляр этого класса содержит информацию, необходимую для создания и инициализации объекта KeyStore. Этот процесс запускается при вызове метода getKeyStore().

Это позволяет отделить настройку от создания объекта KeyStore и, например, отложить запрос пароля до момента, когда он понадобится.

С версии:

1.5

См. также:

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

Builder()

Модификатор	Конструктор	Описание
`protected`	Создает новый `Builder`.

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

Модификатор и тип	Метод	Описание
`abstract KeyStore`	`getKeyStore()`	Возвращает `KeyStore`, описанный этим объектом.
`abstract KeyStore.ProtectionParameter`	`getProtectionParameter(String alias)`	Возвращает `ProtectionParameter`, который следует использовать для получения `Entry` с заданным псевдонимом.
`static KeyStore.Builder`	`newInstance(File file, KeyStore.ProtectionParameter protection)`	Возвращает новый объект `Builder`.
`static KeyStore.Builder`	`newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)`	Возвращает новый объект `Builder`.
`static KeyStore.Builder`	`newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)`	Возвращает новый объект `Builder`.
`static KeyStore.Builder`	`newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)`	Возвращает новый `Builder`, содержащий заданный `KeyStore`.

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

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

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

Builder

protected Builder()

Создает новый Builder.

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

getKeyStore

public abstract KeyStore getKeyStore() throws KeyStoreException

Возвращает KeyStore, описанный этим объектом.

Возвращает:: KeyStore, описанный этим объектом
Выбрасывает:: KeyStoreException — если во время операции произошла ошибка, например если KeyStore не удалось создать или загрузить

getProtectionParameter

public abstract KeyStore.ProtectionParameter getProtectionParameter(String alias) throws KeyStoreException

Возвращает ProtectionParameter, который следует использовать для получения Entry с заданным псевдонимом. Перед вызовом этого метода необходимо вызвать метод getKeyStore.

Параметры:: alias — псевдоним записи KeyStore
Возвращает:: ProtectionParameter, который следует использовать для получения Entry с заданным псевдонимом.
Выбрасывает:: NullPointerException — если псевдоним равен null; KeyStoreException — если во время операции произошла ошибка; IllegalStateException — если метод getKeyStore не был вызван до вызова этого метода

newInstance

public static KeyStore.Builder newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)

Возвращает новый Builder, содержащий заданный KeyStore. Метод getKeyStore() возвращенного объекта будет возвращать keyStore, а метод getProtectionParameter() будет возвращать protectionParameters.

Это полезно, если существующий объект KeyStore необходимо использовать с API, основанными на Builder.

Параметры:: keyStore — KeyStore, который необходимо поместить в объект-оболочку; protectionParameter — ProtectionParameter, используемый для защиты записей KeyStore
Возвращает:: новый объект Builder
Выбрасывает:: NullPointerException — если keyStore или protectionParameter равен null; IllegalArgumentException — если keyStore не был инициализирован

newInstance

public static KeyStore.Builder newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protection)

Возвращает новый объект Builder.

При первом вызове метода getKeyStore() для возвращенного построителя будет создан KeyStore типа type и вызван его метод load(). Аргумент inputStream создается на основе file. Если protection является PasswordProtection, пароль получается вызовом метода getPassword. В противном случае, если protection является CallbackHandlerProtection, пароль получается путем вызова CallbackHandler.

Последующие вызовы getKeyStore() возвращают тот же объект, что и первый вызов. Если первый вызов завершился с ошибкой KeyStoreException, последующие вызовы также выбрасывают KeyStoreException.

Экземпляр KeyStore создается из provider, если он не равен null. В противном случае выполняется поиск среди всех установленных поставщиков.

Вызовы getProtectionParameter() возвращают объект PasswordProtection, содержащий пароль, использованный при вызове метода load.

Параметры:: type — тип создаваемого KeyStore; provider — поставщик, из которого будет создан экземпляр KeyStore (или null); file — File, содержащий данные KeyStore; protection — ProtectionParameter, защищающий данные KeyStore
Возвращает:: новый объект Builder
Выбрасывает:: NullPointerException — если type, file или protection равен null; IllegalArgumentException — если protection не является экземпляром PasswordProtection или CallbackHandlerProtection; либо если file не существует или не является обычным файлом

newInstance

public static KeyStore.Builder newInstance(File file, KeyStore.ProtectionParameter protection)

Возвращает новый объект Builder.

При первом вызове метода getKeyStore() для возвращенного построителя будет создан KeyStore с использованием file для определения типа хранилища ключей, после чего будет вызван его метод load(). Для определения типа хранилища ключей используется тот же алгоритм, который описан в KeyStore.getInstance(File, LoadStoreParameter). Аргумент inputStream создается на основе file. Если protection является PasswordProtection, пароль получается вызовом метода getPassword. В противном случае, если protection является CallbackHandlerProtection, пароль получается путем вызова CallbackHandler.

Вызовы getProtectionParameter() возвращают объект PasswordProtection, содержащий пароль, использованный при вызове метода load.

Параметры:: file — File, содержащий данные KeyStore; protection — ProtectionParameter, защищающий данные KeyStore
Возвращает:: новый объект Builder
Выбрасывает:: NullPointerException — если file или protection равен null; IllegalArgumentException — если protection не является экземпляром PasswordProtection или CallbackHandlerProtection; либо если file не существует или не является обычным файлом
С версии:: 9

newInstance

public static KeyStore.Builder newInstance(String type, Provider provider, KeyStore.ProtectionParameter protection)

Возвращает новый объект Builder.

Каждый вызов метода getKeyStore() для возвращенного построителя возвращает новый объект KeyStore типа type. Его метод load() вызывается с использованием LoadStoreParameter, содержащего protection.

Вызовы getProtectionParameter() возвращают protection.

Параметры:: type — тип создаваемого KeyStore; provider — поставщик, из которого будет создан экземпляр KeyStore (или null); protection — ProtectionParameter, защищающий Keystore
Возвращает:: новый объект Builder
Выбрасывает:: NullPointerException — если type или protection равен null

© 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/java/security/KeyStore.Builder.html