java.security.AlgorithmParameters Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.security;
import java.io.*;
import java.security.spec.AlgorithmParameterSpec;
import java.security.spec.InvalidParameterSpecException;
/**
* 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).
*
*
There are two ways to request such an implementation: by
* specifying either just an algorithm name, or both an algorithm name
* and a package provider.
*
*
*
* - If just an algorithm name is specified, the system will
* determine if there is an AlgorithmParameters
* implementation for the algorithm requested
* available in the environment, and if there is more than one, if
* there is a preferred one.
*
*
- If both an algorithm name and a package provider are specified,
* the system will determine if there is an implementation
* in the package requested, and throw an exception if there
* is not.
*
*
*
* Once an AlgorithmParameters object is returned, 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.
*
* @author Jan Luehe
*
* @version 1.19, 02/02/00
*
* @see java.security.spec.AlgorithmParameterSpec
* @see java.security.spec.DSAParameterSpec
* @see KeyPairGenerator
*
* @since 1.2
*/
public class AlgorithmParameters
{
/**
* Creates an AlgorithmParameters object.
*
* @param paramSpi the delegate
* @param provider the provider
* @param algorithm the algorithm
*/
protected AlgorithmParameters(AlgorithmParametersSpi paramSpi, Provider
provider, String algorithm)
{ }
/**
* Returns the name of the algorithm associated with this parameter object.
*
* @return the algorithm name.
*/
public final String getAlgorithm() {
return null;
}
/**
* 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.
*
* @param algorithm the name of the algorithm requested.
*
* @return the new parameter object.
*
* @exception NoSuchAlgorithmException if the algorithm is
* not available in the environment.
*/
public static AlgorithmParameters getInstance(String algorithm)
throws NoSuchAlgorithmException
{
return null;
}
/**
* 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.
*
* @param algorithm the name of the algorithm requested.
*
* @param provider the name of the provider.
*
* @return the new parameter object.
*
* @exception NoSuchAlgorithmException if the algorithm is
* not available in the package supplied by the requested
* provider.
*
* @exception NoSuchProviderException if the provider is not
* available in the environment.
*
* @exception IllegalArgumentException if the provider name is null
* or empty.
*
* @see Provider
*/
public static AlgorithmParameters getInstance(String algorithm, String
provider) throws NoSuchAlgorithmException, NoSuchProviderException
{
return null;
}
/**
* 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.
*
* @param algorithm the name of the algorithm requested.
*
* @param provider the name of the provider.
*
* @return the new parameter object.
*
* @exception NoSuchAlgorithmException if the algorithm is
* not available in the package supplied by the requested
* provider.
*
* @exception IllegalArgumentException if the provider is
* null.
*
* @see Provider
*
* @since 1.4
*/
public static AlgorithmParameters getInstance(String algorithm, Provider
provider) throws NoSuchAlgorithmException
{
return null;
}
/**
* Returns the provider of this parameter object.
*
* @return the provider of this parameter object
*/
public final Provider getProvider() {
return null;
}
/**
* 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.
*/
public final void init(AlgorithmParameterSpec paramSpec)
throws InvalidParameterSpecException
{ }
/**
* 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.
*/
public final void init(byte[] params) 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.
*
* @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.
*/
public final void init(byte[] params, String format) throws IOException { }
/**
* 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.
*/
public final AlgorithmParameterSpec getParameterSpec(Class paramSpec)
throws InvalidParameterSpecException
{
return null;
}
/**
* 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.
*/
public final byte[] getEncoded() throws IOException {
return null;
}
/**
* 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.
*/
public final byte[] getEncoded(String format) throws IOException {
return null;
}
/**
* Returns a formatted string describing the parameters.
*
* @return a formatted string describing the parameters, or null if this
* parameter object has not been initialized.
*/
public final String toString() {
return null;
}
}