Home | History | Annotate | Download | only in security 
      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 import java.util.*;
     29 
     30 /**
     31  * This class is a simple holder for a key pair (a public key and a
     32  * private key). It does not enforce any security, and, when initialized,
     33  * should be treated like a PrivateKey.
     34  *
     35  * @see PublicKey
     36  * @see PrivateKey
     37  *
     38  * @author Benjamin Renaud
     39  */
     40 
     41 public final class KeyPair implements java.io.Serializable {
     42 
     43     private static final long serialVersionUID = -7565189502268009837L;
     44 
     45     private PrivateKey privateKey;
     46     private PublicKey publicKey;
     47 
     48     /**
     49      * Constructs a key pair from the given public key and private key.
     50      *
     51      * <p>Note that this constructor only stores references to the public
     52      * and private key components in the generated key pair. This is safe,
     53      * because {@code Key} objects are immutable.
     54      *
     55      * @param publicKey the public key.
     56      *
     57      * @param privateKey the private key.
     58      */
     59     public KeyPair(PublicKey publicKey, PrivateKey privateKey) {
     60         this.publicKey = publicKey;
     61         this.privateKey = privateKey;
     62     }
     63 
     64     /**
     65      * Returns a reference to the public key component of this key pair.
     66      *
     67      * @return a reference to the public key.
     68      */
     69     public PublicKey getPublic() {
     70         return publicKey;
     71     }
     72 
     73      /**
     74      * Returns a reference to the private key component of this key pair.
     75      *
     76      * @return a reference to the private key.
     77      */
     78    public PrivateKey getPrivate() {
     79         return privateKey;
     80     }
     81 }
     82