Класс 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)`	Возвращает ProtectionParameters, которые должны использоваться для получения `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.

Методы, унаследованные от класса java.lang.Object

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

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

Создатель

protected Builder()

Создает новый создатель.

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

getKeyStore

public abstract KeyStore getKeyStore() throws KeyStoreException

Возвращает хранилище ключей, описанное этим объектом.

Возвращает:: хранилище ключей, описанное этим объектом
Издаёт исключение:: KeyStoreException - если во время операции произошла ошибка, например, если хранилище ключей не удалось создать или загрузить

getProtectionParameter

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

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

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

newInstance

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

Возвращает нового создателя, который инкапсулирует заданное хранилище ключей. Метод getKeyStore() возвращаемого объекта будет возвращать keyStore, метод getProtectionParameter() будет возвращать protectionParameters.

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

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

newInstance

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

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

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

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

Хранилище ключей создается из provider если оно не равно null. В противном случае ищутся все установленные поставщики.

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

Обратите внимание, что метод getKeyStore() выполняется в контексте AccessControlContext кода, вызывающего этот метод.

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

newInstance

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

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

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

Обратите внимание, что метод getKeyStore() выполняется в контексте AccessControlContext кода, вызывающего этот метод.

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

newInstance

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

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

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

Вызовы getProtectionParameter() вернут protection.

Обратите внимание, что метод getKeyStore() выполняется в контексте AccessControlContext кода, вызывающего этот метод.

Параметры:: type - тип хранилища ключей, которое должно быть создано; provider - поставщик, из которого должно быть создано хранилище ключей (или null); protection - ProtectionParameter, обеспечивающий безопасность хранилища ключей
Возвращает:: новый объект Builder
Издаёт исключение:: NullPointerException - если тип или защита равны null

© 1993, 2021, 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/17/docs/api/java.base/java/security/KeyStore.Builder.html