* This class uses a provider-based architecture, as described in the Java
* Cryptography Architecture. To create a CertPathValidator,
* call one of the static getInstance methods, passing in the
* algorithm name of the CertPathValidator desired and
* optionally the name of the provider desired.
*
* Once a CertPathValidator object has been created, it can
* be used to validate certification paths by calling the {@link #validate
* validate} method and passing it the CertPath to be validated
* and an algorithm-specific set of parameters. If successful, the result is
* returned in an object that implements the
* CertPathValidatorResult interface.
*
* Concurrent Access *
* The static methods of this class are guaranteed to be thread-safe. * Multiple threads may concurrently invoke the static methods defined in * this class with no ill effects. *
* However, this is not true for the non-static methods defined by this class.
* Unless otherwise documented by a specific provider, threads that need to
* access a single CertPathValidator instance concurrently should
* synchronize amongst themselves and provide the necessary locking. Multiple
* threads each manipulating a different CertPathValidator
* instance need not synchronize.
*
* @see CertPath
*
* @version 1.9 06/28/04
* @since 1.4
* @author Yassir Elley
*/
public class CertPathValidator {
/*
* Constant to lookup in the Security properties file to determine
* the default certpathvalidator type. In the Security properties file,
* the default certpathvalidator type is given as:
*
* certpathvalidator.type=PKIX
*
*/
private static final String CPV_TYPE = "certpathvalidator.type";
private static final Debug debug = Debug.getInstance("certpath");
private CertPathValidatorSpi validatorSpi;
private Provider provider;
private String algorithm;
/**
* Creates a CertPathValidator object of the given algorithm,
* and encapsulates the given provider implementation (SPI object) in it.
*
* @param validatorSpi the provider implementation
* @param provider the provider
* @param algorithm the algorithm name
*/
protected CertPathValidator(CertPathValidatorSpi validatorSpi,
Provider provider, String algorithm)
{
this.validatorSpi = validatorSpi;
this.provider = provider;
this.algorithm = algorithm;
}
/**
* Returns a CertPathValidator object that implements the
* specified algorithm.
*
* If the default provider package provides an implementation of the
* specified CertPathValidator algorithm, an instance of
* CertPathValidator containing that implementation is
* returned. If the requested algorithm is not available in the default
* package, other packages are searched.
*
* @param algorithm the name of the requested CertPathValidator
* algorithm
* @return a CertPathValidator object that implements the
* specified algorithm
* @exception NoSuchAlgorithmException if the requested algorithm
* is not available in the default provider package or any of the other
* provider packages that were searched
*/
public static CertPathValidator getInstance(String algorithm)
throws NoSuchAlgorithmException {
Instance instance = GetInstance.getInstance("CertPathValidator",
CertPathValidatorSpi.class, algorithm);
return new CertPathValidator((CertPathValidatorSpi)instance.impl,
instance.provider, algorithm);
}
/**
* Returns a CertPathValidator object that implements the
* specified algorithm, as supplied by the specified provider.
*
* @param algorithm the name of the requested CertPathValidator
* algorithm
* @param provider the name of the provider
* @return a CertPathValidator object that implements the
* specified algorithm, as supplied by the specified provider
* @exception NoSuchAlgorithmException if the requested algorithm
* is not available from the specified provider
* @exception NoSuchProviderException if the provider has not been
* configured
* @exception IllegalArgumentException if the provider is
* null
*/
public static CertPathValidator getInstance(String algorithm,
String provider) throws NoSuchAlgorithmException,
NoSuchProviderException {
Instance instance = GetInstance.getInstance("CertPathValidator",
CertPathValidatorSpi.class, algorithm, provider);
return new CertPathValidator((CertPathValidatorSpi)instance.impl,
instance.provider, algorithm);
}
/**
* Returns a CertPathValidator object that implements the
* specified algorithm, as supplied by the specified provider.
* Note: the provider doesn't have to be registered.
*
* @param algorithm the name of the requested
* CertPathValidator algorithm
* @param provider the provider
* @return a CertPathValidator object that implements the
* specified algorithm, as supplied by the specified provider
* @exception NoSuchAlgorithmException if the requested algorithm
* is not available from the specified provider
* @exception IllegalArgumentException if the provider is
* null
*/
public static CertPathValidator getInstance(String algorithm,
Provider provider) throws NoSuchAlgorithmException {
Instance instance = GetInstance.getInstance("CertPathValidator",
CertPathValidatorSpi.class, algorithm, provider);
return new CertPathValidator((CertPathValidatorSpi)instance.impl,
instance.provider, algorithm);
}
/**
* Returns the Provider of this
* CertPathValidator.
*
* @return the Provider of this CertPathValidator
*/
public final Provider getProvider() {
return this.provider;
}
/**
* Returns the algorithm name of this CertPathValidator.
*
* @return the algorithm name of this CertPathValidator
*/
public final String getAlgorithm() {
return this.algorithm;
}
/**
* Validates the specified certification path using the specified
* algorithm parameter set.
*
* The CertPath specified must be of a type that is
* supported by the validation algorithm, otherwise an
* InvalidAlgorithmParameterException will be thrown. For
* example, a CertPathValidator that implements the PKIX
* algorithm validates CertPath objects of type X.509.
*
* @param certPath the CertPath to be validated
* @param params the algorithm parameters
* @return the result of the validation algorithm
* @exception CertPathValidatorException if the CertPath
* does not validate
* @exception InvalidAlgorithmParameterException if the specified
* parameters or the type of the specified CertPath are
* inappropriate for this CertPathValidator
*/
public final CertPathValidatorResult validate(CertPath certPath,
CertPathParameters params)
throws CertPathValidatorException, InvalidAlgorithmParameterException
{
return validatorSpi.engineValidate(certPath, params);
}
/**
* Returns the default CertPathValidator type as specified in
* the Java security properties file, or the string "PKIX"
* if no such property exists. The Java security properties file is
* located in the file named <JAVA_HOME>/lib/security/java.security,
* where <JAVA_HOME> refers to the directory where the JDK was
* installed.
*
*
The default CertPathValidator type can be used by
* applications that do not want to use a hard-coded type when calling one
* of the getInstance methods, and want to provide a default
* type in case a user does not specify its own.
*
*
The default CertPathValidator type can be changed by
* setting the value of the "certpathvalidator.type" security property
* (in the Java security properties file) to the desired type.
*
* @return the default CertPathValidator type as specified
* in the Java security properties file, or the string "PKIX"
* if no such property exists.
*/
public final static String getDefaultType() {
String cpvtype;
cpvtype = (String)AccessController.doPrivileged(new PrivilegedAction() {
public Object run() {
return Security.getProperty(CPV_TYPE);
}
});
if (cpvtype == null) {
cpvtype = "PKIX";
}
return cpvtype;
}
}