EncodedKeySpec
Stay organized with collections
Save and categorize content based on your preferences.
Known Direct Subclasses
| PKCS8EncodedKeySpec |
This class represents the ASN.1 encoding of a private key,
encoded according to the ASN.1 type PrivateKeyInfo. |
| X509EncodedKeySpec |
This class represents the ASN.1 encoding of a public key,
encoded according to the ASN.1 type SubjectPublicKeyInfo. |
|
This class represents a public or private key in encoded format.
Public Constructor Summary
|
|
EncodedKeySpec(byte[] encodedKey)
Creates a new EncodedKeySpec with the given encoded key.
|
Public Method Summary
|
byte[]
|
|
|
abstract
String
|
getFormat()
Returns the name of the encoding format associated with this
key specification.
|
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
EncodedKeySpec
(byte[] encodedKey)
Creates a new EncodedKeySpec with the given encoded key.
Parameters
| encodedKey |
the encoded key. The contents of the
array are copied to protect against subsequent modification. |
Public Methods
public
byte[]
getEncoded
()
Returns
- the encoded key. Returns a new array each time
this method is called.
Returns the name of the encoding format associated with this
key specification.
If the opaque representation of a key
(see Key) can be transformed
(see KeyFactory)
into this key specification (or a subclass of it),
getFormat called
on the opaque key returns the same value as the
getFormat method
of this key specification.
Returns
- a string representation of the encoding format.
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\u003e\u003ccode\u003eEncodedKeySpec\u003c/code\u003e represents a public or private key in an encoded format, serving as a specification for key material.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to retrieve the encoded key and the name of its encoding format (e.g., "PKCS#8", "X.509").\u003c/p\u003e\n"],["\u003cp\u003eDirect known subclasses include \u003ccode\u003ePKCS8EncodedKeySpec\u003c/code\u003e (for private keys) and \u003ccode\u003eX509EncodedKeySpec\u003c/code\u003e (for public keys).\u003c/p\u003e\n"],["\u003cp\u003eIt's used in conjunction with \u003ccode\u003eKeyFactory\u003c/code\u003e to convert between encoded keys and key objects.\u003c/p\u003e\n"]]],["`EncodedKeySpec` represents a public or private key in encoded format. It has two direct subclasses: `PKCS8EncodedKeySpec` (private key) and `X509EncodedKeySpec` (public key). The class allows the creation of an `EncodedKeySpec` with a provided encoded key. Key actions include: `getEncoded()`, which retrieves the encoded key as a byte array, and `getFormat()`, which returns the encoding format's name. The constructor ensures the encoded key array is copied.\n"],null,["# EncodedKeySpec\n\npublic abstract class **EncodedKeySpec** extends [Object](../../../../reference/java/lang/Object.html) \nimplements [KeySpec](../../../../reference/java/security/spec/KeySpec.html) \n\n|---|---|---|\n| Known Direct Subclasses [PKCS8EncodedKeySpec](../../../../reference/java/security/spec/PKCS8EncodedKeySpec.html), [X509EncodedKeySpec](../../../../reference/java/security/spec/X509EncodedKeySpec.html) |------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | [PKCS8EncodedKeySpec](../../../../reference/java/security/spec/PKCS8EncodedKeySpec.html) | This class represents the ASN.1 encoding of a private key, encoded according to the ASN.1 type `PrivateKeyInfo`. | | [X509EncodedKeySpec](../../../../reference/java/security/spec/X509EncodedKeySpec.html) | This class represents the ASN.1 encoding of a public key, encoded according to the ASN.1 type `SubjectPublicKeyInfo`. | |||\n\nThis class represents a public or private key in encoded format. \n\n##### See Also\n\n- [Key](../../../../reference/java/security/Key.html)\n- [KeyFactory](../../../../reference/java/security/KeyFactory.html)\n- [KeySpec](../../../../reference/java/security/spec/KeySpec.html)\n- [X509EncodedKeySpec](../../../../reference/java/security/spec/X509EncodedKeySpec.html)\n- [PKCS8EncodedKeySpec](../../../../reference/java/security/spec/PKCS8EncodedKeySpec.html) \n\n### Public Constructor Summary\n\n|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [EncodedKeySpec](../../../../reference/java/security/spec/EncodedKeySpec.html#EncodedKeySpec(byte[]))(byte\\[\\] encodedKey) Creates a new EncodedKeySpec with the given encoded key. |\n\n### Public Method Summary\n\n|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| byte\\[\\] | [getEncoded](../../../../reference/java/security/spec/EncodedKeySpec.html#getEncoded())() Returns the encoded key. |\n| abstract [String](../../../../reference/java/lang/String.html) | [getFormat](../../../../reference/java/security/spec/EncodedKeySpec.html#getFormat())() Returns the name of the encoding format associated with this key specification. |\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**EncodedKeySpec**\n(byte\\[\\] encodedKey)\n\nCreates a new EncodedKeySpec with the given encoded key. \n\n##### Parameters\n\n| encodedKey | the encoded key. The contents of the array are copied to protect against subsequent modification. |\n|------------|---------------------------------------------------------------------------------------------------|\n\n##### Throws\n\n| [NullPointerException](../../../../reference/java/lang/NullPointerException.html) | if `encodedKey` is null. |\n|-----------------------------------------------------------------------------------|--------------------------|\n\nPublic Methods\n--------------\n\n#### public byte\\[\\]\n**getEncoded**\n()\n\nReturns the encoded key. \n\n##### Returns\n\n- the encoded key. Returns a new array each time this method is called. \n\n#### public abstract [String](../../../../reference/java/lang/String.html)\n**getFormat**\n()\n\nReturns the name of the encoding format associated with this\nkey specification.\n\nIf the opaque representation of a key\n(see [Key](../../../../reference/java/security/Key.html)) can be transformed\n(see [KeyFactory](../../../../reference/java/security/KeyFactory.html))\ninto this key specification (or a subclass of it),\n`getFormat` called\non the opaque key returns the same value as the\n`getFormat` method\nof this key specification. \n\n##### Returns\n\n- a string representation of the encoding format."]]
