Класс AlgorithmParameterGenerator

java.lang.Object

java.security.AlgorithmParameterGenerator

public class AlgorithmParameterGenerator extends Object

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

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

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

В случае, если клиент не инициализирует явно AlgorithmParameterGenerator (через вызов метода init), каждый поставщик должен предоставить (и документировать) значение по умолчанию. См. разделы «Ограничения размера ключа» документа JDK Providers для получения информации о значениях по умолчанию AlgorithmParameterGenerator, используемых поставщиками JDK. Однако обратите внимание, что значения по умолчанию могут различаться в разных поставщиках. Кроме того, значение по умолчанию поставщика может измениться в будущих версиях. Поэтому рекомендуется явно инициализировать 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 Standard Algorithm Names для получения информации о стандартных именах алгоритмов.

Возвращает:

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

Исключения:

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

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

См. также:

getInstance

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

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

Параметры:

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

Возвращает:

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

Исключения:

IllegalArgumentException - если имя поставщика null или пустое

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

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

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

См. также:

getInstance

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

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

Параметры:

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

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