001/* CertStoreSpi -- certificate store service provider interface.
002   Copyright (C) 2003 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.security.cert;
040
041import java.security.InvalidAlgorithmParameterException;
042import java.util.Collection;
043
044/**
045 * The <i>service provider interface</i> (<b>SPI</b>) for the {@link
046 * CertStore} class.
047 *
048 * <p>Providers wishing to implement a CertStore must subclass this
049 * class, implementing all the abstract methods. Providers may also
050 * implement the {@link CertStoreParameters} interface, if they require
051 * parameters.
052 *
053 * @since 1.4
054 * @see CertStore
055 * @see CollectionCertStoreParameters
056 * @see LDAPCertStoreParameters
057 */
058public abstract class CertStoreSpi
059{
060
061  // Constructors.
062  // ------------------------------------------------------------------------
063
064  /**
065   * Creates a new CertStoreSpi.
066   *
067   * @param params The parameters to initialize this instance with, or
068   *        null if no parameters are required.
069   * @throws InvalidAlgorithmParameterException If the specified
070   *         parameters are inappropriate for this class.
071   */
072  public CertStoreSpi(CertStoreParameters params)
073    throws InvalidAlgorithmParameterException
074  {
075    super();
076  }
077
078  // Abstract methods.
079  // ------------------------------------------------------------------------
080
081  /**
082   * Get the certificates from this store, filtering them through the
083   * specified CertSelector.
084   *
085   * @param selector The CertSelector to filter certificates.
086   * @return A (non-null) collection of certificates.
087   * @throws CertStoreException If the certificates cannot be retrieved.
088   */
089  public abstract Collection<? extends Certificate> engineGetCertificates(CertSelector selector)
090  throws CertStoreException;
091
092  /**
093   * Get the certificate revocation list from this store, filtering them
094   * through the specified CRLSelector.
095   *
096   * @param selector The CRLSelector to filter certificate revocation
097   *        lists.
098   * @return A (non-null) collection of certificate revocation list.
099   * @throws CertStoreException If the CRLs cannot be retrieved.
100   */
101  public abstract Collection<? extends CRL> engineGetCRLs(CRLSelector selector)
102  throws CertStoreException;
103}