Класс AlgorithmParameterGenerator

java.lang.Object

java.security.AlgorithmParameterGenerator

public class AlgorithmParameterGenerator extends Object

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

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

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

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

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

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

Эти алгоритмы описаны в разделе AlgorithmParameterGenerator спецификации Java Security Standard Algorithm Names. Обратитесь к документации выпуска для вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.

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 для получения информации о стандартных именах алгоритмов.

Возвращает:

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

Исключения:

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

NullPointerException - если algorithm является null

См. также:

getInstance

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

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

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

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

Параметры:

provider - строковое имя Provider.

Возвращает:

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

Исключения:

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

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

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

NullPointerException - если algorithm является null

См. также:

getInstance

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

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

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

Параметры:

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

provider - объект Provider.

Возвращает:

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

Исключения:

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

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

NullPointerException - если algorithm является null

С момента:

1.4

См. также:

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