AlgorithmParametersSpi

AI-generated Key Takeaways

• AlgorithmParametersSpi is a Service Provider Interface (SPI) for managing algorithm parameters in Java cryptography.

• Cryptographic service providers must implement this class to offer parameter management for specific algorithms.

• This class provides methods for initializing, encoding, decoding, and retrieving algorithm parameters.

• Parameters can be represented as byte arrays or through the AlgorithmParameterSpec interface.

• This SPI integrates with AlgorithmParameters for accessing and manipulating algorithm parameters securely.

public abstract class AlgorithmParametersSpi extends Object

This class defines the Service Provider Interface (SPI) for the AlgorithmParameters class, which is used to manage algorithm parameters.

All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply parameter management for a particular algorithm.

See Also

• AlgorithmParameters
• AlgorithmParameterSpec
• DSAParameterSpec

Public Constructor Summary

AlgorithmParametersSpi()

Protected Method Summary

abstract byte[]	engineGetEncoded(String format) Returns the parameters encoded in the specified format.
abstract byte[]	engineGetEncoded() Returns the parameters in their primary encoding format.
abstract <T extends AlgorithmParameterSpec> T	engineGetParameterSpec(Class<T> paramSpec) Returns a (transparent) specification of this parameters object.
abstract void	engineInit(AlgorithmParameterSpec paramSpec) Initializes this parameters object using the parameters specified in paramSpec.
abstract void	engineInit(byte[] params, String format) Imports the parameters from params and decodes them according to the specified decoding format.
abstract void	engineInit(byte[] params) Imports the specified parameters and decodes them according to the primary decoding format for parameters.
abstract String	engineToString() Returns a formatted string describing the parameters.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public AlgorithmParametersSpi ()

Protected Methods

protected abstract byte[] engineGetEncoded (String format)

Returns the parameters encoded in the specified format. If format is null, the primary encoding format for parameters is used. The primary encoding format is ASN.1, if an ASN.1 specification for these parameters exists.

Parameters

format	the name of the encoding format.

Returns

• the parameters encoded using the specified encoding scheme.

Throws

IOException	on encoding errors.

protected abstract byte[] engineGetEncoded ()

Returns the parameters in their primary encoding format. The primary encoding format for parameters is ASN.1, if an ASN.1 specification for this type of parameters exists.

Returns

• the parameters encoded using their primary encoding format.

Throws

IOException	on encoding errors.

protected abstract T engineGetParameterSpec (Class<T> paramSpec)

Returns a (transparent) specification of this parameters object. paramSpec identifies the specification class in which the parameters should be returned. It could, for example, be DSAParameterSpec.class, to indicate that the parameters should be returned in an instance of the DSAParameterSpec class.

Parameters

paramSpec	the specification class in which the parameters should be returned.

Returns

• the parameter specification.

Throws

InvalidParameterSpecException	if the requested parameter specification is inappropriate for this parameter object.

protected abstract void engineInit (AlgorithmParameterSpec paramSpec)

Initializes this parameters object using the parameters specified in paramSpec.

Parameters

paramSpec	the parameter specification.

Throws

InvalidParameterSpecException	if the given parameter specification is inappropriate for the initialization of this parameter object.

protected abstract void engineInit (byte[] params, String format)

Imports the parameters from params and decodes them according to the specified decoding format. If format is null, the primary decoding format for parameters is used. The primary decoding format is ASN.1, if an ASN.1 specification for these parameters exists.

Parameters

params	the encoded parameters.
format	the name of the decoding format.

Throws

IOException	on decoding errors

protected abstract void engineInit (byte[] params)

Imports the specified parameters and decodes them according to the primary decoding format for parameters. The primary decoding format for parameters is ASN.1, if an ASN.1 specification for this type of parameters exists.

Parameters

params	the encoded parameters.

Throws

IOException	on decoding errors

protected abstract String engineToString ()

Returns a formatted string describing the parameters.

Returns

• a formatted string describing the parameters.