public abstract class

AlgorithmParametersSpi

extends Object
java.lang.Object
   ↳ java.security.AlgorithmParametersSpi
Known Direct Subclasses

Class Overview

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

Summary

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

Public Constructors

public AlgorithmParametersSpi ()

Protected Methods

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 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 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 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 (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 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 (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 String engineToString ()

Returns a formatted string describing the parameters.

Returns
  • a formatted string describing the parameters.