- java.lang.Object
-
- java.security.AlgorithmParametersSpi
-
public abstract class AlgorithmParametersSpi extends Object
This class defines the Service Provider Interface (SPI) for theAlgorithmParameters
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.
- Since:
- 1.2
- See Also:
AlgorithmParameters
,AlgorithmParameterSpec
,DSAParameterSpec
-
-
Constructor Summary
Constructors Constructor and Description AlgorithmParametersSpi()
-
Method Summary
Methods Modifier and Type Method and Description protected abstract byte[]
engineGetEncoded()
Returns the parameters in their primary encoding format.protected abstract byte[]
engineGetEncoded(String format)
Returns the parameters encoded in the specified format.protected abstract <T extends AlgorithmParameterSpec>
TengineGetParameterSpec(Class<T> paramSpec)
Returns a (transparent) specification of this parameters object.protected abstract void
engineInit(AlgorithmParameterSpec paramSpec)
Initializes this parameters object using the parameters specified inparamSpec
.protected abstract void
engineInit(byte[] params)
Imports the specified parameters and decodes them according to the primary decoding format for parameters.protected abstract void
engineInit(byte[] params, String format)
Imports the parameters fromparams
and decodes them according to the specified decoding format.protected abstract String
engineToString()
Returns a formatted string describing the parameters.
-
-
-
Method Detail
-
engineInit
protected abstract void engineInit(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException
Initializes this parameters object using the parameters specified inparamSpec
.- Parameters:
paramSpec
- the parameter specification.- Throws:
InvalidParameterSpecException
- if the given parameter specification is inappropriate for the initialization of this parameter object.
-
engineInit
protected abstract void engineInit(byte[] params) throws IOException
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
-
engineInit
protected abstract void engineInit(byte[] params, String format) throws IOException
Imports the parameters fromparams
and decodes them according to the specified decoding format. Ifformat
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
-
engineGetParameterSpec
protected abstract <T extends AlgorithmParameterSpec> T engineGetParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException
Returns a (transparent) specification of this parameters object.paramSpec
identifies the specification class in which the parameters should be returned. It could, for example, beDSAParameterSpec.class
, to indicate that the parameters should be returned in an instance of theDSAParameterSpec
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.
-
engineGetEncoded
protected abstract byte[] engineGetEncoded() throws IOException
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.
-
engineGetEncoded
protected abstract byte[] engineGetEncoded(String format) throws IOException
Returns the parameters encoded in the specified format. Ifformat
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.
-
engineToString
protected abstract String engineToString()
Returns a formatted string describing the parameters.- Returns:
- a formatted string describing the parameters.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/security/algorithmparametersspi.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.