Save This Page
Home » openjdk-7 » java » security » [javadoc | source]
java.security
public class: AlgorithmParameterGenerator [javadoc | source]
java.lang.Object
   java.security.AlgorithmParameterGenerator
The AlgorithmParameterGenerator class is used to generate a set of parameters to be used with a certain algorithm. Parameter generators are constructed using the getInstance factory methods (static methods that return instances of a given class).

The object that will generate the parameters can be initialized in two different ways: in an algorithm-independent manner, or in an algorithm-specific manner:

In case the client does not explicitly initialize the AlgorithmParameterGenerator (via a call to an init method), each provider must supply (and document) a default initialization. For example, the Sun provider uses a default modulus prime size of 1024 bits for the generation of DSA parameters.

Every implementation of the Java platform is required to support the following standard AlgorithmParameterGenerator algorithms and keysizes in parentheses:

These algorithms are described in the AlgorithmParameterGenerator 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 AlgorithmParameterGenerator(AlgorithmParameterGeneratorSpi paramGenSpi,
    Provider provider,
    String algorithm) 
    Creates an AlgorithmParameterGenerator object.
    Parameters:
    paramGenSpi - the delegate
    provider - the provider
    algorithm - the algorithm
Method from java.security.AlgorithmParameterGenerator Summary:
generateParameters,   getAlgorithm,   getInstance,   getInstance,   getInstance,   getProvider,   init,   init,   init,   init
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.security.AlgorithmParameterGenerator Detail:
 public final AlgorithmParameters generateParameters() 
    Generates the parameters.
 public final String getAlgorithm() 
    Returns the standard name of the algorithm this parameter generator is associated with.
 public static AlgorithmParameterGenerator getInstance(String algorithm) throws NoSuchAlgorithmException 
    Returns an AlgorithmParameterGenerator object for generating a set of parameters to be used with the specified algorithm.

    This method traverses the list of registered security Providers, starting with the most preferred Provider. A new AlgorithmParameterGenerator object encapsulating the AlgorithmParameterGeneratorSpi 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.

 public static AlgorithmParameterGenerator getInstance(String algorithm,
    String provider) throws NoSuchAlgorithmException, NoSuchProviderException 
    Returns an AlgorithmParameterGenerator object for generating a set of parameters to be used with the specified algorithm.

    A new AlgorithmParameterGenerator object encapsulating the AlgorithmParameterGeneratorSpi 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.

 public static AlgorithmParameterGenerator getInstance(String algorithm,
    Provider provider) throws NoSuchAlgorithmException 
    Returns an AlgorithmParameterGenerator object for generating a set of parameters to be used with the specified algorithm.

    A new AlgorithmParameterGenerator object encapsulating the AlgorithmParameterGeneratorSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

 public final Provider getProvider() 
    Returns the provider of this algorithm parameter generator object.
 public final  void init(int size) 
    Initializes this parameter generator for a certain size. To create the parameters, the SecureRandom implementation of the highest-priority installed provider is used as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness is used.)
 public final  void init(AlgorithmParameterSpec genParamSpec) throws InvalidAlgorithmParameterException 
    Initializes this parameter generator with a set of algorithm-specific parameter generation values. To generate the parameters, the SecureRandom implementation of the highest-priority installed provider is used as the source of randomness. (If none of the installed providers supply an implementation of SecureRandom, a system-provided source of randomness is used.)
 public final  void init(int size,
    SecureRandom random) 
    Initializes this parameter generator for a certain size and source of randomness.
 public final  void init(AlgorithmParameterSpec genParamSpec,
    SecureRandom random) throws InvalidAlgorithmParameterException 
    Initializes this parameter generator with a set of algorithm-specific parameter generation values.