Package com.google.crypto.tink.internal

Class SerializationRegistry

java.lang.Object

com.google.crypto.tink.internal.SerializationRegistry

public final class SerializationRegistry
extends java.lang.Object

Allows registering KeySerializer, KeyParser, ParametersSerializer, and ParametersParser objects, and parsing/serializing keys and key formats with such objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SerializationRegistry.Builder	Allows building SerializationRegistry objects.

Method Summary

Modifier and Type	Method	Description
boolean	hasParserForKey(ProtoKeySerialization serializedKey)	Returns true if a parser for this serializedKey has been registered.
boolean	hasParserForParameters(ProtoParametersSerialization serializedParameters)	Returns true if a parser for this serializedKey has been registered.
<KeyT extends Key> boolean	hasSerializerForKey(KeyT key, java.lang.Class<?> serializationClass)	Returns true if a parser for this serializedKey has been registered.
<ParametersT extends Parameters> boolean	hasSerializerForParameters(ParametersT parameters, java.lang.Class<?> serializationClass)	Returns true if a parser for this serializedKey has been registered.
Key	parseKey(ProtoKeySerialization serializedKey, SecretKeyAccess access)	Parses the given serialization into a Key.
Parameters	parseParameters(ProtoParametersSerialization serializedParameters)	Parses the given serialization into a Parameters.
<KeyT extends Key> ProtoKeySerialization	serializeKey(KeyT key, SecretKeyAccess access)	Serializes a given Key into a "SerializationT" object.
<ParametersT extends Parameters> ProtoParametersSerialization	serializeParameters(ParametersT parameters)	Serializes a given Parameters object into a "SerializationT" object.

Methods inherited from class java.lang.Object

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

Method Detail

hasParserForKey

public boolean hasParserForKey(ProtoKeySerialization serializedKey)

Returns true if a parser for this serializedKey has been registered.

parseKey

public Key parseKey(ProtoKeySerialization serializedKey,
                    @Nullable
                    SecretKeyAccess access)
             throws java.security.GeneralSecurityException

Parses the given serialization into a Key.

This will look up a previously registered parser for the passed in SerializationT class, and the used object identifier (as indicated by serializedKey.getObjectIdentifier()), and then parse the object with this parsers.

Throws:

java.security.GeneralSecurityException

hasSerializerForKey

public <KeyT extends Key> boolean hasSerializerForKey(KeyT key,
                                                      java.lang.Class<?> serializationClass)

Returns true if a parser for this serializedKey has been registered.

serializeKey

public <KeyT extends Key> ProtoKeySerialization serializeKey(KeyT key,
                                                             @Nullable
                                                             SecretKeyAccess access)
                                                      throws java.security.GeneralSecurityException

Serializes a given Key into a "SerializationT" object.

This will look up a previously registered serializer for the requested SerializationT class and the passed in key type, and then call serializeKey on the result.

Throws:

java.security.GeneralSecurityException

hasParserForParameters

public boolean hasParserForParameters(ProtoParametersSerialization serializedParameters)

Returns true if a parser for this serializedKey has been registered.

parseParameters

public Parameters parseParameters(ProtoParametersSerialization serializedParameters)
                           throws java.security.GeneralSecurityException

Parses the given serialization into a Parameters.

This will look up a previously registered parser for the passed in SerializationT class, and the used object identifier (as indicated by serializedKey.getObjectIdentifier()), and then parse the object with this parsers.

Throws:

java.security.GeneralSecurityException

hasSerializerForParameters

public <ParametersT extends Parameters> boolean hasSerializerForParameters(ParametersT parameters,
                                                                           java.lang.Class<?> serializationClass)

Returns true if a parser for this serializedKey has been registered.

serializeParameters

public <ParametersT extends Parameters> ProtoParametersSerialization serializeParameters(ParametersT parameters)
                                                                                  throws java.security.GeneralSecurityException

Serializes a given Parameters object into a "SerializationT" object.

This will look up a previously registered serializer for the requested SerializationT class and the passed in key type, and then call serializeKey on the result.

Throws:

java.security.GeneralSecurityException