Source for javax.security.auth.x500.X500PrivateCredential

   1: /* X500PrivateCredential.java -- certificate and private key pair.
   2:    Copyright (C) 2003, 2004  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 javax.security.auth.x500;
  40: 
  41: import java.security.PrivateKey;
  42: import java.security.cert.X509Certificate;
  43: 
  44: import javax.security.auth.Destroyable;
  45: 
  46: /**
  47:  * A pairing of a {@link X509Certificate} and its corresponding {@link
  48:  * PrivateKey}, with an optional keystore alias.
  49:  */
  50: public final class X500PrivateCredential implements Destroyable
  51: {
  52: 
  53:   // Fields.
  54:   // -------------------------------------------------------------------------
  55: 
  56:   private PrivateKey key;
  57:   private X509Certificate certificate;
  58:   private String alias;
  59: 
  60:   // Constructors.
  61:   // -------------------------------------------------------------------------
  62: 
  63:   /**
  64:    * Creates a new private credential with no associated keystore alias.
  65:    *
  66:    * @param certificate The X.509 certificate.
  67:    * @param key The private key.
  68:    * @throws IllegalArgumentException If either parameter is null.
  69:    */
  70:   public X500PrivateCredential (X509Certificate certificate, PrivateKey key)
  71:   {
  72:     if (certificate == null || key == null)
  73:       throw new IllegalArgumentException();
  74:     this.certificate = certificate;
  75:     this.key = key;
  76:   }
  77: 
  78:   /**
  79:    * Creates a new private credential with a keystore alias.
  80:    *
  81:    * @param certificate The X.509 certificate.
  82:    * @param key The private key.
  83:    * @param alias The keystore alias for this credential.
  84:    * @throws IllegalArgumentException If any parameter is null.
  85:    */
  86:   public X500PrivateCredential (X509Certificate certificate, PrivateKey key,
  87:                                 String alias)
  88:   {
  89:     this (certificate, key);
  90:     if (alias == null)
  91:       throw new IllegalArgumentException();
  92:     this.alias = alias;
  93:   }
  94: 
  95:   // Instance methods.
  96:   // -------------------------------------------------------------------------
  97: 
  98:   /**
  99:    * Returns the certificate of this credential.
 100:    *
 101:    * @return The certificate of this credential.
 102:    */
 103:   public X509Certificate getCertificate()
 104:   {
 105:     return certificate;
 106:   }
 107: 
 108:   /**
 109:    * Returns the private key of this credential.
 110:    *
 111:    * @return The private key of this credential.
 112:    */
 113:   public PrivateKey getPrivateKey()
 114:   {
 115:     return key;
 116:   }
 117: 
 118:   /**
 119:    * Returns the keystore alias of this credential, or null if not present.
 120:    *
 121:    * @return The keystore alias, or null.
 122:    */
 123:   public String getAlias()
 124:   {
 125:     return alias;
 126:   }
 127: 
 128:   /**
 129:    * Destroy the sensitive data of this credential, setting the certificate,
 130:    * private key, and keystore alias to null.
 131:    */
 132:   public void destroy()
 133:   {
 134:     certificate = null;
 135:     key = null;
 136:     alias = null;
 137:   }
 138: 
 139:   /**
 140:    * Tells whether or not this credential has been destroyed, and that
 141:    * the certificate and private key fields are null.
 142:    *
 143:    * @return True if this object has been destroyed.
 144:    */
 145:   public boolean isDestroyed()
 146:   {
 147:     return certificate == null && key == null;
 148:   }
 149: }