javax.crypto: abstract public class: ExemptionMechanismSpi

javax.crypto
abstract public class: ExemptionMechanismSpi [javadoc | source]

java.lang.Object
   javax.crypto.ExemptionMechanismSpi

This class defines the Service Provider Interface (SPI) for the 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.

author: Sharon - Liu

since: 1.4 -

Method from javax.crypto.ExemptionMechanismSpi Summary:
engineGenExemptionBlob, engineGenExemptionBlob, engineGetOutputSize, engineInit, engineInit, engineInit

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.crypto.ExemptionMechanismSpi Detail:
abstract protected byte[] engineGenExemptionBlob() throws ExemptionMechanismException Generates the exemption mechanism key blob.
abstract protected int engineGenExemptionBlob(byte[] output, int outputOffset) throws ShortBufferException, ExemptionMechanismException Generates the exemption mechanism key blob, and stores the result in the `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.
abstract protected int engineGetOutputSize(int inputLen) 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). The actual output length of the next engineGenExemptionBlob call may be smaller than the length returned by this method.
abstract protected void engineInit(Key key) throws InvalidKeyException, ExemptionMechanismException Initializes this exemption mechanism with a key. 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.
abstract protected void engineInit(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException Initializes this exemption mechanism with a key and a set of algorithm parameters. 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.
abstract protected void engineInit(Key key, AlgorithmParameters params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException Initializes this exemption mechanism with a key and a set of algorithm parameters. 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.