java.security.cert

Class PKIXBuilderParameters

java.lang.Object

java.security.cert.PKIXParameters

java.security.cert.PKIXBuilderParameters

All Implemented Interfaces:

Cloneable, CertPathParameters

public class PKIXBuilderParameters
extends PKIXParameters

The parameter specification for a PKIX CertPathBuilder algorithm used to build certificate chains validated with the PKIX certification path validation.

The parameters must be created with trusted certificate authorities and constraints for the target certificates.

See Also:

CertPathBuilder, CertPathParameters

Constructor Summary

Constructors

Constructor and Description
PKIXBuilderParameters(KeyStore keyStore, CertSelector targetConstraints) Creates a new PKIXBuilderParameters instance with the trusted X509Certificate entries from the specified KeyStore.
PKIXBuilderParameters(Set<TrustAnchor> trustAnchors, CertSelector targetConstraints) Creates a new PKIXBuilderParameters instance with the specified set of TrustAnchor and certificate constraints.

Method Summary

Modifier and Type	Method and Description
int	getMaxPathLength() Returns the maximum length of a certification path.
void	setMaxPathLength(int maxPathLength) Set the maximum length of a certification path.
String	toString() Returns a string representation of this PKIXBuilderParameters instance.

Methods inherited from class java.security.cert.PKIXParameters

addCertPathChecker, addCertStore, clone, getCertPathCheckers, getCertStores, getDate, getInitialPolicies, getPolicyQualifiersRejected, getSigProvider, getTargetCertConstraints, getTrustAnchors, isAnyPolicyInhibited, isExplicitPolicyRequired, isPolicyMappingInhibited, isRevocationEnabled, setAnyPolicyInhibited, setCertPathCheckers, setCertStores, setDate, setExplicitPolicyRequired, setInitialPolicies, setPolicyMappingInhibited, setPolicyQualifiersRejected, setRevocationEnabled, setSigProvider, setTargetCertConstraints, setTrustAnchors

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PKIXBuilderParameters

public PKIXBuilderParameters(Set<TrustAnchor> trustAnchors,
                             CertSelector targetConstraints)
                      throws InvalidAlgorithmParameterException

Creates a new PKIXBuilderParameters instance with the specified set of TrustAnchor and certificate constraints.

Parameters:

trustAnchors - the set of TrustAnchors.

targetConstraints - the certificate constraints.

Throws:

InvalidAlgorithmParameterException - if trustAnchors is empty.

ClassCastException - if one of the items in trustAnchors is not an instance of java.security.cert.TrustAnchor.

PKIXBuilderParameters

public PKIXBuilderParameters(KeyStore keyStore,
                             CertSelector targetConstraints)
                      throws KeyStoreException,
                             InvalidAlgorithmParameterException

Creates a new PKIXBuilderParameters instance with the trusted X509Certificate entries from the specified KeyStore.

Parameters:

keyStore - the key store containing trusted certificates.

targetConstraints - the certificate constraints.

Throws:

KeyStoreException - if the keyStore is not initialized.

InvalidAlgorithmParameterException - if keyStore does not contained any trusted certificate entry.

Method Detail

getMaxPathLength

public int getMaxPathLength()

Returns the maximum length of a certification path.

This is the maximum number of non-self-signed certificates in a certification path.

Returns:

the maximum length of a certification path, or -1 if it is unlimited.

setMaxPathLength

public void setMaxPathLength(int maxPathLength)

Set the maximum length of a certification path.

This is the maximum number of non-self-signed certificates in a certification path.

Parameters:

maxPathLength - the maximum length of a certification path.

Throws:

InvalidParameterException - if maxPathLength is less than -1.

toString

public String toString()

Returns a string representation of this PKIXBuilderParameters instance.

Overrides:

toString in class PKIXParameters

Returns:

a string representation of this PKIXBuilderParameters instance.