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.util.Collection;
  42: 
  43: /**
  44:  * The <i>service provider interface</i> (<b>SPI</b>) for the {@link
  45:  * CertStore} class.
  46:  *
  47:  * <p>Providers wishing to implement a CertStore must subclass this
  48:  * class, implementing all the abstract methods. Providers may also
  49:  * implement the {@link CertStoreParameters} interface, if they require
  50:  * parameters.
  51:  *
  52:  * @since JDK 1.4
  53:  * @see CertStore
  54:  * @see CollectionCertStoreParameters
  55:  * @see LDAPCertStoreParameters
  56:  */
  57: public abstract class CertStoreSpi
  58: {
  59: 
  60:   // Constructors.
  61:   // ------------------------------------------------------------------------
  62: 
  63:   /**
  64:    * Creates a new CertStoreSpi.
  65:    *
  66:    * @param params The parameters to initialize this instance with, or
  67:    *        null if no parameters are required.
  68:    * @throws InvalidAlgorithmParameterException If the specified
  69:    *         parameters are inappropriate for this class.
  70:    */
  71:   public CertStoreSpi(CertStoreParameters params)
  72:     throws java.security.InvalidAlgorithmParameterException
  73:   {
  74:     super();
  75:   }
  76: 
  77:   // Abstract methods.
  78:   // ------------------------------------------------------------------------
  79: 
  80:   /**
  81:    * Get the certificates from this store, filtering them through the
  82:    * specified CertSelector.
  83:    *
  84:    * @param selector The CertSelector to filter certificates.
  85:    * @return A (non-null) collection of certificates.
  86:    * @throws CertStoreException If the certificates cannot be retrieved.
  87:    */
  88:   public abstract Collection engineGetCertificates(CertSelector selector)
  89:   throws CertStoreException;
  90: 
  91:   /**
  92:    * Get the certificate revocation list from this store, filtering them
  93:    * through the specified CRLSelector.
  94:    *
  95:    * @param selector The CRLSelector to filter certificate revocation
  96:    *        lists.
  97:    * @return A (non-null) collection of certificate revocation list.
  98:    * @throws CertStoreException If the CRLs cannot be retrieved.
  99:    */
 100:   public abstract Collection engineGetCRLs(CRLSelector selector)
 101:   throws CertStoreException;
 102: }