KeyRep (Java 2 Platform SE 5.0) (original) (raw)

java.security

Class KeyRep

java.lang.Object extended by 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 Serialization Specification for more information.

Since:

1.5

Nested Class Summary
static class	KeyRep.Type Key type.

Constructor Summary
[KeyRep](../../java/security/KeyRep.html#KeyRep%28java.security.KeyRep.Type, java.lang.String, java.lang.String, byte[]%29)(KeyRep.Type type,String algorithm,String format, byte[] encoded) Construct the alternate Key class.

Method Summary
protected Object	readResolve() Resolve the Key object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

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 fromKey.getAlgorithm()

format - the encoding format returned fromKey.getFormat()

encoded - the encoded bytes returned fromKey.getEncoded()

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if type is null, if algorithm is null, if format is null, or if encoded is null

Method Detail

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:

[NotSerializableException](../../java/io/NotSerializableException.html "class in java.io") - 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

[ObjectStreamException](../../java/io/ObjectStreamException.html "class in java.io")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.