| java.lang.Object
 java.security.AlgorithmParameters
| AlgorithmParameters | | public class AlgorithmParameters (Code) | | 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
initialized 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.
author:
Jan Luehe
version:
1.19, 02/02/00
See Also: java.security.spec.AlgorithmParameterSpec
See Also: java.security.spec.DSAParameterSpec
See Also: KeyPairGenerator
since:
1.2 |
| Method Summary | |
| final public String | getAlgorithm()
Returns the name of the algorithm associated with this parameter object. | | final public byte[] | getEncoded()
Returns the parameters in their primary encoding format. | | final public byte[] | getEncoded(String format)
Returns the parameters encoded in the specified scheme.
If format is null, the
primary encoding format for parameters is used. | | public static AlgorithmParameters | getInstance(String algorithm)
Generates a parameter object for the specified algorithm.
If the default provider package provides an implementation of the
requested algorithm, an instance of AlgorithmParameters containing that
implementation is returned.
If the algorithm is not available in the default
package, other packages are searched.
The returned parameter object must be initialized via a call to
init, using an appropriate parameter specification or
parameter encoding.
Parameters:
algorithm - the name of the algorithm requested. | | public static AlgorithmParameters | getInstance(String algorithm, String provider)
Generates a parameter object for the specified algorithm, as supplied
by the specified provider, if such an algorithm is available from the
provider.
The returned parameter object must be initialized via a call to
init, using an appropriate parameter specification or
parameter encoding.
Parameters:
algorithm - the name of the algorithm requested.
Parameters:
provider - the name of the provider. | | public static AlgorithmParameters | getInstance(String algorithm, Provider provider)
Generates a parameter object for the specified algorithm, as supplied
by the specified provider, if such an algorithm is available from the
provider. | | final public AlgorithmParameterSpec | getParameterSpec(Class paramSpec)
Returns a (transparent) specification of this parameter object.
paramSpec identifies the specification class in which
the parameters should be returned. | | final public Provider | getProvider()
Returns the provider of this parameter object. | | final public void | init(AlgorithmParameterSpec paramSpec)
Initializes this parameter object using the parameters
specified in paramSpec. | | final public void | init(byte[] params)
Imports the specified parameters and decodes them according to the
primary decoding format for parameters. | | final public void | init(byte[] params, String format)
Imports the parameters from params and decodes them
according to the specified decoding scheme.
If format is null, the
primary decoding format for parameters is used. | | final public String | toString()
Returns a formatted string describing the parameters. |
| AlgorithmParameters | | protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm)(Code) | | Creates an AlgorithmParameters object.
Parameters:
paramSpi - the delegate
Parameters:
provider - the provider
Parameters:
algorithm - the algorithm |
| getAlgorithm | | final public String getAlgorithm()(Code) | | Returns the name of the algorithm associated with this parameter object.
the algorithm name. |
| getEncoded | | final public byte[] getEncoded() throws IOException(Code) | | 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.
the parameters encoded using their primary encoding format.
exception:
IOException - on encoding errors, or if this parameter objecthas not been initialized. |
| getEncoded | | final public byte[] getEncoded(String format) throws IOException(Code) | | Returns the parameters encoded in the specified scheme.
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. the parameters encoded using the specified encoding scheme.
exception:
IOException - on encoding errors, or if this parameter objecthas not been initialized. |
| getInstance | | public static AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException(Code) | | Generates a parameter object for the specified algorithm.
If the default provider package provides an implementation of the
requested algorithm, an instance of AlgorithmParameters containing that
implementation is returned.
If the algorithm is not available in the default
package, other packages are searched.
The returned parameter object must be initialized via a call to
init, using an appropriate parameter specification or
parameter encoding.
Parameters:
algorithm - the name of the algorithm requested. the new parameter object.
exception:
NoSuchAlgorithmException - if the algorithm isnot available in the environment. |
| getInstance | | public static AlgorithmParameters getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException(Code) | | Generates a parameter object for the specified algorithm, as supplied
by the specified provider, if such an algorithm is available from the
provider.
The returned parameter object must be initialized via a call to
init, using an appropriate parameter specification or
parameter encoding.
Parameters:
algorithm - the name of the algorithm requested.
Parameters:
provider - the name of the provider. the new parameter object.
exception:
NoSuchAlgorithmException - if the algorithm isnot available in the package supplied by the requestedprovider.
exception:
NoSuchProviderException - if the provider is notavailable in the environment.
exception:
IllegalArgumentException - if the provider name is nullor empty.
See Also: Provider
See Also: |
| getInstance | | public static AlgorithmParameters getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException(Code) | | Generates a parameter object for the specified algorithm, as supplied
by the specified provider, if such an algorithm is available from the
provider. Note: the provider doesn't have to be registered.
The returned parameter object must be initialized via a call to
init, using an appropriate parameter specification or
parameter encoding.
Parameters:
algorithm - the name of the algorithm requested.
Parameters:
provider - the name of the provider. the new parameter object.
exception:
NoSuchAlgorithmException - if the algorithm isnot available in the package supplied by the requestedprovider.
exception:
IllegalArgumentException - if the provider isnull.
See Also: Provider
since:
1.4 |
| getParameterSpec | | final public AlgorithmParameterSpec getParameterSpec(Class paramSpec) throws InvalidParameterSpecException(Code) | | Returns a (transparent) specification of this parameter 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. the parameter specification.
exception:
InvalidParameterSpecException - if the requested parameterspecification is inappropriate for this parameter object, or if thisparameter object has not been initialized. |
| getProvider | | final public Provider getProvider()(Code) | | Returns the provider of this parameter object.
the provider of this parameter object |
| init | | final public void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException(Code) | | Initializes this parameter object using the parameters
specified in paramSpec.
Parameters:
paramSpec - the parameter specification.
exception:
InvalidParameterSpecException - if the given parameterspecification is inappropriate for the initialization of this parameterobject, or if this parameter object has already been initialized. |
| init | | final public void init(byte[] params) throws IOException(Code) | | 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.
exception:
IOException - on decoding errors, or if this parameter objecthas already been initialized. |
| init | | final public void init(byte[] params, String format) throws IOException(Code) | | Imports the parameters from params and decodes them
according to the specified decoding scheme.
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.
Parameters:
format - the name of the decoding scheme.
exception:
IOException - on decoding errors, or if this parameter objecthas already been initialized. |
| toString | | final public String toString()(Code) | | Returns a formatted string describing the parameters.
a formatted string describing the parameters, or null if thisparameter object has not been initialized. |
|
|