Класс AlgorithmParameterGenerator

java.lang.Object

java.security.AlgorithmParameterGenerator

public class AlgorithmParameterGenerator extends Object

Класс AlgorithmParameterGenerator используется для генерации набора параметров, используемых с определённым алгоритмом. Генераторы параметров создаются с помощью фабричных методов getInstance (статических методов, возвращающих экземпляры заданного класса).

Объект, который будет генерировать параметры, может быть инициализирован двумя способами: независимо от алгоритма или специфичным для алгоритма:

Подход, независимый от алгоритма, использует тот факт, что все генераторы параметров разделяют понятие «размер» и источник случайности. Мера размера универсальна для всех параметров алгоритмов, хотя интерпретируется по-разному для разных алгоритмов. Например, в случае параметров для алгоритма DSA «размер» соответствует размеру простого модуля (в битах). При использовании этого подхода, значения параметров, специфичные для алгоритма (если таковые имеются), по умолчанию принимают стандартные значения, если они не могут быть получены из указанного размера.
Другой подход инициализирует объект генератора параметров с использованием семантики, специфичной для алгоритма, которая представлена набором значений генерации параметров, специфичных для алгоритма. Например, для генерации параметров системы Диффи-Хеллмана значения генерации параметров обычно включают размер простого модуля и размер случайного показателя, оба указанных в количестве битов.

В случае, если клиент явно не инициализирует AlgorithmParameterGenerator (путем вызова метода init ), каждый поставщик должен предоставить (и задокументировать) значение по умолчанию. См. разделы Ограничений по размеру ключа в документе JDK Providers для получения информации о значениях по умолчанию AlgorithmParameterGenerator, используемых поставщиками JDK. Однако обратите внимание, что значения по умолчанию могут отличаться у разных поставщиков. Кроме того, значение по умолчанию поставщика может измениться в будущих версиях. Поэтому рекомендуется явно инициализировать AlgorithmParameterGenerator, а не полагаться на значения по умолчанию, специфичные для поставщика.

Каждая реализация Java-платформы обязана поддерживать следующие стандартные AlgorithmParameterGenerator алгоритмы и размеры ключей в скобках:

DiffieHellman (1024, 2048)
DSA (1024, 2048)

Эти алгоритмы описаны в разделе «AlgorithmParameterGenerator» спецификации Java Security Standard Algorithm Names Specification по адресу https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#algorithmparametergenerator-algorithms. Обратитесь к документации релиза вашей реализации, чтобы узнать, какие другие алгоритмы поддерживаются.

Since:

1.2

См. также:

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

AlgorithmParameterGenerator(AlgorithmParameterGeneratorSpi paramGenSpi,
 Provider provider,
 String algorithm)

Модификатор	Конструктор	Описание
`protected`	Создаёт объект AlgorithmParameterGenerator.

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

Модификатор и тип	Метод	Описание
`final AlgorithmParameters`	`generateParameters()`	Генерирует параметры.
`final String`	`getAlgorithm()`	Возвращает стандартное имя алгоритма, с которым связан этот генератор параметров.
`static AlgorithmParameterGenerator`	`getInstance(String algorithm)`	Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.
`static AlgorithmParameterGenerator`	`getInstance(String algorithm, String provider)`	Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.
`static AlgorithmParameterGenerator`	`getInstance(String algorithm, Provider provider)`	Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта генератора параметров алгоритма.
`final void`	`init(int size)`	Инициализирует этот генератор параметров для определённого размера.
`final void`	`init(int size, SecureRandom random)`	Инициализирует этот генератор параметров для определённого размера и источника случайности.
`final void`	`init(AlgorithmParameterSpec genParamSpec)`	Инициализирует этот генератор параметров набором значений генерации параметров, специфичных для алгоритма.
`final void`	`init(AlgorithmParameterSpec genParamSpec, SecureRandom random)`	Инициализирует этот генератор параметров набором значений генерации параметров, специфичных для алгоритма.

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

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

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

AlgorithmParameterGenerator

protected AlgorithmParameterGenerator(AlgorithmParameterGeneratorSpi paramGenSpi, Provider provider, String algorithm)

Создаёт объект AlgorithmParameterGenerator.

Параметры:: paramGenSpi - делегат; provider - провайдер; algorithm - алгоритм

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

getAlgorithm

public final String getAlgorithm()

Возвращает стандартное имя алгоритма, с которым связан этот генератор параметров.

Возвращает:: строковое имя алгоритма.

getInstance

public static AlgorithmParameterGenerator getInstance(String algorithm) throws NoSuchAlgorithmException

Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.

Этот метод перебирает список зарегистрированных провайдеров безопасности, начиная с наиболее предпочтительного. Возвращается новый объект AlgorithmParameterGenerator, инкапсулирующий реализацию AlgorithmParameterGeneratorSpi из первого провайдера, поддерживающего указанный алгоритм.

Обратите внимание, что список зарегистрированных провайдеров можно получить с помощью метода Security.getProviders().

Примечание реализации:

Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок провайдеров для указанного алгоритма. Это может отличаться от порядка провайдеров, возвращаемого методом Security.getProviders().

Параметры:

algorithm - имя алгоритма, с которым связан этот генератор параметров. См. раздел AlgorithmParameterGenerator в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.

Возвращает:

новый объект AlgorithmParameterGenerator

Исключения:

NoSuchAlgorithmException - если ни один Provider не поддерживает реализацию AlgorithmParameterGeneratorSpi для указанного алгоритма

NullPointerException - если algorithm имеет значение null

См. также:

Provider

getInstance

public static AlgorithmParameterGenerator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.

Возвращается новый объект AlgorithmParameterGenerator, инкапсулирующий реализацию AlgorithmParameterGeneratorSpi от указанного провайдера. Указанный провайдер должен быть зарегистрирован в списке провайдеров безопасности.

Параметры:

provider - строковое имя провайдера.

Возвращает:

новый объект AlgorithmParameterGenerator

Исключения:

IllegalArgumentException - если имя провайдера null или пустое

NoSuchAlgorithmException - если реализация AlgorithmParameterGeneratorSpi для указанного алгоритма недоступна от указанного провайдера

NoSuchProviderException - если указанный провайдер не зарегистрирован в списке провайдеров безопасности

NullPointerException - если algorithm имеет значение null

См. также:

Provider

getInstance

public static AlgorithmParameterGenerator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException

Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, используемых с указанным алгоритмом.

Возвращается новый объект AlgorithmParameterGenerator, инкапсулирующий реализацию AlgorithmParameterGeneratorSpi от указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке провайдеров.

Параметры:

algorithm - строковое имя алгоритма, с которым связан этот генератор параметров. См. раздел AlgorithmParameterGenerator в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.

provider - объект Provider.

Возвращает:

новый объект AlgorithmParameterGenerator

Исключения:

IllegalArgumentException - если указанный провайдер null

NoSuchAlgorithmException - если реализация AlgorithmParameterGeneratorSpi для указанного алгоритма недоступна от указанного объекта Provider

NullPointerException - если algorithm имеет значение null

С:

1.4

См. также:

Provider

getProvider

public final Provider getProvider()

Возвращает провайдера этого объекта генератора параметров алгоритма.

Возвращает:: провайдер этого объекта генератора параметров алгоритма

init

public final void init(int size)

Инициализирует этот генератор параметров для определённого размера. Для создания параметров используется реализация SecureRandom провайдера с наивысшим приоритетом, установленного в системе, как источник случайности. (Если ни один из установленных провайдеров не предоставляет реализацию SecureRandom, используется системный источник случайности.)

Параметры:: size - размер (количество бит).

init

public final void init(int size, SecureRandom random)

Инициализирует этот генератор параметров для определённого размера и источника случайности.

Параметры:: size - размер (количество бит).; random - источник случайности.

init

public final void init(AlgorithmParameterSpec genParamSpec) throws InvalidAlgorithmParameterException

Инициализирует этот генератор параметров набором значений генерации параметров, специфичных для алгоритма. Для генерации параметров используется реализация SecureRandom провайдера с наивысшим приоритетом, установленного в системе, как источник случайности. (Если ни один из установленных провайдеров не предоставляет реализацию SecureRandom, используется системный источник случайности.)

Параметры:: genParamSpec - набор значений генерации параметров, специфичных для алгоритма.
Исключения:: InvalidAlgorithmParameterException - если заданные значения генерации параметров неподходящие для этого генератора параметров.

init

public final void init(AlgorithmParameterSpec genParamSpec, SecureRandom random) throws InvalidAlgorithmParameterException

Инициализирует этот генератор параметров набором значений генерации параметров, специфичных для алгоритма.

Параметры:: genParamSpec - набор значений генерации параметров, специфичных для алгоритма.; random - источник случайности.
Исключения:: InvalidAlgorithmParameterException - если заданные значения генерации параметров неподходящие для этого генератора параметров.

generateParameters

public final AlgorithmParameters generateParameters()

Генерирует параметры.

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

© 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/AlgorithmParameterGenerator.html