java.lang.Object | |
↳ | java.security.AlgorithmParameters |
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).
Once an AlgorithmParameters
object is obtained, 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
.
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates an AlgorithmParameters object.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the name of the algorithm associated with this parameter object.
| |||||||||||
Returns the parameters encoded in the specified scheme.
| |||||||||||
Returns the parameters in their primary encoding format.
| |||||||||||
Returns a parameter object for the specified algorithm.
| |||||||||||
Returns a parameter object for the specified algorithm.
| |||||||||||
Returns a parameter object for the specified algorithm.
| |||||||||||
Returns a (transparent) specification of this parameter object.
| |||||||||||
Returns the provider of this parameter object.
| |||||||||||
Initializes this parameter object using the parameters
specified in
paramSpec . | |||||||||||
Imports the parameters from
params and decodes them
according to the specified decoding scheme. | |||||||||||
Imports the specified parameters and decodes them according to the
primary decoding format for parameters.
| |||||||||||
Returns a formatted string describing the parameters.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Creates an AlgorithmParameters object.
paramSpi | the delegate |
---|---|
provider | the provider |
algorithm | the algorithm |
Returns the name of the algorithm associated with this parameter object.
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.
format | the name of the encoding format. |
---|
IOException | on encoding errors, or if this parameter object has not been initialized. |
---|
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.
IOException | on encoding errors, or if this parameter object has not been initialized. |
---|
Returns a parameter object for the specified algorithm.
A new AlgorithmParameters object encapsulating the AlgorithmParametersSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
The returned parameter object must be initialized via a call to
init
, using an appropriate parameter specification or
parameter encoding.
algorithm | the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. |
---|---|
provider | the name of the provider. |
NoSuchAlgorithmException | if an AlgorithmParametersSpi implementation for the specified algorithm is not available from the specified provider. |
---|---|
NoSuchProviderException | if the specified provider is not registered in the security provider list. |
IllegalArgumentException | if the provider name is null or empty. |
Returns a parameter object for the specified algorithm.
A new AlgorithmParameters object encapsulating the AlgorithmParametersSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
The returned parameter object must be initialized via a call to
init
, using an appropriate parameter specification or
parameter encoding.
algorithm | the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. |
---|---|
provider | the name of the provider. |
NoSuchAlgorithmException | if an AlgorithmParameterGeneratorSpi implementation for the specified algorithm is not available from the specified Provider object. |
---|---|
IllegalArgumentException | if the provider is null. |
Returns a parameter object for the specified algorithm.
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new AlgorithmParameters object encapsulating the AlgorithmParametersSpi implementation from the first Provider that supports the specified algorithm is returned.
Note that the list of registered providers may be retrieved via
the Security.getProviders()
method.
The returned parameter object must be initialized via a call to
init
, using an appropriate parameter specification or
parameter encoding.
algorithm | the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. |
---|
NoSuchAlgorithmException | if no Provider supports an AlgorithmParametersSpi implementation for the specified algorithm. |
---|
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.
paramSpec | the specification class in which the parameters should be returned. |
---|
InvalidParameterSpecException | if the requested parameter specification is inappropriate for this parameter object, or if this parameter object has not been initialized. |
---|
Returns the provider of this parameter object.
Initializes this parameter object using the parameters
specified in paramSpec
.
paramSpec | the parameter specification. |
---|
InvalidParameterSpecException | if the given parameter specification is inappropriate for the initialization of this parameter object, or if this parameter object has already been initialized. |
---|
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.
params | the encoded parameters. |
---|---|
format | the name of the decoding scheme. |
IOException | on decoding errors, or if this parameter object has already been initialized. |
---|
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.
params | the encoded parameters. |
---|
IOException | on decoding errors, or if this parameter object has already been initialized. |
---|
Returns a formatted string describing the parameters.