This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.security
class AlgorithmParametersSpi

java.lang.Object extended by 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.


Constructor Summary

          
 
Method Summary
protected abstract byte[]

          Returns the parameters in their primary encoding format.
protected abstract byte[]

          Returns the parameters encoded in the specified format.
protected abstract AlgorithmParameterSpec

          Returns a (transparent) specification of this parameters object.
protected abstract void

          Initializes this parameters object using the parameters specified in paramSpec.
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 String

          Returns a formatted string describing the parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AlgorithmParametersSpi

public AlgorithmParametersSpi()
Method Detail

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. 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 - on encoding errors.

engineGetParameterSpec

protected abstract AlgorithmParameterSpec engineGetParameterSpec(Class 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, be DSAParameterSpec.class, to indicate that the parameters should be returned in an instance of the DSAParameterSpec class.

Parameters:
paramSpec - the 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.

engineInit

protected abstract void engineInit(AlgorithmParameterSpec paramSpec)
                            throws InvalidParameterSpecException
Initializes this parameters object using the parameters specified in paramSpec.

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 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 - on decoding errors

engineToString

protected abstract String engineToString()
Returns a formatted string describing the parameters.

Returns:
a formatted string describing the parameters.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.