public class

ExtendedPKIXBuilderParameters

extends ExtendedPKIXParameters

java.lang.Object
↳	java.security.cert.PKIXParameters
	↳	org.bouncycastle.x509.ExtendedPKIXParameters
		↳	org.bouncycastle.x509.ExtendedPKIXBuilderParameters

Class Overview

This class contains extended parameters for PKIX certification path builders.

Summary

[Expand]

Inherited Constants

From class org.bouncycastle.x509.ExtendedPKIXParameters

Public Constructors
	ExtendedPKIXBuilderParameters(Set trustAnchors, Selector targetConstraints) Creates an instance of `PKIXBuilderParameters` with the specified `Set` of most-trusted CAs.

Public Methods
Object	clone() Makes a copy of this `PKIXParameters` object.
Set	getExcludedCerts() Excluded certificates are not used for building a certification path.
static ExtendedPKIXParameters	getInstance(PKIXParameters pkixParams) Returns an instance of `ExtendedPKIXParameters` which can be safely casted to `ExtendedPKIXBuilderParameters`.
int	getMaxPathLength() Returns the value of the maximum number of intermediate non-self-issued certificates in the certification path.
void	setExcludedCerts(Set excludedCerts) Sets the excluded certificates which are not used for building a certification path.
void	setMaxPathLength(int maxPathLength) Sets the maximum number of intermediate non-self-issued certificates in a certification path.

Protected Methods
void	setParams(PKIXParameters params) Can alse handle `ExtendedPKIXBuilderParameters` and `PKIXBuilderParameters`.

[Expand]

Inherited Methods

From class org.bouncycastle.x509.ExtendedPKIXParameters

void	addAddionalStore(Store store) This method is deprecated. No replacement.
void	addAdditionalStore(Store store) Adds an additional Bouncy Castle `Store` to find CRLs, certificates, attribute certificates or cross certificates.
void	addStore(Store store) Adds a Bouncy Castle `Store` to find CRLs, certificates, attribute certificates or cross certificates.
Object	clone()
List	getAdditionalStores() Returns an immutable `List` of additional Bouncy Castle `Store`s used for finding CRLs, certificates, attribute certificates or cross certificates.
Set	getAttrCertCheckers() Returns the attribute certificate checker.
static ExtendedPKIXParameters	getInstance(PKIXParameters pkixParams) Returns an instance with the parameters of a given `PKIXParameters` object.
Set	getNecessaryACAttributes() Returns the neccessary attributes which must be contained in an attribute certificate.
Set	getProhibitedACAttributes() Returns the attribute certificates which are not allowed.
List	getStores() Returns an immutable `List` of Bouncy Castle `Store`s used for finding CRLs, certificates, attribute certificates or cross certificates.
Selector	getTargetConstraints() Returns the required constraints on the target certificate or attribute certificate.
Set	getTrustedACIssuers() Returns the trusted attribute certificate issuers.
int	getValidityModel()
boolean	isAdditionalLocationsEnabled() Returns if additional `X509Store`s for locations like LDAP found in certificates or CRLs should be used.
boolean	isUseDeltasEnabled() Defaults to `false`.
void	setAdditionalLocationsEnabled(boolean enabled) Sets if additional `X509Store`s for locations like LDAP found in certificates or CRLs should be used.
void	setAttrCertCheckers(Set attrCertCheckers) Sets the attribute certificate checkers.
void	setCertStores(List stores) Sets the Java CertStore to this extended PKIX parameters.
void	setNecessaryACAttributes(Set necessaryACAttributes) Sets the neccessary which must be contained in an attribute certificate.
void	setParams(PKIXParameters params) Method to support `clone()` under J2ME.
void	setProhibitedACAttributes(Set prohibitedACAttributes) Sets the attribute certificates which are not allowed.
void	setStores(List stores) Sets the Bouncy Castle Stores for finding CRLs, certificates, attribute certificates or cross certificates.
void	setTargetCertConstraints(CertSelector selector) Sets the required constraints on the target certificate.
void	setTargetConstraints(Selector selector) Sets the required constraints on the target certificate or attribute certificate.
void	setTrustedACIssuers(Set trustedACIssuers) Sets the trusted attribute certificate issuers.
void	setUseDeltasEnabled(boolean useDeltas) Sets if delta CRLs should be used for checking the revocation status.
void	setValidityModel(int validityModel)

From class java.security.cert.PKIXParameters

void	addCertPathChecker(PKIXCertPathChecker arg0)
void	addCertStore(CertStore arg0)
Object	clone()
List<PKIXCertPathChecker>	getCertPathCheckers()
List<CertStore>	getCertStores()
Date	getDate()
Set<String>	getInitialPolicies()
boolean	getPolicyQualifiersRejected()
String	getSigProvider()
CertSelector	getTargetCertConstraints()
Set<TrustAnchor>	getTrustAnchors()
boolean	isAnyPolicyInhibited()
boolean	isExplicitPolicyRequired()
boolean	isPolicyMappingInhibited()
boolean	isRevocationEnabled()
void	setAnyPolicyInhibited(boolean arg0)
void	setCertPathCheckers(List<PKIXCertPathChecker> arg0)
void	setCertStores(List<CertStore> arg0)
void	setDate(Date arg0)
void	setExplicitPolicyRequired(boolean arg0)
void	setInitialPolicies(Set<String> arg0)
void	setPolicyMappingInhibited(boolean arg0)
void	setPolicyQualifiersRejected(boolean arg0)
void	setRevocationEnabled(boolean arg0)
void	setSigProvider(String arg0)
void	setTargetCertConstraints(CertSelector arg0)
void	setTrustAnchors(Set<TrustAnchor> arg0)
String	toString()

From class java.lang.Object

From interface java.security.cert.CertPathParameters

Public Constructors

public ExtendedPKIXBuilderParameters (Set trustAnchors, Selector targetConstraints)

Creates an instance of PKIXBuilderParameters with the specified Set of most-trusted CAs. Each element of the set is a TrustAnchor.

Note that the Set is copied to protect against subsequent modifications.

Parameters

trustAnchors	a `Set` of `TrustAnchor`s
targetConstraints	a `Selector` specifying the constraints on the target certificate or attribute certificate.

Throws

InvalidAlgorithmParameterException	if `trustAnchors` is empty.
NullPointerException	if `trustAnchors` is `null`
ClassCastException	if any of the elements of `trustAnchors` is not of type `java.security.cert.TrustAnchor`

Public Methods

public Object clone ()

Makes a copy of this PKIXParameters object. Changes to the copy will not affect the original and vice versa.

Returns

a copy of this PKIXParameters object

public Set getExcludedCerts ()

Excluded certificates are not used for building a certification path.

The returned set is immutable.

Returns

Returns the excluded certificates.

public static ExtendedPKIXParameters getInstance (PKIXParameters pkixParams)

Returns an instance of ExtendedPKIXParameters which can be safely casted to ExtendedPKIXBuilderParameters.

This method can be used to get a copy from other PKIXBuilderParameters, PKIXParameters, and ExtendedPKIXParameters instances.

Parameters

pkixParams	The PKIX parameters to create a copy of.

Returns

An ExtendedPKIXBuilderParameters instance.

public int getMaxPathLength ()

Returns the value of the maximum number of intermediate non-self-issued certificates in the certification path.

Returns

the maximum number of non-self-issued intermediate certificates in the certification path, or -1 if no limit exists.

public void setExcludedCerts (Set excludedCerts)

Sets the excluded certificates which are not used for building a certification path. If the Set is null an empty set is assumed.

The given set is cloned to protect it against subsequent modifications.

Parameters

excludedCerts	The excluded certificates to set.

public void setMaxPathLength (int maxPathLength)

Sets the maximum number of intermediate non-self-issued certificates in a certification path. The PKIX CertPathBuilder must not build paths longer then this length.

A value of 0 implies that the path can only contain a single certificate. A value of -1 does not limit the length. The default length is 5.

The basic constraints extension of a CA certificate overrides this value if smaller.

Parameters

maxPathLength	the maximum number of non-self-issued intermediate certificates in the certification path

Throws

InvalidParameterException	if `maxPathLength` is set to a value less than -1

Protected Methods

protected void setParams (PKIXParameters params)

Can alse handle ExtendedPKIXBuilderParameters and PKIXBuilderParameters.

Parameters

params	Parameters to set.

Interfaces

Classes

Exceptions

ExtendedPKIXBuilderParameters

Class Overview

See Also

Summary

Public Constructors

public ExtendedPKIXBuilderParameters (Set trustAnchors, Selector targetConstraints)

Parameters

Throws

Public Methods

public Object clone ()

Returns

public Set getExcludedCerts ()

Returns

public static ExtendedPKIXParameters getInstance (PKIXParameters pkixParams)

Parameters

Returns

public int getMaxPathLength ()

Returns

See Also

public void setExcludedCerts (Set excludedCerts)

Parameters

public void setMaxPathLength (int maxPathLength)

Parameters

Throws

See Also

Protected Methods

protected void setParams (PKIXParameters params)

Parameters

See Also