Skip to content

Most visited

Recently visited

navigation

AlgorithmParametersSpi

public abstract class AlgorithmParametersSpi
extends Object

java.lang.Object
   ↳ java.security.AlgorithmParametersSpi


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(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 methods

From class java.lang.Object

Public constructors

AlgorithmParametersSpi

Added in API level 1
AlgorithmParametersSpi ()

Protected methods

engineGetEncoded

Added in API level 1
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 String: the name of the encoding format.
Returns
byte[] the parameters encoded using the specified encoding scheme.
Throws
IOException on encoding errors.

engineGetEncoded

Added in API level 1
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
byte[] the parameters encoded using their primary encoding format.
Throws
IOException on encoding errors.

engineGetParameterSpec

Added in API level 1
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 Class: the specification class in which the parameters should be returned.
Returns
T the parameter specification.
Throws
InvalidParameterSpecException if the requested parameter specification is inappropriate for this parameter object.

engineInit

Added in API level 1
void engineInit (AlgorithmParameterSpec paramSpec)

Initializes this parameters object using the parameters specified in paramSpec.

Parameters
paramSpec AlgorithmParameterSpec: the parameter specification.
Throws
InvalidParameterSpecException if the given parameter specification is inappropriate for the initialization of this parameter object.

engineInit

Added in API level 1
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 byte: the encoded parameters.
format String: the name of the decoding format.
Throws
IOException on decoding errors

engineInit

Added in API level 1
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 byte: the encoded parameters.
Throws
IOException on decoding errors

engineToString

Added in API level 1
String engineToString ()

Returns a formatted string describing the parameters.

Returns
String a formatted string describing the parameters.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.