public abstract class ExemptionMechanismSpi extends Object
ExemptionMechanism
class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a particular exemption mechanism.Constructor | Description |
---|---|
ExemptionMechanismSpi() |
Constructor for subclasses to call. |
Modifier and Type | Method | Description |
---|---|---|
protected abstract byte[] |
engineGenExemptionBlob() |
Generates the exemption mechanism key blob. |
protected abstract int |
engineGenExemptionBlob |
Generates the exemption mechanism key blob, and stores the result in the output buffer, starting at outputOffset inclusive. |
protected abstract int |
engineGetOutputSize |
Returns the length in bytes that an output buffer would need to be in order to hold the result of the next engineGenExemptionBlob operation, given the input length inputLen (in bytes). |
protected abstract void |
engineInit |
Initializes this exemption mechanism with a key. |
protected abstract void |
engineInit |
Initializes this exemption mechanism with a key and a set of algorithm parameters. |
protected abstract void |
engineInit |
Initializes this exemption mechanism with a key and a set of algorithm parameters. |
public ExemptionMechanismSpi()
protected abstract int engineGetOutputSize(int inputLen)
engineGenExemptionBlob
operation, given the input length inputLen
(in bytes). The actual output length of the next engineGenExemptionBlob
call may be smaller than the length returned by this method.
inputLen
- the input length (in bytes)protected abstract void engineInit(Key key) throws InvalidKeyException, ExemptionMechanismException
If this exemption mechanism requires any algorithm parameters that cannot be derived from the given key
, the underlying exemption mechanism implementation is supposed to generate the required parameters itself (using provider-specific default values); in the case that algorithm parameters must be specified by the caller, an InvalidKeyException
is raised.
key
- the key for this exemption mechanismInvalidKeyException
- if the given key is inappropriate for this exemption mechanism.ExemptionMechanismException
- if problem(s) encountered in the process of initializing.protected abstract void engineInit(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException
If this exemption mechanism requires any algorithm parameters and params
is null, the underlying exemption mechanism implementation is supposed to generate the required parameters itself (using provider-specific default values); in the case that algorithm parameters must be specified by the caller, an InvalidAlgorithmParameterException
is raised.
key
- the key for this exemption mechanismparams
- the algorithm parametersInvalidKeyException
- if the given key is inappropriate for this exemption mechanism.InvalidAlgorithmParameterException
- if the given algorithm parameters are inappropriate for this exemption mechanism.ExemptionMechanismException
- if problem(s) encountered in the process of initializing.protected abstract void engineInit(Key key, AlgorithmParameters params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException
If this exemption mechanism requires any algorithm parameters and params
is null, the underlying exemption mechanism implementation is supposed to generate the required parameters itself (using provider-specific default values); in the case that algorithm parameters must be specified by the caller, an InvalidAlgorithmParameterException
is raised.
key
- the key for this exemption mechanismparams
- the algorithm parametersInvalidKeyException
- if the given key is inappropriate for this exemption mechanism.InvalidAlgorithmParameterException
- if the given algorithm parameters are inappropriate for this exemption mechanism.ExemptionMechanismException
- if problem(s) encountered in the process of initializing.protected abstract byte[] engineGenExemptionBlob() throws ExemptionMechanismException
ExemptionMechanismException
- if problem(s) encountered in the process of generating.protected abstract int engineGenExemptionBlob(byte[] output, int outputOffset) throws ShortBufferException, ExemptionMechanismException
output
buffer, starting at outputOffset
inclusive. If the output
buffer is too small to hold the result, a ShortBufferException
is thrown. In this case, repeat this call with a larger output buffer. Use engineGetOutputSize
to determine how big the output buffer should be.
output
- the buffer for the resultoutputOffset
- the offset in output
where the result is storedoutput
ShortBufferException
- if the given output buffer is too small to hold the result.ExemptionMechanismException
- if problem(s) encountered in the process of generating.
© 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/javax/crypto/ExemptionMechanismSpi.html