java.security.cert

Class PKIXBuilderParameters

Implemented Interfaces:
CertPathParameters, Cloneable

public class PKIXBuilderParameters
extends PKIXParameters

Parameters for building certificate paths using the PKIX algorithm.
Since:
1.4
See Also:
CertPathBuilder

Constructor Summary

PKIXBuilderParameters(Set trustAnchors, CertSelector targetConstraints)
Create a new PKIXBuilderParameters object, populating the trusted certificates set with the elements of the given set, each of which must be a TrustAnchor.
PKIXBuilderParameters(KeyStore keystore, CertSelector targetConstraints)
Create a new PKIXBuilderParameters object, populating the trusted certificates set with all X.509 certificates found in the given key store.

Method Summary

int
getMaxPathLength()
Returns the maximum length of certificate paths to build.
void
setMaxPathLength(int maxPathLength)
Sets the maximum length of certificate paths to build.
String
toString()

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, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PKIXBuilderParameters

public PKIXBuilderParameters(Set trustAnchors,
                             CertSelector targetConstraints)
            throws InvalidAlgorithmParameterException
Create a new PKIXBuilderParameters object, populating the trusted certificates set with the elements of the given set, each of which must be a TrustAnchor.
Parameters:
trustAnchors - The set of trust anchors.
targetConstraints - The target certificate constraints.
Throws:
InvalidAlgorithmParameterException - If there are no certificates in the set.
NullPointerException - If trustAnchors is null.
ClassCastException - If every element in trustAnchors is not a TrustAnchor.

PKIXBuilderParameters

public PKIXBuilderParameters(KeyStore keystore,
                             CertSelector targetConstraints)
            throws KeyStoreException,
                   InvalidAlgorithmParameterException
Create a new PKIXBuilderParameters object, populating the trusted certificates set with all X.509 certificates found in the given key store. All certificates found in the key store are assumed to be trusted by this constructor.
Parameters:
keystore - The key store.
targetConstraints - The target certificate constraints.
Throws:
KeyStoreException - If the certificates cannot be retrieved from the key store.
InvalidAlgorithmParameterException - If there are no certificates in the key store.
NullPointerException - If keystore is null.

Method Details

getMaxPathLength

public int getMaxPathLength()
Returns the maximum length of certificate paths to build.

If this value is 0 it is taken to mean that the certificate path should contain only one certificate. A value of -1 means that the certificate path length is unconstrained. The default value is 5.

Returns:
The maximum path length.

setMaxPathLength

public void setMaxPathLength(int maxPathLength)
Sets the maximum length of certificate paths to build.
Parameters:
maxPathLength - The new path length.
Throws:
IllegalArgumentException - If maxPathLength is less than -1.

toString

public String toString()
Overrides:
toString in interface PKIXParameters

PKIXBuilderParameters.java -- parameters for PKIX cert path builders Copyright (C) 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.