com.netflix.server.context

Interface DirectionAwareContextSerializer<T>

All Superinterfaces:

ContextSerializer<T>

All Known Implementing Classes:

DirectionAwareSerializerAdapter

public interface DirectionAwareContextSerializer<T>
extends ContextSerializer<T>

A replacement for ContextSerializer for BiDirectional contexts that requires information about the direction of flow (i.e. request or response). For legacy reasons, this class extends ContextSerializer, the easier way to implement a direction aware serializer will be to extend DirectionAwareSerializerAdapter which provides a default implementation of the methods in ContextSerializer

Directions

Directions carry different meanings when associated with serialization type. Infact its usually the opposite for serialization and de-serialization. Following is the definition:

DirectionAwareContextSerializer.Direction.Inbound

Serialization: Serializing for adding to the response. De-serialization: De-serializing for reading the request.

DirectionAwareContextSerializer.Direction.Outbound

Serialization: Serializing for adding to the request. De-serialization: De-serializing for reading the response.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DirectionAwareContextSerializer.Direction Directions defined by this interface.

Method Summary

Modifier and Type	Method and Description
T	deserialize(java.lang.String serialized, DirectionAwareContextSerializer.Direction direction, int version) De-serializes the passed object serialized.
java.lang.String	serialize(T toSerialize, DirectionAwareContextSerializer.Direction direction) Serializes the passed object toSerialize

Methods inherited from interface com.netflix.server.context.ContextSerializer

deserialize, getVersion, serialize

Method Detail

serialize

java.lang.String serialize(T toSerialize,
                           DirectionAwareContextSerializer.Direction direction)
                    throws ContextSerializationException

Serializes the passed object toSerialize

Parameters:

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

direction - Direction of message flow. See DirectionAwareContextSerializer for definitions.

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.

See Also:

DirectionAwareContextSerializer

deserialize

T deserialize(java.lang.String serialized,
              DirectionAwareContextSerializer.Direction direction,
              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 ContextSerializer.getVersion() used to serialize the passed string.

direction - Direction of message flow. See DirectionAwareContextSerializer for definitions.

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.

See Also:

DirectionAwareContextSerializer