OpenJDK 27 · java.security.cert.PKIXParameters · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	anyPolicyInhibited
private List<PKIXCertPathChecker>	certPathCheckers
private CertSelector	certSelector
private List<CertStore>	certStores
private Date	date
private boolean	explicitPolicyRequired
private boolean	policyMappingInhibited
private boolean	policyQualifiersRejected
private boolean	revocationEnabled
private String	sigProvider
private Set<String>	unmodInitialPolicies
private Set<TrustAnchor>	unmodTrustAnchors

Access	Constructor and Description
public	PKIXParameters(Set<TrustAnchor> a `Set` of `TrustAnchor`s trustAnchors) Creates an instance of `PKIXParameters` with the specified `Set` of most-trusted CAs.
public	PKIXParameters(KeyStore a `KeyStore` from which the set of most-trusted CAs will be populated keystore) Creates an instance of `PKIXParameters` that populates the set of most-trusted CAs from the trusted certificate entries contained in the specified `KeyStore`.

Method Summary

Modifier and Type	Method and Description
public void	addCertPathChecker(PKIXCertPathChecker a `PKIXCertPathChecker` to add to the list of checks. If `null`, the checker is ignored (not added to list). checker) Adds a `PKIXCertPathChecker` to the list of certification path checkers.
public void	addCertStore(CertStore the `CertStore` to add. If `null`, the store is ignored (not added to list). store) Adds a `CertStore` to the end of the list of `CertStore`s used in finding certificates and CRLs.
public Object	Returns: a copy of this `PKIXParameters` object clone() Overrides java.lang.Object.clone. Implements java.security.cert.CertPathParameters.clone. Makes a copy of this `PKIXParameters` object.
public List<PKIXCertPathChecker>	Returns: an immutable `List` of `PKIXCertPathChecker`s (may be empty, but not `null`) getCertPathCheckers() Returns the `List` of certification path checkers.
public List<CertStore>	Returns: an immutable `List` of `CertStore`s (may be empty, but never `null`) getCertStores() Returns an immutable `List` of `CertStore`s that are used to find certificates and CRLs.
public Date	Returns: the `Date`, or `null` if not set getDate() Returns the time for which the validity of the certification path should be determined.
public Set<String>	Returns: an immutable `Set` of initial policy OIDs in `String` format, or an empty `Set` (implying any policy is acceptable). Never returns `null`. getInitialPolicies() Returns an immutable `Set` of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing.
public boolean	Returns: the current value of the PolicyQualifiersRejected flag getPolicyQualifiersRejected() Gets the PolicyQualifiersRejected flag.
public String	Returns: the signature provider's name (or `null`) getSigProvider() Returns the signature provider's name, or `null` if not set.
public CertSelector	Returns: a `CertSelector` specifying the constraints on the target certificate (or `null`) getTargetCertConstraints() Returns the required constraints on the target certificate.
public Set<TrustAnchor>	Returns: an immutable `Set` of `TrustAnchor`s (never `null`) getTrustAnchors() Returns an immutable `Set` of the most-trusted CAs.
public boolean	Returns: `true` if the any policy OID is inhibited, `false` otherwise isAnyPolicyInhibited() Checks whether the any policy OID should be processed if it is included in a certificate.
public boolean	Returns: `true` if explicit policy is required, `false` otherwise isExplicitPolicyRequired() Checks if explicit policy is required.
public boolean	Returns: true if policy mapping is inhibited, false otherwise isPolicyMappingInhibited() Checks if policy mapping is inhibited.
public boolean	Returns: the current value of the RevocationEnabled flag isRevocationEnabled() Checks the RevocationEnabled flag.
public void	setAnyPolicyInhibited(boolean `true` if the any policy OID is to be inhibited, `false` otherwise val) Sets state to determine if the any policy OID should be processed if it is included in a certificate.
public void	setCertPathCheckers(List<PKIXCertPathChecker> a `List` of `PKIXCertPathChecker`s. May be `null`, in which case no additional checkers will be used. checkers) Sets a `List` of additional certification path checkers.
public void	setCertStores(List<CertStore> a `List` of `CertStore`s (or `null`) stores) Sets the list of `CertStore`s to be used in finding certificates and CRLs.
public void	setDate(Date the `Date`, or `null` for the current time date) Sets the time for which the validity of the certification path should be determined.
public void	setExplicitPolicyRequired(boolean `true` if explicit policy is to be required, `false` otherwise val) Sets the ExplicitPolicyRequired flag.
public void	setInitialPolicies(Set<String> a `Set` of initial policy OIDs in `String` format (or `null`) initialPolicies) Sets the `Set` of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing.
public void	setPolicyMappingInhibited(boolean `true` if policy mapping is to be inhibited, `false` otherwise val) Sets the PolicyMappingInhibited flag.
public void	setPolicyQualifiersRejected(boolean the new value of the PolicyQualifiersRejected flag qualifiersRejected) Sets the PolicyQualifiersRejected flag.
public void	setRevocationEnabled(boolean the new value of the RevocationEnabled flag val) Sets the RevocationEnabled flag.
public void	setSigProvider(String the signature provider's name (or `null`) sigProvider) Sets the signature provider's name.
public void	setTargetCertConstraints(CertSelector a `CertSelector` specifying the constraints on the target certificate (or `null`) selector) Sets the required constraints on the target certificate.
public void	setTrustAnchors(Set<TrustAnchor> a `Set` of `TrustAnchor`s trustAnchors) Sets the `Set` of most-trusted CAs.
public String	Returns: a formatted string describing the parameters. toString() Overrides java.lang.Object.toString. Returns a formatted string describing the parameters.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

anyPolicyInhibited	back to summary
private boolean anyPolicyInhibited

certPathCheckers	back to summary
private List<PKIXCertPathChecker> certPathCheckers

certSelector	back to summary
private CertSelector certSelector

certStores	back to summary
private List<CertStore> certStores

date	back to summary
private Date date

explicitPolicyRequired	back to summary
private boolean explicitPolicyRequired

policyMappingInhibited	back to summary
private boolean policyMappingInhibited

policyQualifiersRejected	back to summary
private boolean policyQualifiersRejected

revocationEnabled	back to summary
private boolean revocationEnabled

sigProvider	back to summary
private String sigProvider

unmodInitialPolicies	back to summary
private Set<String> unmodInitialPolicies

unmodTrustAnchors	back to summary
private Set<TrustAnchor> unmodTrustAnchors

PKIXParameters	back to summary
public PKIXParameters(Set<TrustAnchor> trustAnchors) throws InvalidAlgorithmParameterException Creates an instance of `PKIXParameters` 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:Set<TrustAnchor> a `Set` of `TrustAnchor`s Annotations @SuppressWarnings:this-escape Exceptions InvalidAlgorithmParameterException: if the specified `Set` is empty `(trustAnchors.isEmpty() == true)` NullPointerException: if the specified `Set` is `null` ClassCastException: if any of the elements in the `Set` are not of type `java.security.cert.TrustAnchor`

PKIXParameters	back to summary
public PKIXParameters(KeyStore keystore) throws KeyStoreException, InvalidAlgorithmParameterException Creates an instance of `PKIXParameters` that populates the set of most-trusted CAs from the trusted certificate entries contained in the specified `KeyStore`. Only keystore entries that contain trusted `X509Certificates` are considered; all other certificate types are ignored. Parameters keystore:KeyStore a `KeyStore` from which the set of most-trusted CAs will be populated Annotations @SuppressWarnings:this-escape Exceptions KeyStoreException: if the keystore has not been initialized InvalidAlgorithmParameterException: if the keystore does not contain at least one trusted certificate entry NullPointerException: if the keystore is `null`

Method Detail

addCertPathChecker back to summary

addCertPathChecker	back to summary
public void addCertPathChecker(PKIXCertPathChecker checker) Adds a `PKIXCertPathChecker` to the list of certification path checkers. See the `setCertPathCheckers` method for more details. Note that the `PKIXCertPathChecker` is cloned to protect against subsequent modifications. Parameters checker:PKIXCertPathChecker a `PKIXCertPathChecker` to add to the list of checks. If `null`, the checker is ignored (not added to list).

public void addCertPathChecker(PKIXCertPathChecker checker)

Adds a PKIXCertPathChecker to the list of certification path checkers. See the setCertPathCheckers method for more details.

Note that the PKIXCertPathChecker is cloned to protect against subsequent modifications.

Parameters

checker:PKIXCertPathChecker: a PKIXCertPathChecker to add to the list of checks. If null, the checker is ignored (not added to list).

addCertStore back to summary

addCertStore	back to summary
public void addCertStore(CertStore store) Adds a `CertStore` to the end of the list of `CertStore`s used in finding certificates and CRLs. Parameters store:CertStore the `CertStore` to add. If `null`, the store is ignored (not added to list).

public void addCertStore(CertStore store)

Adds a CertStore to the end of the list of CertStores used in finding certificates and CRLs.

Parameters

store:CertStore: the CertStore to add. If null, the store is ignored (not added to list).

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Implements java.security.cert.CertPathParameters.clone. Makes a copy of this `PKIXParameters` object. Changes to the copy will not affect the original and vice versa. Returns:Object a copy of this `PKIXParameters` object

public Object clone()

Overrides java.lang.Object.clone.

Implements java.security.cert.CertPathParameters.clone.

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

Returns:Object: a copy of this PKIXParameters object

getCertPathCheckers back to summary

getCertPathCheckers	back to summary
public List<PKIXCertPathChecker> getCertPathCheckers() Returns the `List` of certification path checkers. The returned `List` is immutable, and each `PKIXCertPathChecker` in the `List` is cloned to protect against subsequent modifications. Returns:List<PKIXCertPathChecker> an immutable `List` of `PKIXCertPathChecker`s (may be empty, but not `null`) See Also `setCertPathCheckers`

public List<PKIXCertPathChecker> getCertPathCheckers()

Returns the List of certification path checkers. The returned List is immutable, and each PKIXCertPathChecker in the List is cloned to protect against subsequent modifications.

Returns:List<PKIXCertPathChecker>: an immutable List of PKIXCertPathCheckers (may be empty, but not null)
See Also: setCertPathCheckers

getCertStores back to summary

getCertStores	back to summary
public List<CertStore> getCertStores() Returns an immutable `List` of `CertStore`s that are used to find certificates and CRLs. Returns:List<CertStore> an immutable `List` of `CertStore`s (may be empty, but never `null`) See Also `setCertStores`

public List<CertStore> getCertStores()

Returns an immutable List of CertStores that are used to find certificates and CRLs.

Returns:List<CertStore>: an immutable List of CertStores (may be empty, but never null)
See Also: setCertStores

getDate back to summary

getDate	back to summary
public Date getDate() Returns the time for which the validity of the certification path should be determined. If `null`, the current time is used. Note that the `Date` returned is copied to protect against subsequent modifications. Returns:Date the `Date`, or `null` if not set See Also `setDate`

public Date getDate()

Returns the time for which the validity of the certification path should be determined. If null, the current time is used.

Note that the Date returned is copied to protect against subsequent modifications.

Returns:Date: the Date, or null if not set
See Also: setDate

getInitialPolicies back to summary

getInitialPolicies	back to summary
public Set<String> getInitialPolicies() Returns an immutable `Set` of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing. The default return value is an empty `Set`, which is interpreted as meaning that any policy would be acceptable. Returns:Set<String> an immutable `Set` of initial policy OIDs in `String` format, or an empty `Set` (implying any policy is acceptable). Never returns `null`. See Also `setInitialPolicies`

public Set<String> getInitialPolicies()

Returns an immutable Set of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing. The default return value is an empty Set, which is interpreted as meaning that any policy would be acceptable.

Returns:Set<String>: an immutable Set of initial policy OIDs in String format, or an empty Set (implying any policy is acceptable). Never returns null.
See Also: setInitialPolicies

getPolicyQualifiersRejected back to summary

getPolicyQualifiersRejected	back to summary
public boolean getPolicyQualifiersRejected() Gets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis. When a `PKIXParameters` object is created, this flag is set to true. This setting reflects the most common (and simplest) strategy for processing policy qualifiers. Applications that want to use a more sophisticated policy must set this flag to false. Returns:boolean the current value of the PolicyQualifiersRejected flag See Also `setPolicyQualifiersRejected`

public boolean getPolicyQualifiersRejected()

Gets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis.

When a PKIXParameters object is created, this flag is set to true. This setting reflects the most common (and simplest) strategy for processing policy qualifiers. Applications that want to use a more sophisticated policy must set this flag to false.

Returns:boolean: the current value of the PolicyQualifiersRejected flag
See Also: setPolicyQualifiersRejected

getSigProvider back to summary

getSigProvider	back to summary
public String getSigProvider() Returns the signature provider's name, or `null` if not set. Returns:String the signature provider's name (or `null`) See Also `setSigProvider`

public String getSigProvider()

Returns the signature provider's name, or null if not set.

Returns:String: the signature provider's name (or null)
See Also: setSigProvider

getTargetCertConstraints back to summary

getTargetCertConstraints	back to summary
public CertSelector getTargetCertConstraints() Returns the required constraints on the target certificate. The constraints are returned as an instance of `CertSelector`. If `null`, no constraints are defined. Note that the `CertSelector` returned is cloned to protect against subsequent modifications. Returns:CertSelector a `CertSelector` specifying the constraints on the target certificate (or `null`) See Also `setTargetCertConstraints`

public CertSelector getTargetCertConstraints()

Returns the required constraints on the target certificate. The constraints are returned as an instance of CertSelector. If null, no constraints are defined.

Note that the CertSelector returned is cloned to protect against subsequent modifications.

Returns:CertSelector: a CertSelector specifying the constraints on the target certificate (or null)
See Also: setTargetCertConstraints

getTrustAnchors back to summary

getTrustAnchors	back to summary
public Set<TrustAnchor> getTrustAnchors() Returns an immutable `Set` of the most-trusted CAs. Returns:Set<TrustAnchor> an immutable `Set` of `TrustAnchor`s (never `null`) See Also `setTrustAnchors`

public Set<TrustAnchor> getTrustAnchors()

Returns an immutable Set of the most-trusted CAs.

Returns:Set<TrustAnchor>: an immutable Set of TrustAnchors (never null)
See Also: setTrustAnchors

isAnyPolicyInhibited back to summary

isAnyPolicyInhibited	back to summary
public boolean isAnyPolicyInhibited() Checks whether the any policy OID should be processed if it is included in a certificate. Returns:boolean `true` if the any policy OID is inhibited, `false` otherwise

public boolean isAnyPolicyInhibited()

Checks whether the any policy OID should be processed if it is included in a certificate.

Returns:boolean: true if the any policy OID is inhibited, false otherwise

isExplicitPolicyRequired back to summary

isExplicitPolicyRequired	back to summary
public boolean isExplicitPolicyRequired() Checks if explicit policy is required. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false. Returns:boolean `true` if explicit policy is required, `false` otherwise

public boolean isExplicitPolicyRequired()

Checks if explicit policy is required. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false.

Returns:boolean: true if explicit policy is required, false otherwise

isPolicyMappingInhibited	back to summary
public boolean isPolicyMappingInhibited() Checks if policy mapping is inhibited. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false). Returns:boolean true if policy mapping is inhibited, false otherwise

isPolicyMappingInhibited

back to summary

public boolean isPolicyMappingInhibited()

Checks if policy mapping is inhibited. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false).

Returns:boolean: true if policy mapping is inhibited, false otherwise

isRevocationEnabled back to summary

isRevocationEnabled	back to summary
public boolean isRevocationEnabled() Checks the RevocationEnabled flag. If this flag is true, the default revocation checking mechanism of the underlying PKIX service provider will be used, unless a `PKIXRevocationChecker` is passed in as a `CertPathChecker`. If this flag is false, the default revocation checking mechanism will be disabled (not used). See the `setRevocationEnabled` method for more details on setting the value of this flag. Returns:boolean the current value of the RevocationEnabled flag

public boolean isRevocationEnabled()

Checks the RevocationEnabled flag. If this flag is true, the default revocation checking mechanism of the underlying PKIX service provider will be used, unless a PKIXRevocationChecker is passed in as a CertPathChecker. If this flag is false, the default revocation checking mechanism will be disabled (not used). See the setRevocationEnabled method for more details on setting the value of this flag.

Returns:boolean: the current value of the RevocationEnabled flag

setAnyPolicyInhibited back to summary

setAnyPolicyInhibited	back to summary
public void setAnyPolicyInhibited(boolean val) Sets state to determine if the any policy OID should be processed if it is included in a certificate. By default, the any policy OID is not inhibited (`isAnyPolicyInhibited()` returns `false`). Parameters val:boolean `true` if the any policy OID is to be inhibited, `false` otherwise

public void setAnyPolicyInhibited(boolean val)

Sets state to determine if the any policy OID should be processed if it is included in a certificate. By default, the any policy OID is not inhibited (isAnyPolicyInhibited() returns false).

Parameters

val:boolean: true if the any policy OID is to be inhibited, false otherwise

setCertPathCheckers back to summary

setCertPathCheckers	back to summary
public void setCertPathCheckers(List<PKIXCertPathChecker> checkers) Sets a `List` of additional certification path checkers. If the specified `List` contains an object that is not a `PKIXCertPathChecker`, it is ignored. Each `PKIXCertPathChecker` specified implements additional checks on a certificate. Typically, these are checks to process and verify private extensions contained in certificates. Each `PKIXCertPathChecker` should be instantiated with any initialization parameters needed to execute the check. This method allows sophisticated applications to extend a PKIX `CertPathValidator` or `CertPathBuilder`. Each of the specified `PKIXCertPathChecker`s will be called, in turn, by a PKIX `CertPathValidator` or `CertPathBuilder` for each certificate processed or validated. Regardless of whether these additional `PKIXCertPathChecker`s are set, a PKIX `CertPathValidator` or `CertPathBuilder` must perform all of the required PKIX checks on each certificate. The one exception to this rule is if the RevocationEnabled flag is set to false (see the `setRevocationEnabled` method). Note that the `List` supplied here is copied and each `PKIXCertPathChecker` in the list is cloned to protect against subsequent modifications. Parameters checkers:List<PKIXCertPathChecker> a `List` of `PKIXCertPathChecker`s. May be `null`, in which case no additional checkers will be used. Exceptions ClassCastException: if any of the elements in the list are not of type `java.security.cert.PKIXCertPathChecker` See Also `getCertPathCheckers`

public void setCertPathCheckers(List<PKIXCertPathChecker> checkers)

Sets a List of additional certification path checkers. If the specified List contains an object that is not a PKIXCertPathChecker, it is ignored.

Each PKIXCertPathChecker specified implements additional checks on a certificate. Typically, these are checks to process and verify private extensions contained in certificates. Each PKIXCertPathChecker should be instantiated with any initialization parameters needed to execute the check.

This method allows sophisticated applications to extend a PKIX CertPathValidator or CertPathBuilder. Each of the specified PKIXCertPathCheckers will be called, in turn, by a PKIX CertPathValidator or CertPathBuilder for each certificate processed or validated.

Regardless of whether these additional PKIXCertPathCheckers are set, a PKIX CertPathValidator or CertPathBuilder must perform all of the required PKIX checks on each certificate. The one exception to this rule is if the RevocationEnabled flag is set to false (see the setRevocationEnabled method).

Note that the List supplied here is copied and each PKIXCertPathChecker in the list is cloned to protect against subsequent modifications.

Parameters

checkers:List<PKIXCertPathChecker>: a List of PKIXCertPathCheckers. May be null, in which case no additional checkers will be used.

Exceptions

ClassCastException:: if any of the elements in the list are not of type java.security.cert.PKIXCertPathChecker

See Also

getCertPathCheckers

setCertStores back to summary

setCertStores	back to summary
public void setCertStores(List<CertStore> stores) Sets the list of `CertStore`s to be used in finding certificates and CRLs. May be `null`, in which case no `CertStore`s will be used. The first `CertStore`s in the list may be preferred to those that appear later. Note that the `List` is copied to protect against subsequent modifications. Parameters stores:List<CertStore> a `List` of `CertStore`s (or `null`) Exceptions ClassCastException: if any of the elements in the list are not of type `java.security.cert.CertStore` See Also `getCertStores`

public void setCertStores(List<CertStore> stores)

Sets the list of CertStores to be used in finding certificates and CRLs. May be null, in which case no CertStores will be used. The first CertStores in the list may be preferred to those that appear later.

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

Parameters

stores:List<CertStore>: a List of CertStores (or null)

Exceptions

ClassCastException:: if any of the elements in the list are not of type java.security.cert.CertStore

See Also

getCertStores

setDate back to summary

setDate	back to summary
public void setDate(Date date) Sets the time for which the validity of the certification path should be determined. If `null`, the current time is used. Note that the `Date` supplied here is copied to protect against subsequent modifications. Parameters date:Date the `Date`, or `null` for the current time See Also `getDate`

public void setDate(Date date)

Sets the time for which the validity of the certification path should be determined. If null, the current time is used.

Note that the Date supplied here is copied to protect against subsequent modifications.

Parameters

date:Date: the Date, or null for the current time

See Also

getDate

setExplicitPolicyRequired back to summary

setExplicitPolicyRequired	back to summary
public void setExplicitPolicyRequired(boolean val) Sets the ExplicitPolicyRequired flag. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false. Parameters val:boolean `true` if explicit policy is to be required, `false` otherwise

public void setExplicitPolicyRequired(boolean val)

Sets the ExplicitPolicyRequired flag. If this flag is true, an acceptable policy needs to be explicitly identified in every certificate. By default, the ExplicitPolicyRequired flag is false.

Parameters

val:boolean: true if explicit policy is to be required, false otherwise

setInitialPolicies back to summary

setInitialPolicies	back to summary
public void setInitialPolicies(Set<String> initialPolicies) Sets the `Set` of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing. By default, any policy is acceptable (i.e. all policies), so a user that wants to allow any policy as acceptable does not need to call this method, or can call it with an empty `Set` (or `null`). Note that the `Set` is copied to protect against subsequent modifications. Parameters initialPolicies:Set<String> a `Set` of initial policy OIDs in `String` format (or `null`) Exceptions ClassCastException: if any of the elements in the set are not of type `String` See Also `getInitialPolicies`

public void setInitialPolicies(Set<String> initialPolicies)

Sets the Set of initial policy identifiers (OID strings), indicating that any one of these policies would be acceptable to the certificate user for the purposes of certification path processing. By default, any policy is acceptable (i.e. all policies), so a user that wants to allow any policy as acceptable does not need to call this method, or can call it with an empty Set (or null).

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

Parameters

initialPolicies:Set<String>: a Set of initial policy OIDs in String format (or null)

Exceptions

ClassCastException:: if any of the elements in the set are not of type String

See Also

getInitialPolicies

setPolicyMappingInhibited back to summary

setPolicyMappingInhibited	back to summary
public void setPolicyMappingInhibited(boolean val) Sets the PolicyMappingInhibited flag. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false). Parameters val:boolean `true` if policy mapping is to be inhibited, `false` otherwise

public void setPolicyMappingInhibited(boolean val)

Sets the PolicyMappingInhibited flag. If this flag is true, policy mapping is inhibited. By default, policy mapping is not inhibited (the flag is false).

Parameters

val:boolean: true if policy mapping is to be inhibited, false otherwise

setPolicyQualifiersRejected back to summary

setPolicyQualifiersRejected	back to summary
public void setPolicyQualifiersRejected(boolean qualifiersRejected) Sets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis. When a `PKIXParameters` object is created, this flag is set to true. This setting reflects the most common (and simplest) strategy for processing policy qualifiers. Applications that want to use a more sophisticated policy must set this flag to false. Note that the PKIX certification path validation algorithm specifies that any policy qualifier in a certificate policies extension that is marked critical must be processed and validated. Otherwise the certification path must be rejected. If the policyQualifiersRejected flag is set to false, it is up to the application to validate all policy qualifiers in this manner in order to be PKIX compliant. Parameters qualifiersRejected:boolean the new value of the PolicyQualifiersRejected flag See Also `getPolicyQualifiersRejected`, `PolicyQualifierInfo`

public void setPolicyQualifiersRejected(boolean qualifiersRejected)

Sets the PolicyQualifiersRejected flag. If this flag is true, certificates that include policy qualifiers in a certificate policies extension that is marked critical are rejected. If the flag is false, certificates are not rejected on this basis.

Note that the PKIX certification path validation algorithm specifies that any policy qualifier in a certificate policies extension that is marked critical must be processed and validated. Otherwise the certification path must be rejected. If the policyQualifiersRejected flag is set to false, it is up to the application to validate all policy qualifiers in this manner in order to be PKIX compliant.

Parameters

qualifiersRejected:boolean: the new value of the PolicyQualifiersRejected flag

setRevocationEnabled back to summary

setRevocationEnabled	back to summary
public void setRevocationEnabled(boolean val) Sets the RevocationEnabled flag. If this flag is true, the default revocation checking mechanism of the underlying PKIX service provider will be used, unless a `PKIXRevocationChecker` is passed in as a `CertPathChecker` (see below for further explanation). If this flag is false, the default revocation checking mechanism will be disabled (not used). When a `PKIXParameters` object is created, this flag is set to true. This setting reflects the most common strategy for checking revocation, since each service provider must support revocation checking to be PKIX compliant. Sophisticated applications should set this flag to false when it is not practical to use a PKIX service provider's default revocation checking mechanism or when an alternative revocation checking mechanism is to be substituted (by also calling the `addCertPathChecker` or `setCertPathCheckers` methods). Note that when a `PKIXRevocationChecker` is passed in as a parameter via the `addCertPathChecker` or `setCertPathCheckers` methods, it will be used to check revocation irrespective of the setting of the RevocationEnabled flag. Parameters val:boolean the new value of the RevocationEnabled flag

public void setRevocationEnabled(boolean val)

Sets the RevocationEnabled flag. If this flag is true, the default revocation checking mechanism of the underlying PKIX service provider will be used, unless a PKIXRevocationChecker is passed in as a CertPathChecker (see below for further explanation). If this flag is false, the default revocation checking mechanism will be disabled (not used).

When a PKIXParameters object is created, this flag is set to true. This setting reflects the most common strategy for checking revocation, since each service provider must support revocation checking to be PKIX compliant. Sophisticated applications should set this flag to false when it is not practical to use a PKIX service provider's default revocation checking mechanism or when an alternative revocation checking mechanism is to be substituted (by also calling the addCertPathChecker or setCertPathCheckers methods).

Note that when a PKIXRevocationChecker is passed in as a parameter via the addCertPathChecker or setCertPathCheckers methods, it will be used to check revocation irrespective of the setting of the RevocationEnabled flag.

Parameters

val:boolean: the new value of the RevocationEnabled flag

setSigProvider back to summary

setSigProvider	back to summary
public void setSigProvider(String sigProvider) Sets the signature provider's name. The specified provider will be preferred when creating `Signature` objects. If `null` or not set, the first provider found supporting the algorithm will be used. Parameters sigProvider:String the signature provider's name (or `null`) See Also `getSigProvider`

public void setSigProvider(String sigProvider)

Sets the signature provider's name. The specified provider will be preferred when creating Signature objects. If null or not set, the first provider found supporting the algorithm will be used.

Parameters

sigProvider:String: the signature provider's name (or null)

See Also

getSigProvider

setTargetCertConstraints back to summary

setTargetCertConstraints	back to summary
public void setTargetCertConstraints(CertSelector selector) Sets the required constraints on the target certificate. The constraints are specified as an instance of `CertSelector`. If `null`, no constraints are defined. Note that the `CertSelector` specified is cloned to protect against subsequent modifications. Parameters selector:CertSelector a `CertSelector` specifying the constraints on the target certificate (or `null`) See Also `getTargetCertConstraints`

public void setTargetCertConstraints(CertSelector selector)

Sets the required constraints on the target certificate. The constraints are specified as an instance of CertSelector. If null, no constraints are defined.

Note that the CertSelector specified is cloned to protect against subsequent modifications.

Parameters

selector:CertSelector: a CertSelector specifying the constraints on the target certificate (or null)

See Also

getTargetCertConstraints

setTrustAnchors back to summary

setTrustAnchors	back to summary
public void setTrustAnchors(Set<TrustAnchor> trustAnchors) throws InvalidAlgorithmParameterException Sets the `Set` of most-trusted CAs. Note that the `Set` is copied to protect against subsequent modifications. Parameters trustAnchors:Set<TrustAnchor> a `Set` of `TrustAnchor`s Exceptions InvalidAlgorithmParameterException: if the specified `Set` is empty `(trustAnchors.isEmpty() == true)` NullPointerException: if the specified `Set` is `null` ClassCastException: if any of the elements in the set are not of type `java.security.cert.TrustAnchor` See Also `getTrustAnchors`

public void setTrustAnchors(Set<TrustAnchor> trustAnchors) throws InvalidAlgorithmParameterException

Sets the Set of most-trusted CAs.

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

Parameters

trustAnchors:Set<TrustAnchor>: a Set of TrustAnchors

Exceptions

InvalidAlgorithmParameterException:: if the specified Set is empty (trustAnchors.isEmpty() == true)
NullPointerException:: if the specified Set is null
ClassCastException:: if any of the elements in the set are not of type java.security.cert.TrustAnchor

See Also

getTrustAnchors

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a formatted string describing the parameters. Returns:String a formatted string describing the parameters.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a formatted string describing the parameters.

Returns:String: a formatted string describing the parameters.

public Class PKIXParameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail