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