Source for java.security.cert.CertStoreSpi

   1: /* CertStoreSpi -- certificate store service provider interface.
   2:    Copyright (C) 2003 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.security.cert;
  40: 
  41: import java.security.InvalidAlgorithmParameterException;
  42: import java.util.Collection;
  43: 
  44: /**
  45:  * The <i>service provider interface</i> (<b>SPI</b>) for the {@link
  46:  * CertStore} class.
  47:  *
  48:  * <p>Providers wishing to implement a CertStore must subclass this
  49:  * class, implementing all the abstract methods. Providers may also
  50:  * implement the {@link CertStoreParameters} interface, if they require
  51:  * parameters.
  52:  *
  53:  * @since 1.4
  54:  * @see CertStore
  55:  * @see CollectionCertStoreParameters
  56:  * @see LDAPCertStoreParameters
  57:  */
  58: public abstract class CertStoreSpi
  59: {
  60: 
  61:   // Constructors.
  62:   // ------------------------------------------------------------------------
  63: 
  64:   /**
  65:    * Creates a new CertStoreSpi.
  66:    *
  67:    * @param params The parameters to initialize this instance with, or
  68:    *        null if no parameters are required.
  69:    * @throws InvalidAlgorithmParameterException If the specified
  70:    *         parameters are inappropriate for this class.
  71:    */
  72:   public CertStoreSpi(CertStoreParameters params)
  73:     throws InvalidAlgorithmParameterException
  74:   {
  75:     super();
  76:   }
  77: 
  78:   // Abstract methods.
  79:   // ------------------------------------------------------------------------
  80: 
  81:   /**
  82:    * Get the certificates from this store, filtering them through the
  83:    * specified CertSelector.
  84:    *
  85:    * @param selector The CertSelector to filter certificates.
  86:    * @return A (non-null) collection of certificates.
  87:    * @throws CertStoreException If the certificates cannot be retrieved.
  88:    */
  89:   public abstract Collection<? extends Certificate> engineGetCertificates(CertSelector selector)
  90:   throws CertStoreException;
  91: 
  92:   /**
  93:    * Get the certificate revocation list from this store, filtering them
  94:    * through the specified CRLSelector.
  95:    *
  96:    * @param selector The CRLSelector to filter certificate revocation
  97:    *        lists.
  98:    * @return A (non-null) collection of certificate revocation list.
  99:    * @throws CertStoreException If the CRLs cannot be retrieved.
 100:    */
 101:   public abstract Collection<? extends CRL> engineGetCRLs(CRLSelector selector)
 102:   throws CertStoreException;
 103: }