com.google.crypto.tink.internal

Class KeySerializer<KeyT extends Key,SerializationT extends Serialization>

java.lang.Object

com.google.crypto.tink.internal.KeySerializer<KeyT,SerializationT>

public abstract class KeySerializer<KeyT extends Key,SerializationT extends Serialization>
extends Object

Serializes Key objects into Serialization objects of a certain kind.

This class should eventually be in Tinks public API -- however, it might still change before that.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeySerializer.KeySerializationFunction<KeyT extends Key,SerializationT extends Serialization> A function which serializes a key.

Method Summary

Modifier and Type	Method and Description
static <KeyT extends Key,SerializationT extends Serialization> KeySerializer<KeyT,SerializationT>	create(KeySerializer.KeySerializationFunction<KeyT,SerializationT> function, Class<KeyT> keyClass, Class<SerializationT> serializationClass) Creates a KeySerializer object.
Class<KeyT>	getKeyClass()
Class<SerializationT>	getSerializationClass()
abstract SerializationT	serializeKey(KeyT key, SecretKeyAccess access)

Methods inherited from class java.lang.Object

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

Method Detail

serializeKey

public abstract SerializationT serializeKey(KeyT key,
                                            @Nullable
                                            SecretKeyAccess access)
                                     throws GeneralSecurityException

Throws:

GeneralSecurityException

getKeyClass

public Class<KeyT> getKeyClass()

getSerializationClass

public Class<SerializationT> getSerializationClass()

create

public static <KeyT extends Key,SerializationT extends Serialization> KeySerializer<KeyT,SerializationT> create(KeySerializer.KeySerializationFunction<KeyT,SerializationT> function,
                                                                                                                Class<KeyT> keyClass,
                                                                                                                Class<SerializationT> serializationClass)

Creates a KeySerializer object.

In order to create a KeySerializer object, one typically writes a function

 class MyClass {
   private static MySerialization serialize(MyKey key, @Nullable SecretKeyAccess access)
             throws GeneralSecurityException {
     ...
   }
 }
 

This function can then be used to create a KeySerializer:

 KeySerializer<MyKey, MySerialization> serializer =
       KeySerializer.create(MyClass::serialize, MyKey.class, MySerialization.class);
 

Note that calling this function twice will result in objects which are not equal according to Object.equals, and hence cannot be used to re-register a previously registered object.