Spec-Zone.ru › OpenJDK 25

Класс 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
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • AlgorithmParameters
  • AlgorithmParameterSpec

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

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

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

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
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • Provider

getInstance

public static AlgorithmParameterGenerator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект AlgorithmParameterGenerator для генерации набора параметров, предназначенных для использования с указанным алгоритмом.

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

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

Параметры:
algorithm — имя алгоритма, с которым связан этот генератор параметров. Сведения о стандартных именах алгоритмов см. в разделе AlgorithmParameterGenerator спецификации стандартных имён алгоритмов безопасности Java.
provider — строковое имя Provider.
Возвращает:
новый объект AlgorithmParameterGenerator
Исключения:
IllegalArgumentException — если имя поставщика равно null или пусто
NoSuchAlgorithmException — если у указанного поставщика недоступна реализация AlgorithmParameterGeneratorSpi для указанного алгоритма
NoSuchProviderException — если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException — если algorithm имеет значение null
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • Provider

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
Внешние спецификации
  • Стандартные имена алгоритмов безопасности Java
См. также:
  • 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.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/security/AlgorithmParameterGenerator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API