AlgorithmParametersSpi (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.security.AlgorithmParametersSpi

• ---

public abstract class AlgorithmParametersSpi
extends Object
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.
Since:
1.2
See Also:
AlgorithmParameters, AlgorithmParameterSpec, DSAParameterSpec

• • Constructor Summary

  Constructors

  Constructor	Description
  AlgorithmParametersSpi​()

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	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>T	engineGetParameterSpec​(Class paramSpec)	Returns a (transparent) specification of this parameters object.
  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 from params and decodes them according to the specified decoding format.
  protected abstract void	engineInit​(AlgorithmParameterSpec paramSpec)	Initializes this parameters object using the parameters specified in paramSpec.
  protected abstract String	engineToString​()	Returns a formatted string describing the parameters.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### AlgorithmParametersSpi  
     public AlgorithmParametersSpi​()  

  • Method Detail

    * #### engineInit  
    protected abstract void engineInit​([AlgorithmParameterSpec](../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec") paramSpec)  
                                throws [InvalidParameterSpecException](../../java/security/spec/InvalidParameterSpecException.html "class in java.security.spec")  
    Initializes this parameters object using the parameters specified in `paramSpec`.  
    Parameters:  
    `paramSpec` \- the parameter specification.  
    Throws:  
    `[InvalidParameterSpecException](../../java/security/spec/InvalidParameterSpecException.html "class in java.security.spec")` \- if the given parameter specification is inappropriate for the initialization of this parameter object.  
    * #### engineInit  
    protected abstract void engineInit​(byte[] params)  
                                throws [IOException](../../java/io/IOException.html "class in java.io")  
    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](../../java/io/IOException.html "class in java.io")` \- on decoding errors  
    * #### engineInit  
    protected abstract void engineInit​(byte[] params,  
                                       [String](../../java/lang/String.html "class in java.lang") format)  
                                throws [IOException](../../java/io/IOException.html "class in java.io")  
    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](../../java/io/IOException.html "class in java.io")` \- on decoding errors  
    * #### engineGetParameterSpec  
    protected abstract <T extends [AlgorithmParameterSpec](../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec")> T engineGetParameterSpec​([Class](../../java/lang/Class.html "class in java.lang")<T> paramSpec)  
                                                                            throws [InvalidParameterSpecException](../../java/security/spec/InvalidParameterSpecException.html "class in java.security.spec")  
    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.  
    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](../../java/security/spec/InvalidParameterSpecException.html "class in java.security.spec")` \- if the requested parameter specification is inappropriate for this parameter object.  
    * #### engineGetEncoded  
    protected abstract byte[] engineGetEncoded​()  
                                        throws [IOException](../../java/io/IOException.html "class in java.io")  
    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](../../java/io/IOException.html "class in java.io")` \- on encoding errors.  
    * #### engineGetEncoded  
    protected abstract byte[] engineGetEncoded​([String](../../java/lang/String.html "class in java.lang") format)  
                                        throws [IOException](../../java/io/IOException.html "class in java.io")  
    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](../../java/io/IOException.html "class in java.io")` \- on encoding errors.  
    * #### engineToString  
    protected abstract [String](../../java/lang/String.html "class in java.lang") engineToString​()  
    Returns a formatted string describing the parameters.  
    Returns:  
    a formatted string describing the parameters.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.