File	Doc	Category	Size	Date	Package
AlgorithmParameters.java	API Doc	Java SE 6 API	12768	Tue Jun 10 00:25:46 BST 2008	java.security

AlgorithmParameters

• java.lang.Object

Fields Summary
private Provider	provider
private AlgorithmParametersSpi	paramSpi
private String	algorithm
private boolean	initialized

Constructors Summary
protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider provider, String algorithm) Creates an AlgorithmParameters object. param paramSpi the delegate param provider the provider param algorithm the algorithm this.paramSpi = paramSpi; this.provider = provider; this.algorithm = algorithm;

Methods Summary
public final java.lang.String	getAlgorithm() Returns the name of the algorithm associated with this parameter object. return the algorithm name. return this.algorithm;
public final byte[]	getEncoded() 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. return the parameters encoded using their primary encoding format. exception IOException on encoding errors, or if this parameter object has not been initialized. if (this.initialized == false) { throw new IOException("not initialized"); } return paramSpi.engineGetEncoded();
public final byte[]	getEncoded(java.lang.String format) 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. param format the name of the encoding format. return the parameters encoded using the specified encoding scheme. exception IOException on encoding errors, or if this parameter object has not been initialized. if (this.initialized == false) { throw new IOException("not initialized"); } return paramSpi.engineGetEncoded(format);
public static java.security.AlgorithmParameters	getInstance(java.lang.String algorithm) 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 {@link Security#getProviders() Security.getProviders()} method. The returned parameter object must be initialized via a call to init, using an appropriate parameter specification or parameter encoding. param algorithm the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. return the new parameter object. exception NoSuchAlgorithmException if no Provider supports an AlgorithmParametersSpi implementation for the specified algorithm. see Provider try { Object[] objs = Security.getImpl(algorithm, "AlgorithmParameters", (String)null); return new AlgorithmParameters((AlgorithmParametersSpi)objs[0], (Provider)objs[1], algorithm); } catch(NoSuchProviderException e) { throw new NoSuchAlgorithmException(algorithm + " not found"); }
public static java.security.AlgorithmParameters	getInstance(java.lang.String algorithm, java.lang.String provider) 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 {@link Security#getProviders() Security.getProviders()} method. The returned parameter object must be initialized via a call to init, using an appropriate parameter specification or parameter encoding. param algorithm the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. param provider the name of the provider. return the new parameter object. exception NoSuchAlgorithmException if an AlgorithmParametersSpi implementation for the specified algorithm is not available from the specified provider. exception NoSuchProviderException if the specified provider is not registered in the security provider list. exception IllegalArgumentException if the provider name is null or empty. see Provider if (provider == null || provider.length() == 0) throw new IllegalArgumentException("missing provider"); Object[] objs = Security.getImpl(algorithm, "AlgorithmParameters", provider); return new AlgorithmParameters((AlgorithmParametersSpi)objs[0], (Provider)objs[1], algorithm);
public static java.security.AlgorithmParameters	getInstance(java.lang.String algorithm, java.security.Provider provider) 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. param algorithm the name of the algorithm requested. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names. param provider the name of the provider. return the new parameter object. exception NoSuchAlgorithmException if an AlgorithmParameterGeneratorSpi implementation for the specified algorithm is not available from the specified Provider object. exception IllegalArgumentException if the provider is null. see Provider since 1.4 if (provider == null) throw new IllegalArgumentException("missing provider"); Object[] objs = Security.getImpl(algorithm, "AlgorithmParameters", provider); return new AlgorithmParameters((AlgorithmParametersSpi)objs[0], (Provider)objs[1], algorithm);
public final T	getParameterSpec(java.lang.Class paramSpec) 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. param paramSpec the specification class in which the parameters should be returned. return the parameter specification. exception InvalidParameterSpecException if the requested parameter specification is inappropriate for this parameter object, or if this parameter object has not been initialized. if (this.initialized == false) { throw new InvalidParameterSpecException("not initialized"); } return paramSpi.engineGetParameterSpec(paramSpec);
public final java.security.Provider	getProvider() Returns the provider of this parameter object. return the provider of this parameter object return this.provider;
public final void	init(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this parameter object using the parameters specified in paramSpec. param paramSpec the parameter specification. exception InvalidParameterSpecException if the given parameter specification is inappropriate for the initialization of this parameter object, or if this parameter object has already been initialized. if (this.initialized) throw new InvalidParameterSpecException("already initialized"); paramSpi.engineInit(paramSpec); this.initialized = true;
public final void	init(byte[] params) 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. param params the encoded parameters. exception IOException on decoding errors, or if this parameter object has already been initialized. if (this.initialized) throw new IOException("already initialized"); paramSpi.engineInit(params); this.initialized = true;
public final void	init(byte[] params, java.lang.String format) 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. param params the encoded parameters. param format the name of the decoding scheme. exception IOException on decoding errors, or if this parameter object has already been initialized. if (this.initialized) throw new IOException("already initialized"); paramSpi.engineInit(params, format); this.initialized = true;
public final java.lang.String	toString() Returns a formatted string describing the parameters. return a formatted string describing the parameters, or null if this parameter object has not been initialized. if (this.initialized == false) { return null; } return paramSpi.engineToString();