Класс 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. Обратитесь к документации выпуска вашей реализации, чтобы узнать, какие ещё алгоритмы поддерживаются.
С:
1.2
См. также:
AlgorithmParameters, AlgorithmParameterSpec

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

Модификатор Конструктор Описание
protected AlgorithmParameterGenerator​(AlgorithmParameterGeneratorSpi paramGenSpi, Provider provider, String algorithm)

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

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

Модификатор и тип Метод Описание
AlgorithmParameters generateParameters()

Генерирует параметры.
String getAlgorithm()

Возвращает стандартное имя алгоритма, с которым связан этот генератор параметров.
static AlgorithmParameterGenerator getInstance​(String algorithm)

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

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

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

Возвращает поставщика данного объекта генератора параметров алгоритма.
void init​(int size)

Инициализирует этот генератор параметров для определённого размера.
void init​(int size, SecureRandom random)

Инициализирует этот генератор параметров для определённого размера и источника случайности.
void init​(AlgorithmParameterSpec genParamSpec)

Инициализирует этот генератор параметров набором значений генерации параметров, специфичных для алгоритма.
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 от указанного провайдера. Указанный провайдер должен быть зарегистрирован в списке провайдеров безопасности.

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

Параметры:
algorithm - имя алгоритма, с которым связан этот генератор параметров. См. раздел AlgorithmParameterGenerator в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
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, 2020, 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/11/docs/api/java.base/java/security/AlgorithmParameterGenerator.html

Spec-Zone .ru
спецификации, руководства, описания, API