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

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

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

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

Конструктор

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, основанными на билдерах.

Параметры:: 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.

Примечание, что метод getKeyStore() выполняется в рамках AccessControlContext кода, вызвавшего этот метод.

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

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.

Примечание, что метод getKeyStore() выполняется в рамках AccessControlContext кода, вызвавшего этот метод.

Параметры:: 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() на возвращённом билдере вернёт новый объект KeyStore типа type. Его метод load() вызывается с использованием LoadStoreParameter, который инкапсулирует protection.

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

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

Примечание, что метод getKeyStore() выполняется в рамках AccessControlContext кода, вызвавшего этот метод.

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

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