Source for javax.crypto.interfaces.DHPrivateKey

   1: /* DHPrivateKey.java -- A Diffie-Hellman private key.
   2:    Copyright (C) 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.crypto.interfaces;
  40: 
  41: import java.math.BigInteger;
  42: import java.security.PrivateKey;
  43: 
  44: /**
  45:  * This interface marks a private key in the Diffie-Hellman key exchange
  46:  * algorithm. It should be treated with as much care as any {@link
  47:  * java.security.PrivateKey}.
  48:  *
  49:  * <p>Implementations of Diffie-Hellman private keys should implement
  50:  * this interface. Applications that know a particular key is a
  51:  * Diffie-Hellman private key can safely cast it to this interface.
  52:  *
  53:  * @author Casey Marshall (csm@gnu.org)
  54:  * @since 1.4
  55:  * @see DHKey
  56:  * @see DHPublicKey
  57:  */
  58: public interface DHPrivateKey extends DHKey, PrivateKey
  59: {
  60:   /** Compatible with JDK1.4. */
  61:   long serialVersionUID = 2211791113380396553L;
  62: 
  63:   /**
  64:    * Returns the private value <i>x</i>.
  65:    *
  66:    * @return The private value <i>x</i>.
  67:    */
  68:   BigInteger getX();
  69: }