EncodedKeySpec

AI-generated Key Takeaways

• EncodedKeySpec represents a public or private key in an encoded format, serving as a specification for key material.

• It provides methods to retrieve the encoded key and the name of its encoding format (e.g., "PKCS#8", "X.509").

• Direct known subclasses include PKCS8EncodedKeySpec (for private keys) and X509EncodedKeySpec (for public keys).

• It's used in conjunction with KeyFactory to convert between encoded keys and key objects.

public abstract class EncodedKeySpec extends Object
implements KeySpec

Known Direct Subclasses PKCS8EncodedKeySpec, X509EncodedKeySpec 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.

See Also

• Key
• KeyFactory
• KeySpec
• X509EncodedKeySpec
• PKCS8EncodedKeySpec

Public Constructor Summary

EncodedKeySpec(byte[] encodedKey) Creates a new EncodedKeySpec with the given encoded key.

Public Method Summary

byte[]	getEncoded() Returns the encoded key.
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.

Throws

NullPointerException	if encodedKey is null.

Public Methods

public byte[] getEncoded ()

Returns the encoded key.

Returns

• the encoded key. Returns a new array each time this method is called.

public abstract String getFormat ()

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.