Класс AlgorithmParameters

public class AlgorithmParameters
extends Object

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

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

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

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

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

• AES
• DES
• DESede
• DiffieHellman
• DSA

Эти алгоритмы описаны в разделе AlgorithmParameters документации по стандартным именам алгоритмов Java Cryptography Architecture. Обратитесь к документации реализации для получения информации о поддержке других алгоритмов.

Конструкторы

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

Параметры:

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

Возвращает:

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

Исключение:

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

См. также:

Provider

getInstance

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

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

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

См. также:

Provider

getInstance

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

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

См. также:

Provider

С момента:

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, если этот объект параметров не был инициализирован.