Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.security.cert
Class PKIXParameters  view PKIXParameters download PKIXParameters.java

java.lang.Object
  extended byjava.security.cert.PKIXParameters
All Implemented Interfaces:
CertPathParameters, java.lang.Cloneable
Direct Known Subclasses:
PKIXBuilderParameters

public class PKIXParameters
extends java.lang.Object
implements CertPathParameters

Parameters for verifying certificate paths using the PKIX (Public-Key Infrastructure (X.509)) algorithm.


Field Summary
private  boolean anyPolicyInhibited
          The any policy inhibited flag.
private  java.util.List certStores
          The list of certificate stores.
private  java.util.Date date
          The target validation date.
private  boolean exPolicyRequired
          The explicit policy required flag.
private  java.util.Set initPolicies
          The set of initial policy identifiers.
private  java.util.List pathCheckers
          The list of path checkers.
private  boolean policyMappingInhibited
          The policy mapping inhibited flag.
private  boolean policyQualRejected
          The policy qualifiers rejected flag.
private  boolean revocationEnabled
          The revocation enabled flag.
private  java.lang.String sigProvider
          The signature algorithm provider.
private  CertSelector targetConstraints
          The target constraints.
private  java.util.Set trustAnchors
          The trusted certificates.
 
Constructor Summary
private PKIXParameters()
          Default constructor.
  PKIXParameters(java.security.KeyStore keystore)
          Create a new PKIXParameters object, populating the trusted certificates set with all certificates found in the given key store.
private PKIXParameters(PKIXParameters that)
          Copying constructor for cloning.
  PKIXParameters(java.util.Set trustAnchors)
          Create a new PKIXParameters object, populating the trusted certificates set with the elements of the given set, each of which must be a TrustAnchor.
 
Method Summary
 void addCertPathChecker(PKIXCertPathChecker checker)
          Add a certificate path checker.
 void addCertStore(CertStore store)
          Add a CertStore to the list of cert stores.
 java.lang.Object clone()
          Returns a copy of these parameters.
 java.util.List getCertPathCheckers()
          Returns an immutable list of all certificate path checkers.
 java.util.List getCertStores()
          Returns an immutable list of cert stores.
 java.util.Date getDate()
          Returns the date for which the certificate path should be validated, or null if the current time should be used.
 java.util.Set getInitialPolicies()
          Returns the set of initial policy identifiers (as OID strings).
 boolean getPolicyQualifiersRejected()
          Returns the value of the policy qualifiers enabled flag.
 java.lang.String getSigProvider()
          Returns the signature algorithm provider, or null if not set.
 CertSelector getTargetCertConstraints()
          Returns the constraints placed on the target certificate, or null if there are none.
 java.util.Set getTrustAnchors()
          Returns an immutable set of trust anchors.
 boolean isAnyPolicyInhibited()
          Returns the value of the any policy inhibited flag.
 boolean isExplicitPolicyRequired()
          Returns the value of the explicit policy required flag.
 boolean isPolicyMappingInhibited()
          Returns the value of the policy mapping inhibited flag.
 boolean isRevocationEnabled()
          Returns the value of the revocation enabled flag.
 void setAnyPolicyInhibited(boolean value)
          Sets the value of the any policy inhibited flag.
 void setCertPathCheckers(java.util.List pathCheckers)
          Sets the certificate path checkers.
 void setCertStores(java.util.List certStores)
          Set the cert stores.
 void setDate(java.util.Date date)
          Sets the date for which the certificate path should be validated, or null if the current time should be used.
 void setExplicitPolicyRequired(boolean value)
          Sets the value of the explicit policy required flag.
 void setInitialPolicies(java.util.Set initPolicies)
          Sets the initial policy identifiers (as OID strings).
 void setPolicyMappingInhibited(boolean value)
          Sets the value of the policy mapping inhibited flag.
 void setPolicyQualifiersRejected(boolean value)
          Sets the value of the policy qualifiers enabled flag.
 void setRevocationEnabled(boolean value)
          Sets the value of the revocation enabled flag.
 void setSigProvider(java.lang.String sigProvider)
          Sets the signature algorithm provider, or null if there is no preferred provider.
 void setTargetCertConstraints(CertSelector targetConstraints)
          Sets the constraints placed on the target certificate.
 void setTrustAnchors(java.util.Set trustAnchors)
          Sets the trust anchors of this class, replacing the current trust anchors with those in the given set.
 java.lang.String toString()
          Returns a printable representation of these parameters.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

trustAnchors

private final java.util.Set trustAnchors
The trusted certificates.


initPolicies

private final java.util.Set initPolicies
The set of initial policy identifiers.


certStores

private final java.util.List certStores
The list of certificate stores.


pathCheckers

private final java.util.List pathCheckers
The list of path checkers.


revocationEnabled

private boolean revocationEnabled
The revocation enabled flag.


exPolicyRequired

private boolean exPolicyRequired
The explicit policy required flag.


policyMappingInhibited

private boolean policyMappingInhibited
The policy mapping inhibited flag.


anyPolicyInhibited

private boolean anyPolicyInhibited
The any policy inhibited flag.


policyQualRejected

private boolean policyQualRejected
The policy qualifiers rejected flag.


date

private java.util.Date date
The target validation date.


sigProvider

private java.lang.String sigProvider
The signature algorithm provider.


targetConstraints

private CertSelector targetConstraints
The target constraints.

Constructor Detail

PKIXParameters

public PKIXParameters(java.security.KeyStore keystore)
               throws java.security.KeyStoreException,
                      java.security.InvalidAlgorithmParameterException
Create a new PKIXParameters object, populating the trusted certificates set with all certificates found in the given key store. All certificates found in the key store are assumed to be trusted by this constructor.


PKIXParameters

public PKIXParameters(java.util.Set trustAnchors)
               throws java.security.InvalidAlgorithmParameterException
Create a new PKIXParameters object, populating the trusted certificates set with the elements of the given set, each of which must be a TrustAnchor.


PKIXParameters

private PKIXParameters()
Default constructor.


PKIXParameters

private PKIXParameters(PKIXParameters that)
Copying constructor for cloning.

Method Detail

getTrustAnchors

public java.util.Set getTrustAnchors()
Returns an immutable set of trust anchors. The set returned will never be null and will never be empty.


setTrustAnchors

public void setTrustAnchors(java.util.Set trustAnchors)
                     throws java.security.InvalidAlgorithmParameterException
Sets the trust anchors of this class, replacing the current trust anchors with those in the given set. The supplied set is copied to prevent modification.


getInitialPolicies

public java.util.Set getInitialPolicies()
Returns the set of initial policy identifiers (as OID strings). If any policy is accepted, this method returns the empty set.


setInitialPolicies

public void setInitialPolicies(java.util.Set initPolicies)
Sets the initial policy identifiers (as OID strings). If the argument is null or the empty set, then any policy identifier will be accepted.


addCertStore

public void addCertStore(CertStore store)
Add a CertStore to the list of cert stores.


getCertStores

public java.util.List getCertStores()
Returns an immutable list of cert stores. This method never returns null.


setCertStores

public void setCertStores(java.util.List certStores)
Set the cert stores. If the argument is null the list of cert stores will be empty.


isRevocationEnabled

public boolean isRevocationEnabled()
Returns the value of the revocation enabled flag. The default value for this flag is true.


setRevocationEnabled

public void setRevocationEnabled(boolean value)
Sets the value of the revocation enabled flag.


isExplicitPolicyRequired

public boolean isExplicitPolicyRequired()
Returns the value of the explicit policy required flag. The default value of this flag is false.


setExplicitPolicyRequired

public void setExplicitPolicyRequired(boolean value)
Sets the value of the explicit policy required flag.


isPolicyMappingInhibited

public boolean isPolicyMappingInhibited()
Returns the value of the policy mapping inhibited flag. The default value of this flag is false.


setPolicyMappingInhibited

public void setPolicyMappingInhibited(boolean value)
Sets the value of the policy mapping inhibited flag.


isAnyPolicyInhibited

public boolean isAnyPolicyInhibited()
Returns the value of the any policy inhibited flag. The default value of this flag is false.


setAnyPolicyInhibited

public void setAnyPolicyInhibited(boolean value)
Sets the value of the any policy inhibited flag.


getPolicyQualifiersRejected

public boolean getPolicyQualifiersRejected()
Returns the value of the policy qualifiers enabled flag. The default value of this flag is true.


setPolicyQualifiersRejected

public void setPolicyQualifiersRejected(boolean value)
Sets the value of the policy qualifiers enabled flag.


getDate

public java.util.Date getDate()
Returns the date for which the certificate path should be validated, or null if the current time should be used. The date object is copied to prevent subsequent modification.


setDate

public void setDate(java.util.Date date)
Sets the date for which the certificate path should be validated, or null if the current time should be used.


addCertPathChecker

public void addCertPathChecker(PKIXCertPathChecker checker)
Add a certificate path checker.


getCertPathCheckers

public java.util.List getCertPathCheckers()
Returns an immutable list of all certificate path checkers.


setCertPathCheckers

public void setCertPathCheckers(java.util.List pathCheckers)
Sets the certificate path checkers. If the argument is null, the list of checkers will merely be cleared.


getSigProvider

public java.lang.String getSigProvider()
Returns the signature algorithm provider, or null if not set.


setSigProvider

public void setSigProvider(java.lang.String sigProvider)
Sets the signature algorithm provider, or null if there is no preferred provider.


getTargetCertConstraints

public CertSelector getTargetCertConstraints()
Returns the constraints placed on the target certificate, or null if there are none. The target constraints are copied to prevent subsequent modification.


setTargetCertConstraints

public void setTargetCertConstraints(CertSelector targetConstraints)
Sets the constraints placed on the target certificate.


clone

public java.lang.Object clone()
Returns a copy of these parameters.

Specified by:
clone in interface CertPathParameters

toString

public java.lang.String toString()
Returns a printable representation of these parameters.