javax.crypto

Class ExemptionMechanismSpi

java.lang.Object

javax.crypto.ExemptionMechanismSpi

public abstract class ExemptionMechanismSpi
extends Object

The Service Provider Interface (SPI) definition for the ExemptionMechanism class.

Constructor Summary

Constructors

Constructor and Description
ExemptionMechanismSpi() Creates a new ExemptionMechanismSpi instance.

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	engineGenExemptionBlob() Generates the result key blob for this exemption mechanism.
protected abstract int	engineGenExemptionBlob(byte[] output, int outputOffset) Generates the result key blob for this exemption mechanism and stores it into the output buffer at offset outputOffset.
protected abstract int	engineGetOutputSize(int inputLen) Returns the size in bytes for the output buffer needed to hold the output of the next engineGenExemptionBlob() call, given the specified inputLen (in bytes).
protected abstract void	engineInit(Key key) Initializes this ExemptionMechanism instance with the specified key.
protected abstract void	engineInit(Key key, AlgorithmParameters params) Initializes this ExemptionMechanism instance with the specified key and algorithm parameters.
protected abstract void	engineInit(Key key, AlgorithmParameterSpec params) Initializes this ExemptionMechanism instance with the specified key and algorithm parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExemptionMechanismSpi

public ExemptionMechanismSpi()

Creates a new ExemptionMechanismSpi instance.

Method Detail

engineGenExemptionBlob

protected abstract byte[] engineGenExemptionBlob()
                                          throws ExemptionMechanismException

Generates the result key blob for this exemption mechanism.

Returns:

the result key blob for this exemption mechanism.

Throws:

ExemptionMechanismException - if error(s) occur during generation.

engineGenExemptionBlob

protected abstract int engineGenExemptionBlob(byte[] output,
                                              int outputOffset)
                                       throws ShortBufferException,
                                              ExemptionMechanismException

Generates the result key blob for this exemption mechanism and stores it into the output buffer at offset outputOffset.

Parameters:

output - the output buffer for the result key blob.

outputOffset - the offset in the output buffer to start.

Returns:

the number of bytes written to the output buffer.

Throws:

ShortBufferException - if the provided buffer is too small for the result key blob.

ExemptionMechanismException - if error(s) occur during generation.

engineGetOutputSize

protected abstract int engineGetOutputSize(int inputLen)

Returns the size in bytes for the output buffer needed to hold the output of the next engineGenExemptionBlob() call, given the specified inputLen (in bytes).

Parameters:

inputLen - the specified input length (in bytes).

Returns:

the size in bytes for the output buffer.

engineInit

protected abstract void engineInit(Key key)
                            throws InvalidKeyException,
                                   ExemptionMechanismException

Initializes this ExemptionMechanism instance with the specified key.

Parameters:

key - the key to initialize this instance with.

Throws:

InvalidKeyException - if the key cannot be used to initialize this mechanism.

ExemptionMechanismException - if error(s) occur during initialization.

engineInit

protected abstract void engineInit(Key key,
                                   AlgorithmParameters params)
                            throws InvalidKeyException,
                                   InvalidAlgorithmParameterException,
                                   ExemptionMechanismException

Initializes this ExemptionMechanism instance with the specified key and algorithm parameters.

Parameters:

key - the key to initialize this instance with.

params - the parameters for this exemption mechanism algorithm.

Throws:

InvalidKeyException - if the key cannot be used to initialize this mechanism.

InvalidAlgorithmParameterException - if the parameters cannot be used to initialize this mechanism.

ExemptionMechanismException - if error(s) occur during initialization.

engineInit

protected abstract void engineInit(Key key,
                                   AlgorithmParameterSpec params)
                            throws InvalidKeyException,
                                   InvalidAlgorithmParameterException,
                                   ExemptionMechanismException

Initializes this ExemptionMechanism instance with the specified key and algorithm parameters.

Parameters:

key - the key to initialize this instance with.

params - the parameters for this exemption mechanism algorithm.

Throws:

InvalidKeyException - if the key cannot be used to initialize this mechanism.

InvalidAlgorithmParameterException - the the parameters cannot be used to initialize this mechanism.

ExemptionMechanismException - if error(s) occur during initialization.