compact1, compact2, compact3
java.security
Class AlgorithmParametersSpi
- java.lang.Object
-
- java.security.AlgorithmParametersSpi
-
public abstract class AlgorithmParametersSpi extends Object
This class defines the Service Provider Interface (SPI) for theAlgorithmParametersclass, 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
All Methods Instance Methods Abstract 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 voidengineInit(AlgorithmParameterSpec paramSpec)Initializes this parameters object using the parameters specified inparamSpec.protected abstract voidengineInit(byte[] params)Imports the specified parameters and decodes them according to the primary decoding format for parameters.protected abstract voidengineInit(byte[] params, String format)Imports the parameters fromparamsand decodes them according to the specified decoding format.protected abstract StringengineToString()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 IOExceptionImports 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 IOExceptionImports the parameters fromparamsand decodes them according to the specified decoding format. Ifformatis 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.paramSpecidentifies 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 theDSAParameterSpecclass.- Type Parameters:
-
T- the type of the parameter specification to be returned - 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 IOExceptionReturns 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. Ifformatis 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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
