abstract class 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.
Summary
Protected methods |
abstract ByteArray! |
Returns the parameters in their primary encoding format.
|
abstract ByteArray! |
Returns the parameters encoded in the specified format.
|
abstract T |
Returns a (transparent) specification of this parameters object.
|
abstract Unit |
Initializes this parameters object using the parameters specified in paramSpec .
|
abstract Unit |
Imports the specified parameters and decodes them according to the primary decoding format for parameters.
|
abstract Unit |
Imports the parameters from params and decodes them according to the specified decoding format.
|
abstract String! |
Returns a formatted string describing the parameters.
|
Public constructors
Protected methods
engineGetEncoded
protected abstract fun engineGetEncoded(): ByteArray!
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.
Return |
ByteArray! |
the parameters encoded using their primary encoding format. |
Exceptions |
java.io.IOException |
on encoding errors. |
engineGetEncoded
protected abstract fun engineGetEncoded(: String!): ByteArray!
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. |
Return |
ByteArray! |
the parameters encoded using the specified encoding scheme. |
Exceptions |
java.io.IOException |
on encoding errors. |
engineGetParameterSpec
protected abstract fun <T : AlgorithmParameterSpec!> engineGetParameterSpec(: Class<T>!): T
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 |
<T> |
the type of the parameter specification to be returned |
paramSpec |
Class<T>!: the specification class in which the parameters should be returned. |
Return |
T |
the parameter specification. |
Exceptions |
java.security.spec.InvalidParameterSpecException |
if the requested parameter specification is inappropriate for this parameter object. |
engineInit
protected abstract fun engineInit(: AlgorithmParameterSpec!): Unit
Initializes this parameters object using the parameters specified in paramSpec
.
Exceptions |
java.security.spec.InvalidParameterSpecException |
if the given parameter specification is inappropriate for the initialization of this parameter object. |
engineInit
protected abstract fun engineInit(: ByteArray!): Unit
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 |
ByteArray!: the encoded parameters. |
Exceptions |
java.io.IOException |
on decoding errors |
engineInit
protected abstract fun engineInit(
: ByteArray!,
: String!
): Unit
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 |
ByteArray!: the encoded parameters. |
format |
String!: the name of the decoding format. |
Exceptions |
java.io.IOException |
on decoding errors |
engineToString
protected abstract fun engineToString(): String!
Returns a formatted string describing the parameters.
Return |
String! |
a formatted string describing the parameters. |