001/* X500PrivateCredential.java -- certificate and private key pair.
002   Copyright (C) 2003, 2004  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 javax.security.auth.x500;
040
041import java.security.PrivateKey;
042import java.security.cert.X509Certificate;
043
044import javax.security.auth.Destroyable;
045
046/**
047 * A pairing of a {@link X509Certificate} and its corresponding {@link
048 * PrivateKey}, with an optional keystore alias.
049 */
050public final class X500PrivateCredential implements Destroyable
051{
052
053  // Fields.
054  // -------------------------------------------------------------------------
055
056  private PrivateKey key;
057  private X509Certificate certificate;
058  private String alias;
059
060  // Constructors.
061  // -------------------------------------------------------------------------
062
063  /**
064   * Creates a new private credential with no associated keystore alias.
065   *
066   * @param certificate The X.509 certificate.
067   * @param key The private key.
068   * @throws IllegalArgumentException If either parameter is null.
069   */
070  public X500PrivateCredential (X509Certificate certificate, PrivateKey key)
071  {
072    if (certificate == null || key == null)
073      throw new IllegalArgumentException();
074    this.certificate = certificate;
075    this.key = key;
076  }
077
078  /**
079   * Creates a new private credential with a keystore alias.
080   *
081   * @param certificate The X.509 certificate.
082   * @param key The private key.
083   * @param alias The keystore alias for this credential.
084   * @throws IllegalArgumentException If any parameter is null.
085   */
086  public X500PrivateCredential (X509Certificate certificate, PrivateKey key,
087                                String alias)
088  {
089    this (certificate, key);
090    if (alias == null)
091      throw new IllegalArgumentException();
092    this.alias = alias;
093  }
094
095  // Instance methods.
096  // -------------------------------------------------------------------------
097
098  /**
099   * 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}