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

Модификатор и тип	Метод	Описание
`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, либо до истечения заданного промежутка реального времени.

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

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() для возвращенного builder будет создан объект 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 — если тип, файл или объект защиты равен null; IllegalArgumentException — если объект защиты не является экземпляром PasswordProtection или CallbackHandlerProtection; либо если файл не существует или не является обычным файлом

newInstance

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

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

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

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

newInstance

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

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

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

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

Параметры:: type — тип создаваемого объекта KeyStore; provider — провайдер, из которого создается объект KeyStore (или null); protection — объект ProtectionParameter, защищающий Keystore
Возвращает:: новый объект Builder
Вызывает исключение:: NullPointerException — если тип или объект защиты равен 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.