Stay organized with collections
    
    
      
      Save and categorize content based on your preferences.
    
  
  
    
  
  
  
  
    
    
    
  
  
    
    
  
  
  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.
  
Summary
| 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(byte[] params, String format)
      Imports the parameters from paramsand
 decodes them according to the specified decoding format. | 
  
  
  
  
    | 
        abstract
        
        
        
        
        void | 
      engineInit(AlgorithmParameterSpec paramSpec)
      Initializes this parameters object using the parameters
 specified in paramSpec. | 
  
  
  
  
    | 
        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
        
      
      
  
  
  
    | 
        
        
        
        
        
        Object | 
      clone()
      Creates and returns a copy of this object.
        
    
 |  
  
  
    | 
        
        
        
        
        
        boolean | 
      equals(Object obj)
      Indicates whether some other object is "equal to" this one.
        
    
 |  
  
  
    | 
        
        
        
        
        
        void | 
      finalize()
      Called by the garbage collector on an object when garbage collection
 determines that there are no more references to the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        Class<?> | 
      getClass()
      Returns the runtime class of this Object. |  
  
  
    | 
        
        
        
        
        
        int | 
      hashCode()
      Returns a hash code value for the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notify()
      Wakes up a single thread that is waiting on this object's
 monitor.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notifyAll()
      Wakes up all threads that are waiting on this object's monitor.
        
    
 |  
  
  
    | 
        
        
        
        
        
        String | 
      toString()
      Returns a string representation of the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis, int nanos)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait()
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted.
        
    
 |  | 
Public constructors
    
    
public AlgorithmParametersSpi ()
    
    
    
  
 
Protected methods
    engineGetEncoded
    
protected abstract 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. | 
    
      
  
 
    engineGetEncoded
    
protected abstract 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. | 
    
      
  
 
    engineGetParameterSpec
    
protected abstract 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. | 
    
      
  
 
    engineInit
    
protected abstract 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. | 
    
      
  
 
    engineInit
    
protected abstract void engineInit (AlgorithmParameterSpec paramSpec)
    
    
    
  Initializes this parameters object using the parameters
 specified in paramSpec.
    
    | Parameters | 
|---|
      
        | paramSpec | AlgorithmParameterSpec: the parameter specification. | 
    
      
  
 
    engineInit
    
protected abstract 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. | 
    
      
  
 
    engineToString
    
protected abstract String engineToString ()
    
    
    
  Returns a formatted string describing the parameters.
    
      | Returns | 
|---|
      
        | String | a formatted string describing the parameters. | 
    
 
 
 
  
  
    
  
 
  
    
      
      
    
    
      
    
    
  
       
    
    
      
    
  
  
  Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
  Last updated 2025-02-10 UTC.
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]