java.security.cert: public class: CertPathValidator

java.security.cert
public class: CertPathValidator [javadoc | source]

java.lang.Object
   java.security.cert.CertPathValidator

A class for validating certification paths (also known as certificate chains).

This class uses a provider-based 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 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.

Also see:

CertPath

since: 1.4 -

author: Yassir - Elley

Constructor:

Constructor:
protected CertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm) { this.validatorSpi = validatorSpi; this.provider = provider; this.algorithm = algorithm; } Creates a `CertPathValidator` object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it. Parameters: `validatorSpi` - the provider implementation `provider` - the provider `algorithm` - the algorithm name

 protected CertPathValidator(CertPathValidatorSpi validatorSpi,
    Provider provider,
    String algorithm) {
                                         
        this.validatorSpi = validatorSpi;
        this.provider = provider;
        this.algorithm = algorithm;
}

CertPathValidator

Parameters:

validatorSpi - the provider implementation

provider - the provider

algorithm - the algorithm name

Method from java.security.cert.CertPathValidator Summary:
getAlgorithm, getDefaultType, getInstance, getInstance, getInstance, getProvider, validate

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.security.cert.CertPathValidator Detail:
public final String getAlgorithm() { return this.algorithm; } Returns the algorithm name of this `CertPathValidator`.
public static final String getDefaultType() { String cpvtype; cpvtype = AccessController.doPrivileged(new PrivilegedAction< String >() { public String run() { return Security.getProperty(CPV_TYPE); } }); if (cpvtype == null) { cpvtype = "PKIX"; } return cpvtype; } 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. <JAVA_HOME> refers to the value of the java.home system property, and specifies the directory where the JRE is 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.
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. This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 CertPathValidator getInstance(String algorithm, String provider) throws NoSuchProviderException, NoSuchAlgorithmException { 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. A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 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 a `CertPathValidator` object that implements the specified algorithm. A new CertPathValidator object encapsulating the CertPathValidatorSpi 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() { return this.provider; } Returns the `Provider` of this `CertPathValidator`.
public final CertPathValidatorResult validate(CertPath certPath, CertPathParameters params) throws CertPathValidatorException, InvalidAlgorithmParameterException { return validatorSpi.engineValidate(certPath, params); } 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.

Method from java.security.cert.CertPathValidator Detail:

 public final String getAlgorithm() {
        return this.algorithm;
}

CertPathValidator

 public static final String getDefaultType() {
        String cpvtype;
        cpvtype = AccessController.doPrivileged(new PrivilegedAction< String >() {
            public String run() {
                return Security.getProperty(CPV_TYPE);
            }
        });
        if (cpvtype == null) {
            cpvtype = "PKIX";
        }
        return cpvtype;
}

CertPathValidator

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.

 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);
}

CertPathValidator

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 CertPathValidator getInstance(String algorithm,
    String provider) throws NoSuchProviderException, NoSuchAlgorithmException {
        Instance instance = GetInstance.getInstance("CertPathValidator",
            CertPathValidatorSpi.class, algorithm, provider);
        return new CertPathValidator((CertPathValidatorSpi)instance.impl,
            instance.provider, algorithm);
}

CertPathValidator

A new CertPathValidator object encapsulating the CertPathValidatorSpi 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 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);
}

CertPathValidator

A new CertPathValidator object encapsulating the CertPathValidatorSpi 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() {
        return this.provider;
}

Provider

CertPathValidator

 public final CertPathValidatorResult validate(CertPath certPath,
    CertPathParameters params) throws CertPathValidatorException, InvalidAlgorithmParameterException {
        return validatorSpi.engineValidate(certPath, params);
}

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.