All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class au.net.aba.security.AlgorithmParameters

java.lang.Object
   |
   +----au.net.aba.security.AlgorithmParameters

public class AlgorithmParameters
extends Object
This class is used as an opaque representation of cryptographic parameters.

An AlgorithmParameters object for managing the parameters for a particular algorithm can be obtained by calling one of the getInstance factory methods (static methods that return instances of a given class).

There are two ways to request such an implementation: by specifying either just an algorithm name, or both an algorithm name and a package provider.

If just an algorithm name is specified, the system will determine if there is an AlgorithmParameters implementation for the algorithm requested available in the environment, and if there is more than one, if there is a preferred one.

If both an algorithm name and a package provider are specified, the system will determine if there is an implementation in the package requested, and throw an exception if there is not.

Once an AlgorithmParameters object is returned, it must be initialised via a call to init, using an appropriate parameter specification or parameter encoding.

A transparent parameter specification is obtained from an AlgorithmParameters object via a call to getParameterSpec, and a byte encoding of the parameters is obtained via a call to getEncoded.

See Also:
AlgorithmParameterSpec, DSAParameterSpec, KeyPairGenerator

Variable Index

 o ident

Constructor Index

 o AlgorithmParameters(AlgorithmParametersSpi, Provider, String)
Creates an AlgorithmParameters object.

Method Index

 o getAlgorithm()
Returns the name of the algorithm associated with the parameter set.
 o getEncoded()
Returns the parameters in their primary encoding format.
 o getEncoded(String)
Returns the parameters encoded in the specified format.
 o getInstance(String)
Generates an AlgorithmParameters object that implements the specified digest algorithm.
 o getInstance(String, String)
Generates an AlgorithmParameters object for the specified algorithm, as supplied from the specified provider, if such an algorithm is available from the provider.
 o getParameterSpec(Class)
Returns a (transparent) specification of this parameters object.
 o getProvider()
Returns the provider of this algorithm parameter object.
 o init(AlgorithmParameterSpec)
Initialises this parameters object using the parameters specified in paramSpec.
 o init(byte[])
Imports the specified parameters and decodes them according to the primary decoding format for parameters.
 o init(byte[], String)
Imports the parameters from params and decodes them according to the specified decoding format.
 o toString()
Returns a formatted string describing the parameters.

Variables

 o ident
 public static final String ident

Constructors

 o AlgorithmParameters
 protected AlgorithmParameters(AlgorithmParametersSpi paramSpi,
                               Provider provider,
                               String algorithm)
Creates an AlgorithmParameters object.

Parameters:
keyFacSpi - the delegate
provider - the provider
algorithm - the algorithm

Methods

 o getAlgorithm
 public final String getAlgorithm()
Returns the name of the algorithm associated with the parameter set.

Returns:
the algorithm name.
 o getInstance
 public static final AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException
Generates an AlgorithmParameters object that implements the specified digest algorithm. If the default provider package provides an implementation of the requested digest algorithm, an instance of AlgorithmParameters containing that implementation is returned. If the algorithm is not available in the default package, other packages are searched.

Parameters:
algorithm - the name of the algorithm requested.
Returns:
the new AlgorithmParameters object.
Throws: NoSuchAlgorithmException
if the algorithm is not available in the environment.
 o getInstance
 public static final AlgorithmParameters getInstance(String algorithm,
                                                     String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Generates an AlgorithmParameters object for the specified algorithm, as supplied from the specified provider, if such an algorithm is available from the provider.

Parameters:
algorithm - - the name of the algorithm requested.
provider - - the name of the provider.
Returns:
the new AlgorithmParameters object.
Throws: NoSuchAlgorithmException
if the algorithm is not available in the package supplied by the requested provider.
Throws: NoSuchProviderException
if the provider is not available in the environment.
See Also:
Provider
 o getProvider
 public final Provider getProvider()
Returns the provider of this algorithm parameter object.

Returns:
the provider of this algorithm parameter object
 o init
 public final void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException
Initialises 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 initialisation of this parameter object.
 o init
 public final void init(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
 o init
 public final void init(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
 o getParameterSpec
 public final AlgorithmParameterSpec getParameterSpec(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 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.
 o getEncoded
 public final byte[] getEncoded() 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 the specified encoding scheme.
Throws: IOException
- on encoding errors.
 o getEncoded
 public final byte[] getEncoded(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.
 o toString
 public final String toString()
Returns a formatted string describing the parameters.

Returns:
a formatted string describing the parameters, or null if this object has not been initialised.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index