Save This Page
Home » openjdk-7 » java » security » [javadoc | source]
java.security
public class: AlgorithmParameters [javadoc | source]
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.

Every implementation of the Java platform is required to support the following standard AlgorithmParameters algorithms:

These algorithms are described in the AlgorithmParameters section of the Java Cryptography Architecture Standard Algorithm Name Documentation. Consult the release documentation for your implementation to see if any other algorithms are supported.
Constructor:
 protected AlgorithmParameters(AlgorithmParametersSpi paramSpi,
    Provider provider,
    String algorithm) 
    Creates an AlgorithmParameters object.
    Parameters:
    paramSpi - the delegate
    provider - the provider
    algorithm - the algorithm
Method from java.security.AlgorithmParameters Summary:
getAlgorithm,   getEncoded,   getEncoded,   getInstance,   getInstance,   getInstance,   getParameterSpec,   getProvider,   init,   init,   init,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.security.AlgorithmParameters Detail:
 public final String getAlgorithm() 
    Returns the name of the algorithm associated with this parameter object.
 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.
 public final byte[] getEncoded(String format) throws IOException 
    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.
 public static AlgorithmParameters getInstance(String algorithm) throws NoSuchAlgorithmException 
    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.

 public static AlgorithmParameters getInstance(String algorithm,
    String provider) throws NoSuchAlgorithmException, NoSuchProviderException 
    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.

 public static AlgorithmParameters getInstance(String algorithm,
    Provider provider) throws NoSuchAlgorithmException 
    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.

 public final T getParameterSpec(Class<T> paramSpec) throws InvalidParameterSpecException 
    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.
 public final Provider getProvider() 
    Returns the provider of this parameter object.
 public final  void init(AlgorithmParameterSpec paramSpec) throws InvalidParameterSpecException 
    Initializes this parameter object using the parameters specified in paramSpec.
 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.
 public final  void init(byte[] params,
    String format) throws IOException 
    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.
 public final String toString() 
    Returns a formatted string describing the parameters.