1 /*
   2  * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.security;
  27 
  28 /**
  29  * A private key.
  30  * The purpose of this interface is to group (and provide type safety
  31  * for) all private key interfaces.
  32  * <p>
  33  * Note: The specialized private key interfaces extend this interface.
  34  * See, for example, the {@code DSAPrivateKey} interface in
  35  * {@link java.security.interfaces}.
  36  * <p>
  37  * Implementations should override the default {@code destroy} and
  38  * {@code isDestroyed} methods from the
  39  * {@link javax.security.auth.Destroyable} interface to enable
  40  * sensitive key information to be destroyed, cleared, or in the case
  41  * where such information is immutable, unreferenced.
  42  * Finally, since {@code PrivateKey} is {@code Serializable}, implementations
  43  * should also override
  44  * {@link java.io.ObjectOutputStream#writeObject(java.lang.Object)}
  45  * to prevent keys that have been destroyed from being serialized.
  46  *
  47  * @see Key
  48  * @see PublicKey
  49  * @see Certificate
  50  * @see Signature#initVerify
  51  * @see java.security.interfaces.DSAPrivateKey
  52  * @see java.security.interfaces.RSAPrivateKey
  53  * @see java.security.interfaces.RSAPrivateCrtKey
  54  *
  55  * @author Benjamin Renaud
  56  * @author Josh Bloch
  57  * @since 1.1
  58  */
  59 
  60 public interface PrivateKey extends Key, javax.security.auth.Destroyable {
  61 
  62     // Declare serialVersionUID to be compatible with JDK1.1
  63     /**
  64      * The class fingerprint that is set to indicate serialization
  65      * compatibility with a previous version of the class.
  66      */
  67     static final long serialVersionUID = 6034044314589513430L;
  68 }