Класс ExemptionMechanism

java.lang.Object

javax.crypto.ExemptionMechanism

public class ExemptionMechanism extends Object

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

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

Начиная с версии:: 1.4

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

ExemptionMechanism(ExemptionMechanismSpi exmechSpi,
 Provider provider,
 String mechanism)

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

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

Модификатор и тип	Метод	Описание
`final byte[]`	`genExemptionBlob()`	Генерирует блоб ключа механизма освобождения.
`final int`	`genExemptionBlob(byte[] output)`	Генерирует блоб ключа механизма освобождения и сохраняет результат в буфер `output`.
`final int`	`genExemptionBlob(byte[] output, int outputOffset)`	Генерирует блоб ключа механизма освобождения и сохраняет результат в буфер `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)`	Возвращает значение, указывающее, был ли блоб результата успешно сгенерирован этим механизмом освобождения.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли другой объект этому объекту.
`protected void`	`finalize()`	Устарело, планируется удаление: этот элемент API может быть удален в будущей версии. Финализация устарела и может быть удалена в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.

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

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 Reference Implementation дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемых методом Security.getProviders().

Параметры:

algorithm — стандартное имя запрошенного механизма освобождения. Информацию о стандартных именах механизмов освобождения см. в разделе ExemptionMechanism спецификации «Стандартные имена алгоритмов Java Security».

Возвращает:

новый объект 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

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

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

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

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

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

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

genExemptionBlob

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

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

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

genExemptionBlob

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

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

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

Параметры:: output — буфер для результата
Возвращает:: количество байтов, сохраненных в output
Выбрасывает:: IllegalStateException — если этот механизм освобождения находится в недопустимом состоянии (например, еще не был инициализирован).; ShortBufferException — если заданный выходной буфер слишком мал для размещения результата.; ExemptionMechanismException — если в процессе генерации возникла проблема.

genExemptionBlob

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

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

Параметры:: output — буфер для результата; outputOffset — смещение в output, начиная с которого сохраняется результат
Возвращает:: количество байтов, сохраненных в output
Выбрасывает:: 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.