Класс AlgorithmParameters

java.lang.Object

java.security.AlgorithmParameters

public class AlgorithmParameters extends Object

Этот класс используется в качестве неявного представления криптографических параметров.

Объект AlgorithmParameters для управления параметрами для определенного алгоритма можно получить, вызвав один из getInstance методов-фабрик (статические методы, возвращающие экземпляры заданного класса).

После получения объекта AlgorithmParameters, его необходимо инициализировать, вызвав init, используя соответствующее описание или кодирование параметров.

Явное описание параметров получается из объекта AlgorithmParameters с помощью вызова getParameterSpec, а байтовое кодирование параметров — с помощью вызова getEncoded.

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

AES
DESede
DiffieHellman
DSA

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

Since:

1.2

See Also:

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

AlgorithmParameters(AlgorithmParametersSpi paramSpi,
 Provider provider,
 String algorithm)

Модификатор	Конструктор	Описание
`protected`	Создаёт объект `AlgorithmParameters`.

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

Модификатор и тип	Метод	Описание
`final String`	`getAlgorithm()`	Возвращает имя алгоритма, связанного с этим объектом параметров.
`final byte[]`	`getEncoded()`	Возвращает параметры в их основном формате кодирования.
`final byte[]`	`getEncoded(String format)`	Возвращает параметры, закодированные в указанной схеме.
`static AlgorithmParameters`	`getInstance(String algorithm)`	Возвращает объект параметров для указанного алгоритма.
`static AlgorithmParameters`	`getInstance(String algorithm, String provider)`	Возвращает объект параметров для указанного алгоритма.
`static AlgorithmParameters`	`getInstance(String algorithm, Provider provider)`	Возвращает объект параметров для указанного алгоритма.
`final <T extends AlgorithmParameterSpec> T`	`getParameterSpec(Class<T> paramSpec)`	Возвращает (явное) описание этого объекта параметров.
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта параметров.
`final void`	`init(byte[] params)`	Импортирует указанные параметры и декодирует их в соответствии с основным форматом декодирования параметров.
`final void`	`init(byte[] params, String format)`	Импортирует параметры из `params` и декодирует их в соответствии с указанной схемой декодирования.
`final void`	`init(AlgorithmParameterSpec paramSpec)`	Инициализирует этот объект параметров, используя параметры, указанные в `paramSpec`.
`final String`	`toString()`	Возвращает отформатированную строку, описывающую параметры.

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

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

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

AlgorithmParameters

protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm)

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

Параметры:: paramSpi - делегат; provider - поставщик; algorithm - алгоритм

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

getAlgorithm

public final String getAlgorithm()

Возвращает имя алгоритма, связанного с этим объектом параметров.

Возвращает:: имя алгоритма.

getInstance

public static AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException

Возвращает объект параметров для указанного алгоритма.

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

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

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

Примечание по реализации:

Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().

Параметры:

algorithm - имя запрашиваемого алгоритма. См. раздел AlgorithmParameters в Спецификации имен алгоритмов Java Security для информации о стандартных именах алгоритмов.

Возвращает:

новый объект параметров

Исключения:

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

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

См. также:

getInstance

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

Возвращает объект параметров для указанного алгоритма.

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

Параметры:

provider - имя поставщика.

Возвращает:

новый объект параметров

Исключения:

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

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

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

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

См. также:

getInstance

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

Возвращает объект параметров для указанного алгоритма.

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

Параметры:

provider - имя поставщика.

Возвращает:

новый объект параметров

Исключения:

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

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

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

С:

1.4

См. также:

getProvider

public final Provider getProvider()

Возвращает поставщика этого объекта параметров.

Возвращает:: поставщика этого объекта параметров

init

public final void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException

Инициализирует этот объект параметров, используя параметры, заданные в paramSpec.

Параметры:: paramSpec - задание параметров.
Исключения:: InvalidParameterSpecException - если заданное задание параметров неприемлемо для инициализации этого объекта параметров, или если этот объект параметров уже был инициализирован.

init

public final void init(byte[] params) throws IOException

Импортирует указанные параметры и декодирует их в соответствии с основным форматом декодирования для параметров. Основной формат декодирования для параметров — ASN.1, если существует спецификация ASN.1 для этого типа параметров.

Параметры:: params - закодированные параметры.
Исключения:: IOException - при ошибках декодирования, или если этот объект параметров уже был инициализирован.

init

public final void init(byte[] params, String format) throws IOException

Импортирует параметры из params и декодирует их в соответствии с указанной схемой декодирования. Если format является null, используется основной формат декодирования для параметров. Основной формат декодирования — ASN.1, если существует спецификация ASN.1 для этих параметров.

Параметры:: params - закодированные параметры.; format - имя схемы декодирования.
Исключения:: IOException - при ошибках декодирования, или если этот объект параметров уже был инициализирован.

getParameterSpec

public final <T extends AlgorithmParameterSpec> T getParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException

Возвращает (прозрачное) задание этого объекта параметров. paramSpec определяет класс задания, в котором должны быть возвращены параметры. Например, он может быть DSAParameterSpec.class, чтобы указать, что параметры должны быть возвращены в экземпляре класса DSAParameterSpec.

Тип параметров:: T - тип задания параметров, который должен быть возвращён
Параметры:: paramSpec - класс задания, в котором должны быть возвращены параметры.
Возвращает:: задание параметров.
Исключения:: InvalidParameterSpecException - если запрошенное задание параметров неприемлемо для этого объекта параметров, или если этот объект параметров не был инициализирован.

getEncoded

public final byte[] getEncoded() throws IOException

Возвращает параметры в их основном формате кодирования. Основной формат кодирования для параметров — ASN.1, если существует спецификация ASN.1 для этого типа параметров.

Возвращает:: параметры, закодированные с использованием их основного формата кодирования.
Исключения:: IOException - при ошибках кодирования, или если этот объект параметров не был инициализирован.

getEncoded

public final byte[] getEncoded(String format) throws IOException

Возвращает параметры, закодированные в указанной схеме. Если format является null, используется основной формат кодирования для параметров. Основной формат кодирования — ASN.1, если существует спецификация ASN.1 для этих параметров.

Параметры:: format - имя формата кодирования.
Возвращает:: параметры, закодированные с использованием указанной схемы кодирования.
Исключения:: IOException - при ошибках кодирования, или если этот объект параметров не был инициализирован.

toString

public final String toString()

Возвращает отформатированную строку, описывающую параметры.

Переопределяет:: toString в классе Object
Возвращает:: отформатированную строку, описывающую параметры, или null если этот объект параметров не был инициализирован.

© 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/AlgorithmParameters.html