KeyRep

AI-generated Key Takeaways

• KeyRep provides a standardized, serializable representation for Key objects.

• Serialized KeyRep objects may contain sensitive information and should be handled with caution in untrusted environments.

• KeyRep supports resolving serialized keys back into Key objects using the readResolve method.

• readResolve handles specific Type/format combinations like SECRET/"RAW", PUBLIC/"X.509", and PRIVATE/"PKCS#8" to reconstruct the corresponding Key object.

public class KeyRep extends Object
implements Serializable

Standardized representation for serialized Key objects.

Note that a serialized Key may contain sensitive information which should not be exposed in untrusted environments. See the Security Appendix of the Serialization Specification for more information.

See Also

• Key
• KeyFactory
• SecretKeySpec
• X509EncodedKeySpec
• PKCS8EncodedKeySpec

Nested Class Summary

enum

KeyRep.Type

Key type.

Public Constructor Summary

KeyRep(KeyRep.Type type, String algorithm, String format, byte[] encoded) Construct the alternate Key class.

Protected Method Summary

Object

readResolve() Resolve the Key object.

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 KeyRep (KeyRep.Type type, String algorithm, String format, byte[] encoded)

Construct the alternate Key class.

Parameters

type	either one of Type.SECRET, Type.PUBLIC, or Type.PRIVATE
algorithm	the algorithm returned from Key.getAlgorithm()
format	the encoding format returned from Key.getFormat()
encoded	the encoded bytes returned from Key.getEncoded()

Throws

NullPointerException	if type is null, if algorithm is null, if format is null, or if encoded is null

Protected Methods

protected Object readResolve ()

Resolve the Key object.

This method supports three Type/format combinations:

• Type.SECRET/"RAW" - returns a SecretKeySpec object constructed using encoded key bytes and algorithm
• Type.PUBLIC/"X.509" - gets a KeyFactory instance for the key algorithm, constructs an X509EncodedKeySpec with the encoded key bytes, and generates a public key from the spec
• Type.PRIVATE/"PKCS#8" - gets a KeyFactory instance for the key algorithm, constructs a PKCS8EncodedKeySpec with the encoded key bytes, and generates a private key from the spec

Returns

• the resolved Key object

Throws

ObjectStreamException	if the Type/format combination is unrecognized, if the algorithm, key format, or encoded key bytes are unrecognized/invalid, of if the resolution of the key fails for any reason