com.netflix.server.context

Interface ContextSerializer<T>

Type Parameters:

T - The object type that the serializer can serialize/de-serialize

All Known Subinterfaces:

DirectionAwareContextSerializer<T>

All Known Implementing Classes:

DirectionAwareSerializerAdapter

public interface ContextSerializer<T>

A serializer for serialization/de-serialization any arbitrary context objects added to ContextsContainer.

This serializer will be used to serialize when the context objects are to be sent across the wire to another service vai NIWS client.

This serializer will be used to de-serialize when the context objects are received on the wire from another service as HTTP request headers.

Versioning

A context serializer provides a serialization mechanism version which will be passed during de-serialization. The intention of this versioning is not to select which versions can be de-serialized but to give a hint of what is the format of the content to be de-serialized. Any serializer is always expected to be backward compatible to handle services with multiple serializer versions in the request processing pipeline.

Method Summary

Modifier and Type	Method and Description
T	deserialize(java.lang.String serialized, int version) De-serializes the passed object serialized.
int	getVersion() Returns the version of this serializer.
java.lang.String	serialize(T toSerialize) Serializes the passed object toSerialize

Method Detail

getVersion

int getVersion()

Returns the version of this serializer.

Returns:

The version of this serializer.

serialize

java.lang.String serialize(T toSerialize)
                    throws ContextSerializationException

Serializes the passed object toSerialize

Parameters:

toSerialize - The object to serialize. This object will never be null

Returns:

The serialized string. The serialization will be deemed failed if the returned object is null and hence the callee will throw a ContextSerializationException upon receiving a null

Throws:

ContextSerializationException - If the serialization failed.

deserialize

T deserialize(java.lang.String serialized,
              int version)
       throws ContextSerializationException

De-serializes the passed object serialized.

Parameters:

serialized - The serialized object to de-serialize. This string will never be null

version - The version of the serializer as returned by getVersion() used to serialize the passed string.

Returns:

The de-serialized object. The de-serialization will be deemed failed if the returned object is null and hence the callee will throw a ContextSerializationException upon receiving a null

Throws:

ContextSerializationException - If the de-serialization failed.