java.security
Class AlgorithmParameters

java.lang.Object
 |
 +--java.security.AlgorithmParameters

public class AlgorithmParameters

extends Object

Untamed:

provider

private Provider provider

paramSpi

private AlgorithmParametersSpi paramSpi

algorithm

private String algorithm

initialized

private boolean initialized

AlgorithmParameters

protected AlgorithmParameters(AlgorithmParametersSpi paramSpi,
 Provider provider,
 String algorithm)

Creates an AlgorithmParameters object.

Parameters:

paramSpi - the delegate

provider - the provider

algorithm - the algorithm

getAlgorithm

public final String getAlgorithm()

Enabled: Returns the name of the algorithm associated with this parameter object.

Returns:

the algorithm name.

getInstance

public static AlgorithmParameters getInstance(String algorithm)
 throws NoSuchAlgorithmException

Enabled: 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.

Returns:

the new parameter object.

NoSuchAlgorithmException

getInstance

public static AlgorithmParameters getInstance(String algorithm,
 String provider)
 throws NoSuchAlgorithmException,
 NoSuchProviderException

Enabled: 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.

provider - the name of the provider.

Returns:

the new parameter object.

NoSuchAlgorithmException

NoSuchProviderException

See Also:

Provider

getInstance

public static AlgorithmParameters getInstance(String algorithm,
 Provider provider)
 throws NoSuchAlgorithmException

Enabled: 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.

provider - the name of the provider.

Returns:

the new parameter object.

NoSuchAlgorithmException

Since:

1.4

See Also:

Provider

getProvider

public final Provider getProvider()

Enabled: Returns the provider of this parameter object.

Returns:

the provider of this parameter object

init

public final void init(AlgorithmParameterSpec paramSpec)
 throws InvalidParameterSpecException

Enabled: Initializes this parameter object using the parameters specified in paramSpec.

Parameters:

paramSpec - the parameter specification.

InvalidParameterSpecException

init

public final void init(byte[] params)
 throws IOException

Enabled: 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.

IOException

init

public final void init(byte[] params,
 String format)
 throws IOException

Enabled: 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.

format - the name of the decoding scheme.

IOException

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec(Class paramSpec)
 throws InvalidParameterSpecException

Enabled: 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.

Returns:

the parameter specification.

InvalidParameterSpecException

getEncoded

public final byte[] getEncoded()
 throws IOException

Enabled: 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.

IOException

getEncoded

public final byte[] getEncoded(String format)
 throws IOException

Enabled: 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.

Returns:

the parameters encoded using the specified encoding scheme.

IOException

toString

public final String toString()

Suppressed: Returns a formatted string describing the parameters.

Overrides:

toString in class Object

Returns:

a formatted string describing the parameters, or null if this parameter object has not been initialized.