jdk-sandbox: comparison jdk/src/share/classes/java/security/cert/CertStore.java

equal deleted inserted replaced

-:6d0f51c99930
+:882a3948c6e6
 /*
-* Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
+* Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 import sun.security.jca.*;
 import sun.security.jca.GetInstance.Instance;
 /**
-* A class for retrieving <code>Certificate</code>s and <code>CRL</code>s
+* A class for retrieving {@code Certificate}s and {@code CRL}s
 * from a repository.
 * <p>
 * This class uses a provider-based architecture.
-* To create a <code>CertStore</code>, call one of the static
+* To create a {@code CertStore}, call one of the static
-* <code>getInstance</code> methods, passing in the type of
+* {@code getInstance} methods, passing in the type of
-* <code>CertStore</code> desired, any applicable initialization parameters
+* {@code CertStore} desired, any applicable initialization parameters
 * and optionally the name of the provider desired.
 * <p>
-* Once the <code>CertStore</code> has been created, it can be used to
+* Once the {@code CertStore} has been created, it can be used to
-* retrieve <code>Certificate</code>s and <code>CRL</code>s by calling its
+* retrieve {@code Certificate}s and {@code CRL}s by calling its
 * {@link #getCertificates(CertSelector selector) getCertificates} and
 * {@link #getCRLs(CRLSelector selector) getCRLs} methods.
 * <p>
 * Unlike a {@link java.security.KeyStore KeyStore}, which provides access
 * to a cache of private keys and trusted certificates, a
-* <code>CertStore</code> is designed to provide access to a potentially
+* {@code CertStore} is designed to provide access to a potentially
 * vast repository of untrusted certificates and CRLs. For example, an LDAP
-* implementation of <code>CertStore</code> provides access to certificates
+* implementation of {@code CertStore} provides access to certificates
 * and CRLs stored in one or more directories using the LDAP protocol and the
 * schema as defined in the RFC service attribute.
 *
 * <p> Every implementation of the Java platform is required to support the
-* following standard <code>CertStore</code> type:
+* following standard {@code CertStore} type:
 * <ul>
-* <li><tt>Collection</tt></li>
+* <li>{@code Collection}</li>
 * </ul>
 * This type is described in the <a href=
 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertStore">
 * CertStore section</a> of the
 * Java Cryptography Architecture Standard Algorithm Name Documentation.
 * other types are supported.
 *
 * <p>
 * <b>Concurrent Access</b>
 * <p>
-* All public methods of <code>CertStore</code> objects must be thread-safe.
+* All public methods of {@code CertStore} objects must be thread-safe.
 * That is, multiple threads may concurrently invoke these methods on a
-* single <code>CertStore</code> object (or more than one) with no
+* single {@code CertStore} object (or more than one) with no
-* ill effects. This allows a <code>CertPathBuilder</code> to search for a
+* ill effects. This allows a {@code CertPathBuilder} to search for a
 * CRL while simultaneously searching for further certificates, for instance.
 * <p>
 * The static methods of this class are also guaranteed to be thread-safe.
 * Multiple threads may concurrently invoke the static methods defined in
 * this class with no ill effects.
 private Provider provider;
 private String type;
 private CertStoreParameters params;
 /**
-* Creates a <code>CertStore</code> object of the given type, and
+* Creates a {@code CertStore} object of the given type, and
 * encapsulates the given provider implementation (SPI object) in it.
 *
 * @param storeSpi the provider implementation
 * @param provider the provider
 * @param type the type
-* @param params the initialization parameters (may be <code>null</code>)
+* @param params the initialization parameters (may be {@code null})
 */
 protected CertStore(CertStoreSpi storeSpi, Provider provider,
 String type, CertStoreParameters params) {
 this.storeSpi = storeSpi;
 this.provider = provider;
 if (params != null)
 this.params = (CertStoreParameters) params.clone();
 }
 /**
-* Returns a <code>Collection</code> of <code>Certificate</code>s that
+* Returns a {@code Collection} of {@code Certificate}s that
-* match the specified selector. If no <code>Certificate</code>s
+* match the specified selector. If no {@code Certificate}s
-* match the selector, an empty <code>Collection</code> will be returned.
+* match the selector, an empty {@code Collection} will be returned.
 * <p>
-* For some <code>CertStore</code> types, the resulting
+* For some {@code CertStore} types, the resulting
-* <code>Collection</code> may not contain <b>all</b> of the
+* {@code Collection} may not contain <b>all</b> of the
-* <code>Certificate</code>s that match the selector. For instance,
+* {@code Certificate}s that match the selector. For instance,
-* an LDAP <code>CertStore</code> may not search all entries in the
+* an LDAP {@code CertStore} may not search all entries in the
 * directory. Instead, it may just search entries that are likely to
-* contain the <code>Certificate</code>s it is looking for.
+* contain the {@code Certificate}s it is looking for.
 * <p>
-* Some <code>CertStore</code> implementations (especially LDAP
+* Some {@code CertStore} implementations (especially LDAP
-* <code>CertStore</code>s) may throw a <code>CertStoreException</code>
+* {@code CertStore}s) may throw a {@code CertStoreException}
-* unless a non-null <code>CertSelector</code> is provided that
+* unless a non-null {@code CertSelector} is provided that
 * includes specific criteria that can be used to find the certificates.
 * Issuer and/or subject names are especially useful criteria.
 *
-* @param selector A <code>CertSelector</code> used to select which
+* @param selector A {@code CertSelector} used to select which
-*  <code>Certificate</code>s should be returned. Specify <code>null</code>
+*  {@code Certificate}s should be returned. Specify {@code null}
-*  to return all <code>Certificate</code>s (if supported).
+*  to return all {@code Certificate}s (if supported).
-* @return A <code>Collection</code> of <code>Certificate</code>s that
+* @return A {@code Collection} of {@code Certificate}s that
-*         match the specified selector (never <code>null</code>)
+*         match the specified selector (never {@code null})
 * @throws CertStoreException if an exception occurs
 */
 public final Collection<? extends Certificate> getCertificates
 (CertSelector selector) throws CertStoreException {
 return storeSpi.engineGetCertificates(selector);
 }
 /**
-* Returns a <code>Collection</code> of <code>CRL</code>s that
+* Returns a {@code Collection} of {@code CRL}s that
-* match the specified selector. If no <code>CRL</code>s
+* match the specified selector. If no {@code CRL}s
-* match the selector, an empty <code>Collection</code> will be returned.
+* match the selector, an empty {@code Collection} will be returned.
 * <p>
-* For some <code>CertStore</code> types, the resulting
+* For some {@code CertStore} types, the resulting
-* <code>Collection</code> may not contain <b>all</b> of the
+* {@code Collection} may not contain <b>all</b> of the
-* <code>CRL</code>s that match the selector. For instance,
+* {@code CRL}s that match the selector. For instance,
-* an LDAP <code>CertStore</code> may not search all entries in the
+* an LDAP {@code CertStore} may not search all entries in the
 * directory. Instead, it may just search entries that are likely to
-* contain the <code>CRL</code>s it is looking for.
+* contain the {@code CRL}s it is looking for.
 * <p>
-* Some <code>CertStore</code> implementations (especially LDAP
+* Some {@code CertStore} implementations (especially LDAP
-* <code>CertStore</code>s) may throw a <code>CertStoreException</code>
+* {@code CertStore}s) may throw a {@code CertStoreException}
-* unless a non-null <code>CRLSelector</code> is provided that
+* unless a non-null {@code CRLSelector} is provided that
 * includes specific criteria that can be used to find the CRLs.
 * Issuer names and/or the certificate to be checked are especially useful.
 *
-* @param selector A <code>CRLSelector</code> used to select which
+* @param selector A {@code CRLSelector} used to select which
-*  <code>CRL</code>s should be returned. Specify <code>null</code>
+*  {@code CRL}s should be returned. Specify {@code null}
-*  to return all <code>CRL</code>s (if supported).
+*  to return all {@code CRL}s (if supported).
-* @return A <code>Collection</code> of <code>CRL</code>s that
+* @return A {@code Collection} of {@code CRL}s that
-*         match the specified selector (never <code>null</code>)
+*         match the specified selector (never {@code null})
 * @throws CertStoreException if an exception occurs
 */
 public final Collection<? extends CRL> getCRLs(CRLSelector selector)
 throws CertStoreException {
 return storeSpi.engineGetCRLs(selector);
 }
 /**
-* Returns a <code>CertStore</code> object that implements the specified
+* Returns a {@code CertStore} object that implements the specified
-* <code>CertStore</code> type and is initialized with the specified
+* {@code CertStore} type and is initialized with the specified
 * parameters.
 *
 * <p> This method traverses the list of registered security Providers,
 * starting with the most preferred Provider.
 * A new CertStore object encapsulating the
 * Provider that supports the specified type is returned.
 *
 * <p> Note that the list of registered providers may be retrieved via
 * the {@link Security#getProviders() Security.getProviders()} method.
 *
-* <p>The <code>CertStore</code> that is returned is initialized with the
+* <p>The {@code CertStore} that is returned is initialized with the
-* specified <code>CertStoreParameters</code>. The type of parameters
+* specified {@code CertStoreParameters}. The type of parameters
-* needed may vary between different types of <code>CertStore</code>s.
+* needed may vary between different types of {@code CertStore}s.
-* Note that the specified <code>CertStoreParameters</code> object is
+* Note that the specified {@code CertStoreParameters} object is
 * cloned.
 *
-* @param type the name of the requested <code>CertStore</code> type.
+* @param type the name of the requested {@code CertStore} type.
 * See the CertStore section in the <a href=
 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertStore">
 * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 * for information about standard types.
 *
-* @param params the initialization parameters (may be <code>null</code>).
+* @param params the initialization parameters (may be {@code null}).
 *
-* @return a <code>CertStore</code> object that implements the specified
+* @return a {@code CertStore} object that implements the specified
-*          <code>CertStore</code> type.
+*          {@code CertStore} type.
 *
 * @throws NoSuchAlgorithmException if no Provider supports a
 *          CertStoreSpi implementation for the specified type.
 *
 * @throws InvalidAlgorithmParameterException if the specified
 *          initialization parameters are inappropriate for this
-*          <code>CertStore</code>.
+*          {@code CertStore}.
 *
 * @see java.security.Provider
 */
 public static CertStore getInstance(String type, CertStoreParameters params)
 throws InvalidAlgorithmParameterException,
 }
 throw e;
 }
 /**
-* Returns a <code>CertStore</code> object that implements the specified
+* Returns a {@code CertStore} object that implements the specified
-* <code>CertStore</code> type.
+* {@code CertStore} type.
 *
 * <p> A new CertStore object encapsulating the
 * CertStoreSpi implementation from the specified provider
 * is returned.  The specified provider must be registered
 * in the security provider list.
 *
 * <p> Note that the list of registered providers may be retrieved via
 * the {@link Security#getProviders() Security.getProviders()} method.
 *
-* <p>The <code>CertStore</code> that is returned is initialized with the
+* <p>The {@code CertStore} that is returned is initialized with the
-* specified <code>CertStoreParameters</code>. The type of parameters
+* specified {@code CertStoreParameters}. The type of parameters
-* needed may vary between different types of <code>CertStore</code>s.
+* needed may vary between different types of {@code CertStore}s.
-* Note that the specified <code>CertStoreParameters</code> object is
+* Note that the specified {@code CertStoreParameters} object is
 * cloned.
 *
-* @param type the requested <code>CertStore</code> type.
+* @param type the requested {@code CertStore} type.
 * See the CertStore section in the <a href=
 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertStore">
 * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 * for information about standard types.
 *
-* @param params the initialization parameters (may be <code>null</code>).
+* @param params the initialization parameters (may be {@code null}).
 *
 * @param provider the name of the provider.
 *
-* @return a <code>CertStore</code> object that implements the
+* @return a {@code CertStore} object that implements the
 *          specified type.
 *
 * @throws NoSuchAlgorithmException if a CertStoreSpi
 *          implementation for the specified type is not
 *          available from the specified provider.
 *
 * @throws InvalidAlgorithmParameterException if the specified
 *          initialization parameters are inappropriate for this
-*          <code>CertStore</code>.
+*          {@code CertStore}.
 *
 * @throws NoSuchProviderException if the specified provider is not
 *          registered in the security provider list.
 *
-* @exception IllegalArgumentException if the <code>provider</code> is
+* @exception IllegalArgumentException if the {@code provider} is
 *          null or empty.
 *
 * @see java.security.Provider
 */
 public static CertStore getInstance(String type,
 return handleException(e);
 }
 }
 /**
-* Returns a <code>CertStore</code> object that implements the specified
+* Returns a {@code CertStore} object that implements the specified
-* <code>CertStore</code> type.
+* {@code CertStore} type.
 *
 * <p> A new CertStore object encapsulating the
 * CertStoreSpi implementation from the specified Provider
 * object is returned.  Note that the specified Provider object
 * does not have to be registered in the provider list.
 *
-* <p>The <code>CertStore</code> that is returned is initialized with the
+* <p>The {@code CertStore} that is returned is initialized with the
-* specified <code>CertStoreParameters</code>. The type of parameters
+* specified {@code CertStoreParameters}. The type of parameters
-* needed may vary between different types of <code>CertStore</code>s.
+* needed may vary between different types of {@code CertStore}s.
-* Note that the specified <code>CertStoreParameters</code> object is
+* Note that the specified {@code CertStoreParameters} object is
 * cloned.
 *
-* @param type the requested <code>CertStore</code> type.
+* @param type the requested {@code CertStore} type.
 * See the CertStore section in the <a href=
 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertStore">
 * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 * for information about standard types.
 *
-* @param params the initialization parameters (may be <code>null</code>).
+* @param params the initialization parameters (may be {@code null}).
 *
 * @param provider the provider.
 *
-* @return a <code>CertStore</code> object that implements the
+* @return a {@code CertStore} object that implements the
 *          specified type.
 *
 * @exception NoSuchAlgorithmException if a CertStoreSpi
 *          implementation for the specified type is not available
 *          from the specified Provider object.
 *
 * @throws InvalidAlgorithmParameterException if the specified
 *          initialization parameters are inappropriate for this
-*          <code>CertStore</code>
+*          {@code CertStore}
 *
-* @exception IllegalArgumentException if the <code>provider</code> is
+* @exception IllegalArgumentException if the {@code provider} is
 *          null.
 *
 * @see java.security.Provider
 */
 public static CertStore getInstance(String type, CertStoreParameters params,
 return handleException(e);
 }
 }
 /**
-* Returns the parameters used to initialize this <code>CertStore</code>.
+* Returns the parameters used to initialize this {@code CertStore}.
-* Note that the <code>CertStoreParameters</code> object is cloned before
+* Note that the {@code CertStoreParameters} object is cloned before
 * it is returned.
 *
-* @return the parameters used to initialize this <code>CertStore</code>
+* @return the parameters used to initialize this {@code CertStore}
-* (may be <code>null</code>)
+* (may be {@code null})
 */
 public final CertStoreParameters getCertStoreParameters() {
 return (params == null ? null : (CertStoreParameters) params.clone());
 }
 /**
-* Returns the type of this <code>CertStore</code>.
+* Returns the type of this {@code CertStore}.
 *
-* @return the type of this <code>CertStore</code>
+* @return the type of this {@code CertStore}
 */
 public final String getType() {
 return this.type;
 }
 /**
-* Returns the provider of this <code>CertStore</code>.
+* Returns the provider of this {@code CertStore}.
 *
-* @return the provider of this <code>CertStore</code>
+* @return the provider of this {@code CertStore}
 */
 public final Provider getProvider() {
 return this.provider;
 }

changeset 18551	882a3948c6e6
parent 14775	2ed01c760aea