/*
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.security;
A private key.
The purpose of this interface is to group (and provide type safety
for) all private key interfaces.
Note: The specialized private key interfaces extend this interface. See, for example, the DSAPrivateKey interface in interfaces.
Implementations should override the default destroy and isDestroyed methods from the Destroyable interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since PrivateKey is Serializable, implementations should also override ObjectOutputStream.writeObject(Object) to prevent keys that have been destroyed from being serialized.
Author: Benjamin Renaud, Josh Bloch See Also: Since: 1.1
/**
* A private key.
* The purpose of this interface is to group (and provide type safety
* for) all private key interfaces.
* <p>
* Note: The specialized private key interfaces extend this interface.
* See, for example, the {@code DSAPrivateKey} interface in
* {@link java.security.interfaces}.
* <p>
* Implementations should override the default {@code destroy} and
* {@code isDestroyed} methods from the
* {@link javax.security.auth.Destroyable} interface to enable
* sensitive key information to be destroyed, cleared, or in the case
* where such information is immutable, unreferenced.
* Finally, since {@code PrivateKey} is {@code Serializable}, implementations
* should also override
* {@link java.io.ObjectOutputStream#writeObject(java.lang.Object)}
* to prevent keys that have been destroyed from being serialized.
*
* @see Key
* @see PublicKey
* @see Certificate
* @see Signature#initVerify
* @see java.security.interfaces.DSAPrivateKey
* @see java.security.interfaces.RSAPrivateKey
* @see java.security.interfaces.RSAPrivateCrtKey
*
* @author Benjamin Renaud
* @author Josh Bloch
* @since 1.1
*/
public interface PrivateKey extends Key, javax.security.auth.Destroyable {
// Declare serialVersionUID to be compatible with JDK1.1
The class fingerprint that is set to indicate serialization
compatibility with a previous version of the class.
/**
* The class fingerprint that is set to indicate serialization
* compatibility with a previous version of the class.
*/
static final long serialVersionUID = 6034044314589513430L;
}