Source for gnu.javax.crypto.keyring.IPublicKeyring

   1: /* IPublicKeyring.java --
   2:    Copyright (C) 2003, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is a 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 of the License, or (at
   9: your option) 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; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: 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 gnu.javax.crypto.keyring;
  40: 
  41: import java.security.cert.Certificate;
  42: 
  43: /**
  44:  * An interface for keyrings that contain trusted (by the owner) public
  45:  * credentials (incl. certificates).
  46:  *
  47:  * @see IKeyring
  48:  */
  49: public interface IPublicKeyring
  50:     extends IKeyring
  51: {
  52:   /**
  53:    * Tests if this keyring contains a certificate entry with the specified
  54:    * <code>alias</code>.
  55:    *
  56:    * @param alias The alias of the certificate to check.
  57:    * @return <code>true</code> if this keyring contains a certificate entry
  58:    *         that has the given <code>alias</code>; <code>false</code>
  59:    *         otherwise.
  60:    */
  61:   boolean containsCertificate(String alias);
  62: 
  63:   /**
  64:    * Returns a certificate that has the given <code>alias</code>, or
  65:    * <code>null</code> if this keyring has no such entry.
  66:    *
  67:    * @param alias The alias of the certificate to find.
  68:    * @return The certificate with the designated <code>alias</code>, or
  69:    *         <code>null</code> if none found.
  70:    */
  71:   Certificate getCertificate(String alias);
  72: 
  73:   /**
  74:    * Adds a certificate in this keyring, with the given <code>alias</code>.
  75:    * <p>
  76:    * What happens if there is already a certificate entry with this alias?
  77:    *
  78:    * @param alias The alias of this certificate entry.
  79:    * @param cert The certificate.
  80:    */
  81:   void putCertificate(String alias, Certificate cert);
  82: }