KeyPair
Stay organized with collections
Save and categorize content based on your preferences.
This class is a simple holder for a key pair (a public key and a
private key). It does not enforce any security, and, when initialized,
should be treated like a PrivateKey.
Public Constructor Summary
Inherited Method Summary
From class
java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this Object.
|
|
boolean
|
equals( Object obj)
Compares this instance with the specified object and indicates if they
are equal.
|
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class.
|
|
int
|
hashCode()
Returns an integer hash code for this object.
|
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
|
final
void
|
wait(long timeout, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait(long timeout)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
Public Constructors
public
KeyPair
(PublicKey publicKey, PrivateKey privateKey)
Constructs a key pair from the given public key and private key.
Note that this constructor only stores references to the public
and private key components in the generated key pair. This is safe,
because Key objects are immutable.
Parameters
| publicKey |
the public key. |
| privateKey |
the private key.
|
Public Methods
public
PrivateKey
getPrivate
()
Returns a reference to the private key component of this key pair.
Returns
- a reference to the private key.
public
PublicKey
getPublic
()
Returns a reference to the public key component of this key pair.
Returns
- a reference to the public key.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eKeyPair\u003c/code\u003e class is a simple holder for a public and private key pair, and it does not inherently enforce any security measures.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eKeyPair\u003c/code\u003e objects should be treated with the same security precautions as \u003ccode\u003ePrivateKey\u003c/code\u003e objects, especially after initialization.\u003c/p\u003e\n"],["\u003cp\u003eThis class provides methods to retrieve the public and private key components, namely \u003ccode\u003egetPublic()\u003c/code\u003e and \u003ccode\u003egetPrivate()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eKeyPair\u003c/code\u003e is constructed using a public and private key, storing immutable references to these keys for access.\u003c/p\u003e\n"]]],["The `KeyPair` class holds a public and private key pair. It's serializable and doesn't enforce security. A `KeyPair` object is created using a `PublicKey` and a `PrivateKey`. The `getPublic()` method retrieves the public key, and `getPrivate()` retrieves the private key. It inherits methods from `java.lang.Object`, including `clone`, `equals`, `getClass`, `hashCode`, `notify`, `wait` and `toString`.\n"],null,["# KeyPair\n\npublic final class **KeyPair** extends [Object](../../../reference/java/lang/Object.html) \nimplements [Serializable](../../../reference/java/io/Serializable.html) \nThis class is a simple holder for a key pair (a public key and a\nprivate key). It does not enforce any security, and, when initialized,\nshould be treated like a PrivateKey. \n\n##### See Also\n\n- [PublicKey](../../../reference/java/security/PublicKey.html)\n- [PrivateKey](../../../reference/java/security/PrivateKey.html) \n\n### Public Constructor Summary\n\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [KeyPair](../../../reference/java/security/KeyPair.html#KeyPair(java.security.PublicKey,%20java.security.PrivateKey))([PublicKey](../../../reference/java/security/PublicKey.html) publicKey, [PrivateKey](../../../reference/java/security/PrivateKey.html) privateKey) Constructs a key pair from the given public key and private key. |\n\n### Public Method Summary\n\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [PrivateKey](../../../reference/java/security/PrivateKey.html) | [getPrivate](../../../reference/java/security/KeyPair.html#getPrivate())() Returns a reference to the private key component of this key pair. |\n| [PublicKey](../../../reference/java/security/PublicKey.html) | [getPublic](../../../reference/java/security/KeyPair.html#getPublic())() Returns a reference to the public key component of this key pair. |\n\n### Inherited Method Summary\n\nFrom class [java.lang.Object](../../../reference/java/lang/Object.html) \n\n|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Object](../../../reference/java/lang/Object.html) | [clone](../../../reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |\n| boolean | [equals](../../../reference/java/lang/Object.html#equals(java.lang.Object))([Object](../../../reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |\n| void | [finalize](../../../reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |\n| final [Class](../../../reference/java/lang/Class.html)\\\u003c?\\\u003e | [getClass](../../../reference/java/lang/Object.html#getClass())() Returns the unique instance of [Class](../../../reference/java/lang/Class.html) that represents this object's class. |\n| int | [hashCode](../../../reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |\n| final void | [notify](../../../reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| final void | [notifyAll](../../../reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| [String](../../../reference/java/lang/String.html) | [toString](../../../reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |\n\nPublic Constructors\n-------------------\n\n#### public\n**KeyPair**\n([PublicKey](../../../reference/java/security/PublicKey.html) publicKey, [PrivateKey](../../../reference/java/security/PrivateKey.html) privateKey)\n\nConstructs a key pair from the given public key and private key.\n\nNote that this constructor only stores references to the public\nand private key components in the generated key pair. This is safe,\nbecause `Key` objects are immutable. \n\n##### Parameters\n\n| publicKey | the public key. |\n| privateKey | the private key. |\n|------------|------------------|\n\nPublic Methods\n--------------\n\n#### public [PrivateKey](../../../reference/java/security/PrivateKey.html)\n**getPrivate**\n()\n\nReturns a reference to the private key component of this key pair. \n\n##### Returns\n\n- a reference to the private key. \n\n#### public [PublicKey](../../../reference/java/security/PublicKey.html)\n**getPublic**\n()\n\nReturns a reference to the public key component of this key pair. \n\n##### Returns\n\n- a reference to the public key."]]
