Spec-Zone.ru › OpenJDK 24

Класс KeyStore.Builder

java.lang.Object
java.security.KeyStore.Builder
Enclosing class:
KeyStore
public abstract static class KeyStore.Builder extends Object
Описание объекта KeyStore, который предстоит создать.

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

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

Since:
1.5
See Also:
  • KeyStore
  • KeyStoreBuilderParameters

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

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.

Параметры:
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() возвращают тот же объект, что и первоначальный вызов. Если первоначальный вызов завершился с ошибкой KeyStoreException, последующие вызовы также генерируют исключение KeyStoreException.

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

Параметры:
file — Файл, содержащий данные хранилища ключей
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.

Параметры:
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.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/security/KeyStore.Builder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API