Package akka.remote.serialization

Class ProtobufSerializer

java.lang.Object

akka.remote.serialization.ProtobufSerializer

All Implemented Interfaces:

BaseSerializer, Serializer

public class ProtobufSerializer
extends java.lang.Object
implements BaseSerializer

Using the serialization-bindings as source for the whitelist. Note that the intended usage of serialization-bindings is for lookup of serializer when serializing (toBinary). For deserialization (fromBinary) the serializer-id is used for selecting serializer. Here we use serialization-bindings also when deserializing (fromBinary) to check that the manifest class is of a known (registered) type.

If an old class is removed from serialization-bindings when it's not used for serialization but still used for deserialization (e.g. rolling update with serialization changes) it can be allowed by specifying in akka.protobuf.whitelist-class.

That is also possible when changing a binding from a ProtobufSerializer to another serializer (e.g. Jackson) and still bind with the same class (interface).

Constructor Summary

Constructors

Constructor	Description
ProtobufSerializer(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method	Description
protected void	akka$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)
static ActorRef	deserializeActorRef(ExtendedActorSystem system, WireFormats.ActorRefData refProtocol)	Helper to materialize (lookup) an ActorRef from Akka's protobuf representation in the supplied ActorSystem.
java.lang.Object	fromBinary(byte[] bytes, scala.Option<java.lang.Class<?>> manifest)	Produces an object from an array of bytes, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.
int	identifier()	Globally unique serialization identifier configured in the reference.conf.
boolean	includeManifest()	Returns whether this serializer needs a manifest in the fromBinary method
static WireFormats.ActorRefData	serializeActorRef(ActorRef ref)	Helper to serialize an ActorRef to Akka's protobuf representation.
ExtendedActorSystem	system()	Actor system which is required by most serializer implementations.
byte[]	toBinary(java.lang.Object obj)	Serializes the given object into an Array of Byte

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.serialization.BaseSerializer

identifierFromConfig, SerializationIdentifiers

Methods inherited from interface akka.serialization.Serializer

fromBinary, fromBinary

Constructor Detail

ProtobufSerializer

public ProtobufSerializer(ExtendedActorSystem system)

Method Detail

serializeActorRef

public static WireFormats.ActorRefData serializeActorRef(ActorRef ref)

Helper to serialize an ActorRef to Akka's protobuf representation.

Parameters:

ref - (undocumented)

Returns:

(undocumented)

deserializeActorRef

public static ActorRef deserializeActorRef(ExtendedActorSystem system,
                                           WireFormats.ActorRefData refProtocol)

Helper to materialize (lookup) an ActorRef from Akka's protobuf representation in the supplied ActorSystem.

Parameters:

system - (undocumented)

refProtocol - (undocumented)

Returns:

(undocumented)

identifier

public int identifier()

Description copied from interface: BaseSerializer

Globally unique serialization identifier configured in the reference.conf.

See Serializer.identifier().

Specified by:

identifier in interface BaseSerializer

Specified by:

identifier in interface Serializer

Returns:

(undocumented)

akka$serialization$BaseSerializer$_setter_$identifier_$eq

protected void akka$serialization$BaseSerializer$_setter_$identifier_$eq(int x$1)

Specified by:

akka$serialization$BaseSerializer$_setter_$identifier_$eq in interface BaseSerializer

system

public ExtendedActorSystem system()

Description copied from interface: BaseSerializer

Actor system which is required by most serializer implementations.

Specified by:

system in interface BaseSerializer

Returns:

(undocumented)

includeManifest

public boolean includeManifest()

Description copied from interface: Serializer

Returns whether this serializer needs a manifest in the fromBinary method

Specified by:

includeManifest in interface Serializer

Returns:

(undocumented)

fromBinary

public java.lang.Object fromBinary(byte[] bytes,
                                   scala.Option<java.lang.Class<?>> manifest)

Description copied from interface: Serializer

Produces an object from an array of bytes, with an optional type-hint; the class should be loaded using ActorSystem.dynamicAccess.

Specified by:

fromBinary in interface Serializer

Parameters:

bytes - (undocumented)

manifest - (undocumented)

Returns:

(undocumented)

toBinary

public byte[] toBinary(java.lang.Object obj)

Description copied from interface: Serializer

Serializes the given object into an Array of Byte

Specified by:

toBinary in interface Serializer

Parameters:

obj - (undocumented)

Returns:

(undocumented)