Класс ExemptionMechanism

java.lang.Object

javax.crypto.ExemptionMechanism

public class ExemptionMechanism extends Object

Этот класс предоставляет функциональность механизма исключений, примерами которых являются восстановление ключей, ослабление ключей и эскроу ключей.

Приложения, использующие механизм исключений, могут получить более сильные возможности шифрования, чем те, которые этого не делают.

Since:: 1.4

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

ExemptionMechanism(ExemptionMechanismSpi exmechSpi,
 Provider provider,
 String mechanism)

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

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

Модификатор и тип	Метод	Описание
`final byte[]`	`genExemptionBlob()`	Генерирует blob ключа механизма исключений.
`final int`	`genExemptionBlob(byte[] output)`	Генерирует blob ключа механизма исключений и сохраняет результат в буфере `output`.
`final int`	`genExemptionBlob(byte[] output, int outputOffset)`	Генерирует blob ключа механизма исключений и сохраняет результат в буфере `output`, начиная с индекса `outputOffset` включительно.
`static final ExemptionMechanism`	`getInstance(String algorithm)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключений.
`static final ExemptionMechanism`	`getInstance(String algorithm, String provider)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключений.
`static final ExemptionMechanism`	`getInstance(String algorithm, Provider provider)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключений.
`final String`	`getName()`	Возвращает имя механизма исключений этого объекта `ExemptionMechanism`.
`final int`	`getOutputSize(int inputLen)`	Возвращает длину в байтах, которую должен иметь буфер вывода для хранения результата следующей операции `genExemptionBlob`, учитывая длину входных данных `inputLen` (в байтах).
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта `ExemptionMechanism`.
`final void`	`init(Key key)`	Инициализирует этот механизм исключений ключом.
`final void`	`init(Key key, AlgorithmParameters params)`	Инициализирует этот механизм исключений ключом и набором параметров алгоритма.
`final void`	`init(Key key, AlgorithmParameterSpec params)`	Инициализирует этот механизм исключений ключом и набором параметров алгоритма.
`final boolean`	`isCryptoAllowed(Key key)`	Возвращает, был ли результат blob успешно сгенерирован этим механизмом исключений.

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

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

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

ExemptionMechanism

protected ExemptionMechanism(ExemptionMechanismSpi exmechSpi, Provider provider, String mechanism)

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

Параметры:: exmechSpi - делегат; provider - поставщик; mechanism - механизм исключения

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

getName

public final String getName()

Возвращает имя механизма исключения для этого объекта ExemptionMechanism.

Это то же имя, которое было указано в одном из вызовов getInstance, которые создали этот объект ExemptionMechanism.

Возвращает:: имя механизма исключения для этого объекта ExemptionMechanism.

getInstance

public static final ExemptionMechanism getInstance(String algorithm) throws NoSuchAlgorithmException

Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

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

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

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

Параметры:

algorithm - стандартное имя запрашиваемого механизма исключения. Сведения о стандартных именах алгоритмов механизмов исключения см. в разделе ExemptionMechanism спецификации Java Security Standard Algorithm Names Specification.

Возвращает:

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

Исключения:

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

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

См. также:

getInstance

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

Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

Параметры:

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

Возвращает:

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

Исключения:

IllegalArgumentException - если provider является null или пустым

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

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

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

См. также:

getInstance

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

Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

Параметры:

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

Возвращает:

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

Исключения:

IllegalArgumentException - если provider является null

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

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

См. также:

getProvider

public final Provider getProvider()

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

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

isCryptoAllowed

public final boolean isCryptoAllowed(Key key) throws ExemptionMechanismException

Возвращает, был ли успешно сгенерирован BLOB результата этим механизмом исключения.

Метод также гарантирует, что переданный ключ совпадает с ключом, используемым этим механизмом исключения при инициализации и генерации.

Параметры:: key - ключ, который будет использован криптографией.
Возвращает:: был ли успешно сгенерирован BLOB результата с тем же ключом этим механизмом исключения; false если key является null.
Исключения:: ExemptionMechanismException - если возникла проблема при определении, был ли успешно сгенерирован BLOB результата объектом этого механизма исключения.

getOutputSize

public final int getOutputSize(int inputLen) throws IllegalStateException

Возвращает длину в байтах, которая должна иметь буфер вывода, чтобы содержать результат следующей операции genExemptionBlob, учитывая длину входных данных inputLen (в байтах).

Фактическая длина вывода следующего вызова genExemptionBlob может быть меньше, чем длина, возвращённая этим методом.

Параметры:: inputLen - длина входных данных (в байтах)
Возвращает:: необходимый размер буфера вывода (в байтах)
Исключения:: IllegalStateException - если этот механизм исключения находится в неправильном состоянии (например, ещё не был инициализирован)

init

public final void init(Key key) throws InvalidKeyException, ExemptionMechanismException

Инициализирует этот механизм исключения ключом.

Если этому механизму исключения требуются какие-либо параметры алгоритма, которые нельзя получить из заданного key, реализация механизма исключения должна сгенерировать требуемые параметры сама (используя значения по умолчанию, специфичные для поставщика). В случае, если параметры алгоритма должны быть заданы вызывающим методом, возникает исключение InvalidKeyException.

Параметры:: key - ключ для этого механизма исключения
Исключения:: InvalidKeyException - если заданный ключ не подходит для этого механизма исключения.; ExemptionMechanismException - если возникла проблема(ы) во время инициализации.

init

public final void init(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException

Инициализирует этот механизм исключения ключом и набором параметров алгоритма.

Если этому механизму исключения требуются какие-либо параметры алгоритма, и params является null, реализация механизма исключения должна сгенерировать требуемые параметры сама (используя значения по умолчанию, специфичные для поставщика). В случае, если параметры алгоритма должны быть заданы вызывающим методом, возникает исключение InvalidAlgorithmParameterException.

Параметры:: key - ключ для этого механизма исключения; params - параметры алгоритма
Исключения:: InvalidKeyException - если заданный ключ не подходит для этого механизма исключения.; InvalidAlgorithmParameterException - если заданные параметры алгоритма не подходят для этого механизма исключения.; ExemptionMechanismException - если возникла проблема(ы) во время инициализации.

init

public final void init(Key key, AlgorithmParameters params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException

Инициализирует этот механизм исключения ключом и набором параметров алгоритма.

Если этому механизму исключения требуются какие-либо параметры алгоритма, и params является null, реализация базового механизма исключения должна сгенерировать необходимые параметры сама (используя параметры по умолчанию, специфичные для поставщика); в случае, когда параметры алгоритма должны быть указаны вызывающей стороной, генерируется InvalidAlgorithmParameterException.

Parameters:: key - ключ для данного механизма исключения; params - параметры алгоритма
Throws:: InvalidKeyException - если заданный ключ не подходит для данного механизма исключения.; InvalidAlgorithmParameterException - если заданные параметры алгоритма не подходят для данного механизма исключения.; ExemptionMechanismException - если при инициализации возникла(и) проблема(ы).

genExemptionBlob

public final byte[] genExemptionBlob() throws IllegalStateException, ExemptionMechanismException

Генерирует блок ключа механизма исключения.

Returns:: новый буфер с результатом блока ключа.
Throws:: IllegalStateException - если механизм исключения находится в неправильном состоянии (например, не был инициализирован).; ExemptionMechanismException - если при генерации возникла(и) проблема(ы).

genExemptionBlob

public final int genExemptionBlob(byte[] output) throws IllegalStateException, ShortBufferException, ExemptionMechanismException

Генерирует блок ключа механизма исключения и сохраняет результат в буфере output.

Если буфер output слишком мал для хранения результата, выбрасывается ShortBufferException. В этом случае повторите этот вызов с буфером вывода большего размера. Используйте getOutputSize, чтобы определить, каким должен быть буфер вывода.

Parameters:: output - буфер для результата
Returns:: количество байтов, сохранённых в output
Throws:: IllegalStateException - если механизм исключения находится в неправильном состоянии (например, не был инициализирован).; ShortBufferException - если предоставленный буфер вывода слишком мал для хранения результата.; ExemptionMechanismException - если при генерации возникла(и) проблема(ы).

genExemptionBlob

public final int genExemptionBlob(byte[] output, int outputOffset) throws IllegalStateException, ShortBufferException, ExemptionMechanismException

Генерирует блок ключа механизма исключения и сохраняет результат в буфере output, начиная с outputOffset включительно.

Parameters:: output - буфер для результата; outputOffset - смещение в output, где хранится результат
Returns:: количество байтов, сохранённых в output
Throws:: IllegalStateException - если механизм исключения находится в неправильном состоянии (например, не был инициализирован).; ShortBufferException - если предоставленный буфер вывода слишком мал для хранения результата.; ExemptionMechanismException - если при генерации возникла(и) проблема(ы).

© 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://download.java.net/java/early_access/jdk24/docs/api/java.base/javax/crypto/ExemptionMechanism.html