Class KeyRep

java.lang.Object

java.security.KeyRep

All Implemented Interfaces:: Serializable

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 Java Object Serialization Specification for more information.

Since:

1.5

External Specifications

See Also:

Nested Class Summary

Modifier and Type	Class	Description
`static enum`	`KeyRep.Type`	Key type.

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`protected Object`	`readResolve()`	Resolve the Key object.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

KeyRep

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

Method Details

readResolve

protected Object readResolve() throws ObjectStreamException

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

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.