Top Description Inners Fields Constructors Methods
org.bouncycastle.jcajce

public Class PKIXExtendedBuilderParameters

extends Object
implements CertPathParameters
Class Inheritance
All Implemented Interfaces
java.security.cert.CertPathParameters, java.lang.Cloneable
Imports
java.security.InvalidParameterException, java.security.cert.CertPathParameters, .PKIXBuilderParameters, .X509Certificate, java.util.Collections, .HashSet, .Set
This class contains extended parameters for PKIX certification path builders.
See Also
PKIXBuilderParameters

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PKIXExtendedBuilderParameters.Builder

Builder for a PKIXExtendedBuilderParameters object.

Field Summary

Modifier and TypeField and Description
private final PKIXExtendedParameters
baseParameters

private final Set<X509Certificate>
excludedCerts

private final int
maxPathLength

Constructor Summary

AccessConstructor and Description
private
PKIXExtendedBuilderParameters(PKIXExtendedBuilderParameters.Builder builder)

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

this object
clone()

Overrides java.lang.Object.clone.

Implements java.security.cert.CertPathParameters.clone.

Makes a copy of this CertPathParameters.

public PKIXExtendedParameters
getBaseParameters()

public Set<E>

Returns:

Returns the excluded certificates.
getExcludedCerts()

Excluded certificates are not used for building a certification path.

public int

Returns:

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

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

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

baseParametersback to summary
private final PKIXExtendedParameters baseParameters
excludedCertsback to summary
private final Set<X509Certificate> excludedCerts
maxPathLengthback to summary
private final int maxPathLength

Constructor Detail

PKIXExtendedBuilderParametersback to summary
private PKIXExtendedBuilderParameters(PKIXExtendedBuilderParameters.Builder builder)

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Implements java.security.cert.CertPathParameters.clone.

Doc from java.security.cert.CertPathParameters.clone.

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

Returns:Object

this object

getBaseParametersback to summary
public PKIXExtendedParameters getBaseParameters()
getExcludedCertsback to summary
public Set<E> getExcludedCerts()

Excluded certificates are not used for building a certification path.

The returned set is immutable.

Returns:Set<E>

Returns the excluded certificates.

getMaxPathLengthback to summary
public int getMaxPathLength()

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

Returns:int

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

org.bouncycastle.jcajce back to summary

public Class PKIXExtendedBuilderParameters.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • org.bouncycastle.jcajce.PKIXExtendedBuilderParameters.Builder
Builder for a PKIXExtendedBuilderParameters object.

Field Summary

Modifier and TypeField and Description
private final PKIXExtendedParameters
baseParameters

private Set<X509Certificate>
excludedCerts

private int
maxPathLength

Constructor Summary

AccessConstructor and Description
public
Builder(PKIXBuilderParameters baseParameters)

public
Builder(PKIXExtendedParameters baseParameters)

Method Summary

Modifier and TypeMethod and Description
public PKIXExtendedBuilderParameters.Builder
addExcludedCerts(Set<X509Certificate>
The excluded certificates to set.
excludedCerts)

Adds excluded certificates which are not used for building a certification path.

public PKIXExtendedBuilderParameters
build()

public PKIXExtendedBuilderParameters.Builder
setMaxPathLength(int
the maximum number of non-self-issued intermediate certificates in the certification path
maxPathLength)

Sets the maximum number of intermediate non-self-issued certificates in a certification path.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

baseParametersback to summary
private final PKIXExtendedParameters baseParameters
excludedCertsback to summary
private Set<X509Certificate> excludedCerts
maxPathLengthback to summary
private int maxPathLength

Constructor Detail

Builderback to summary
public Builder(PKIXBuilderParameters baseParameters)
Builderback to summary
public Builder(PKIXExtendedParameters baseParameters)

Method Detail

addExcludedCertsback to summary
public PKIXExtendedBuilderParameters.Builder addExcludedCerts(Set<X509Certificate> excludedCerts)

Adds excluded certificates which are not used for building a certification path.

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

Parameters
excludedCerts:Set<X509Certificate>

The excluded certificates to set.

buildback to summary
public PKIXExtendedBuilderParameters build()
setMaxPathLengthback to summary
public PKIXExtendedBuilderParameters.Builder 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:int

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

Exceptions
InvalidParameterException:
if maxPathLength is set to a value less than -1
See Also
getMaxPathLength