Класс KeyStore.Builder

java.lang.Object
- java.security.KeyStore.Builder

Вложенный класс:: KeyStore

public abstract static class KeyStore.Builder
extends Object

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

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

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

С тех пор:: 1.5
См. также:: KeyStore, KeyStoreBuilderParameters

Конструкторы

Модификатор	Конструктор	Описание
`protected`	`Builder()`	Создает новый 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

Конструкторы

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

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

Параметры:: alias - псевдоним записи KeyStore
Возвращает:: ProtectionParameters, которые должны использоваться для получения 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 или protectionParameters 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.

Обратите внимание, что метод 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() для возвращаемого объекта builder создаст KeyStore, используя file для определения типа keystore, и затем вызовет его метод load(). Он использует тот же алгоритм определения типа keystore, что и в KeyStore.getInstance(File, LoadStoreParameter). Аргумент inputStream формируется из file. Если protection является PasswordProtection, пароль извлекается, вызывая метод getPassword. В противном случае, если protection является CallbackHandlerProtection, пароль извлекается, вызывая CallbackHandler.

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

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

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

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

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

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

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