java.security
Class AlgorithmParametersSpi

java.lang.Object
  extended by java.security.AlgorithmParametersSpi

public abstract class AlgorithmParametersSpi
extends Object

AlgorithmParametersSpi is the Service Provider Interface for the Algorithm Parameters class. This class is used to manage the algorithm parameters.

Since:
1.2

Constructor Summary
AlgorithmParametersSpi()
          Creates a new instance of AlgorithmParametersSpi
 
Method Summary
protected abstract  byte[] engineGetEncoded()
          Returns the parameters in the default encoding format.
protected abstract  byte[] engineGetEncoded(String format)
          Returns the parameters in the specified encoding format.
protected abstract
<T extends AlgorithmParameterSpec>
T
engineGetParameterSpec(Class<T> paramSpec)
          Returns a specification of this AlgorithmParameters object.
protected abstract  void engineInit(AlgorithmParameterSpec paramSpec)
          Initializes the engine with the specified AlgorithmParameterSpec class.
protected abstract  void engineInit(byte[] params)
          Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification.
protected abstract  void engineInit(byte[] params, String format)
          Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification.
protected abstract  String engineToString()
          Returns a string describing the parameters in the AlgorithmParametersSpi class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AlgorithmParametersSpi

public AlgorithmParametersSpi()
Creates a new instance of AlgorithmParametersSpi

Method Detail

engineInit

protected abstract void engineInit(AlgorithmParameterSpec paramSpec)
                            throws InvalidParameterSpecException
Initializes the engine with the specified AlgorithmParameterSpec class.

Parameters:
paramSpec - A AlgorithmParameterSpec to initialize with
Throws:
InvalidParameterSpecException - For an inapporiate ParameterSpec class

engineInit

protected abstract void engineInit(byte[] params)
                            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification. If the ASN.1 specification exists then it succeeds or else it throws IOException.

Parameters:
params - Parameters to initialize with
Throws:
IOException - Decoding Error

engineInit

protected abstract void engineInit(byte[] params,
                                   String format)
                            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification. If format is null, then it is decoded using the ASN.1 specification if it exists or else it throws IOException.

Parameters:
params - Parameters to initialize with
format - Name of decoding format to use
Throws:
IOException - Decoding Error

engineGetParameterSpec

protected abstract <T extends AlgorithmParameterSpec> T engineGetParameterSpec(Class<T> paramSpec)
                                                                    throws InvalidParameterSpecException
Returns a specification of this AlgorithmParameters object. paramSpec identifies the class to return the AlgortihmParameters in.

Parameters:
paramSpec - Class to return AlgorithmParameters in
Returns:
the parameter specification
Throws:
InvalidParameterSpecException - if the paramSpec is an invalid parameter class

engineGetEncoded

protected abstract byte[] engineGetEncoded()
                                    throws IOException
Returns the parameters in the default encoding format. The primary encoding format is ASN.1 format if it exists for the specified type.

Returns:
byte array representing the parameters
Throws:
IOException

engineGetEncoded

protected abstract byte[] engineGetEncoded(String format)
                                    throws IOException
Returns the parameters in the specified encoding format. If format is null then the primary encoding format is used, the ASN.1 format, if it exists for the specified type.

Returns:
byte array representing the parameters
Throws:
IOException

engineToString

protected abstract String engineToString()
Returns a string describing the parameters in the AlgorithmParametersSpi class.

Returns:
A string representing the format of the parameters.