Класс AlgorithmParameterGenerator

java.lang.Object

java.security.AlgorithmParameterGenerator

public class AlgorithmParameterGenerator extends Object

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

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

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

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

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

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

Эти алгоритмы описаны в разделе AlgorithmParameterGenerator спецификации стандартных имён алгоритмов безопасности Java. Чтобы узнать, поддерживаются ли другие алгоритмы, обратитесь к документации выпуска вашей реализации.

С версии:

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)`	Инициализирует этот генератор параметров набором значений генерации параметров, зависящих от алгоритма.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определённого времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определённого времени.

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

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 Reference Implementation дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить порядок предпочтения поставщиков для указанного алгоритма. Он может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

Внешние спецификации

См. также:

getInstance

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

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

Возвращается новый объект 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 для генерации набора параметров, используемых с указанным алгоритмом.

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

Параметры:

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

provider — объект Provider.

Возвращает:

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

Выбрасывает:

IllegalArgumentException — если указанный поставщик имеет значение null

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

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.