java.lang.Object java.security.AlgorithmParameters
public class 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.
Constructor Summary | |
---|---|
protected |
AlgorithmParameters
(
AlgorithmParametersSpi
paramSpi,
Provider
provider,
String
algorithm) Creates an AlgorithmParameters object. |
Method Summary | ||
---|---|---|
String |
getAlgorithm
() Returns the name of the algorithm associated with this parameter object. |
|
byte[] |
getEncoded
() Returns the parameters in their primary encoding format. |
|
byte[] |
getEncoded
(
String
format) Returns the parameters encoded in the specified scheme. |
|
static AlgorithmParameters |
getInstance
(
String
algorithm) Returns a parameter object for the specified algorithm. |
|
static AlgorithmParameters |
getInstance
(
String
algorithm,
Provider
provider) Returns a parameter object for the specified algorithm. |
|
static AlgorithmParameters |
getInstance
(
String
algorithm,
String
provider) Returns a parameter object for the specified algorithm. |
|
|
getParameterSpec
(
Class
<T> paramSpec) Returns a (transparent) specification of this parameter object. |
|
Provider |
getProvider
() Returns the provider of this parameter object. |
|
void |
init
(
AlgorithmParameterSpec
paramSpec) Initializes this parameter object using the parameters specified in paramSpec. |
|
void |
init
(byte[] params) Imports the specified parameters and decodes them according to the primary decoding format for parameters. |
|
void |
init
(byte[] params,
String
format) Imports the parameters from params and decodes them according to the specified decoding scheme. |
|
String |
toString
() Returns a formatted string describing the parameters. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait |
Constructor Detail |
---|
protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm)
Method Detail |
---|
public final String getAlgorithm()
public static AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException
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.
public static AlgorithmParameters getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
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.
public static AlgorithmParameters getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
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.
public final Provider getProvider()
public final void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException
public final void init(byte[] params) throws IOException
public final void init(byte[] params, String format) throws IOException
public final <T extends AlgorithmParameterSpec> T getParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException
public final byte[] getEncoded() throws IOException
public final byte[] getEncoded(String format) throws IOException
public final String toString()