ExemptionMechanismSpi (Java SE 15 & JDK 15) (original) (raw)

public abstract class ExemptionMechanismSpi extends Object

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.

Since:

1.4

• Constructor Summary

Constructors

• Method Summary

Methods declared in class java.lang.Object

[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,int%29)

• Constructor Details

  • ExemptionMechanismSpi

  public ExemptionMechanismSpi()

• Method Details

  • engineGetOutputSize

  protected abstract 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 nextengineGenExemptionBlob operation, given the input length inputLen (in bytes).
  The actual output length of the nextengineGenExemptionBlob call may be smaller than the length returned by this method.
  Parameters:
  inputLen - the input length (in bytes)
  Returns:
  the required output buffer size (in bytes)

  • engineInit

  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, anInvalidKeyException is raised.
  Parameters:
  key - the key for this exemption mechanism
  Throws:
  [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security") - if the given key is inappropriate for this exemption mechanism.
  [ExemptionMechanismException](ExemptionMechanismException.html "class in javax.crypto") - if problem(s) encountered in the process of initializing.

  • engineInit

  Initializes this exemption mechanism with a key and a set of algorithm parameters.
  If this exemption mechanism requires any algorithm parameters andparams 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, anInvalidAlgorithmParameterException is raised.
  Parameters:
  key - the key for this exemption mechanism
  params - the algorithm parameters
  Throws:
  [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security") - if the given key is inappropriate for this exemption mechanism.
  [InvalidAlgorithmParameterException](../../java/security/InvalidAlgorithmParameterException.html "class in java.security") - if the given algorithm parameters are inappropriate for this exemption mechanism.
  [ExemptionMechanismException](ExemptionMechanismException.html "class in javax.crypto") - if problem(s) encountered in the process of initializing.

  • engineInit

  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, anInvalidAlgorithmParameterException is raised.
  Parameters:
  key - the key for this exemption mechanism
  params - the algorithm parameters
  Throws:
  [InvalidKeyException](../../java/security/InvalidKeyException.html "class in java.security") - if the given key is inappropriate for this exemption mechanism.
  [InvalidAlgorithmParameterException](../../java/security/InvalidAlgorithmParameterException.html "class in java.security") - if the given algorithm parameters are inappropriate for this exemption mechanism.
  [ExemptionMechanismException](ExemptionMechanismException.html "class in javax.crypto") - if problem(s) encountered in the process of initializing.

  • engineGenExemptionBlob

  Generates the exemption mechanism key blob.
  Returns:
  the new buffer with the result key blob.
  Throws:
  [ExemptionMechanismException](ExemptionMechanismException.html "class in javax.crypto") - if problem(s) encountered in the process of generating.

  • engineGenExemptionBlob

  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. UseengineGetOutputSize to determine how big the output buffer should be.
  Parameters:
  output - the buffer for the result
  outputOffset - the offset in output where the result is stored
  Returns:
  the number of bytes stored in output
  Throws:
  [ShortBufferException](ShortBufferException.html "class in javax.crypto") - if the given output buffer is too small to hold the result.
  [ExemptionMechanismException](ExemptionMechanismException.html "class in javax.crypto") - if problem(s) encountered in the process of generating.