c

akka.serialization

SerializerWithStringManifest

abstract class SerializerWithStringManifest extends Serializer

A Serializer represents a bimap between an object and an array of bytes representing that object.

For serialization of data that need to evolve over time the SerializerWithStringManifest is recommended instead of Serializer because the manifest (type hint) is a String instead of a Class. That means that the class can be moved/removed and the serializer can still deserialize old data by matching on the String. This is especially useful for Akka Persistence.

The manifest string can also encode a version number that can be used in fromBinary to deserialize in different ways to migrate old data to new domain objects.

If the data was originally serialized with Serializer and in a later version of the system you change to SerializerWithStringManifest the manifest string will be the full class name if you used includeManifest=true, otherwise it will be the empty string.

Serializers are loaded using reflection during akka.actor.ActorSystem start-up, where two constructors are tried in order:

Be sure to always use the akka.actor.DynamicAccess for loading classes! This is necessary to avoid strange match errors and inequalities which arise from different class loaders loading the same class.

Source
Serializer.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SerializerWithStringManifest
  2. Serializer
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SerializerWithStringManifest()

Abstract Value Members

  1. abstract def fromBinary(bytes: Array[Byte], manifest: String): AnyRef

    Produces an object from an array of bytes, with an optional type-hint.

    Produces an object from an array of bytes, with an optional type-hint.

    It's recommended to throw java.io.NotSerializableException in fromBinary if the manifest is unknown. This makes it possible to introduce new message types and send them to nodes that don't know about them. This is typically needed when performing rolling upgrades, i.e. running a cluster with mixed versions for while. NotSerializableException is treated as a transient problem in the TCP based remoting layer. The problem will be logged and message is dropped. Other exceptions will tear down the TCP connection because it can be an indication of corrupt bytes from the underlying transport.

    Annotations
    @throws( classOf[NotSerializableException] )
  2. abstract def identifier: Int

    Completely unique value to identify this implementation of Serializer, used to optimize network traffic.

    Completely unique value to identify this implementation of Serializer, used to optimize network traffic. Values from 0 to 40 are reserved for Akka internal usage.

    Definition Classes
    SerializerWithStringManifestSerializer
  3. abstract def manifest(o: AnyRef): String

    Return the manifest (type hint) that will be provided in the fromBinary method.

    Return the manifest (type hint) that will be provided in the fromBinary method. Use "" if manifest is not needed.

  4. abstract def toBinary(o: AnyRef): Array[Byte]

    Serializes the given object into an Array of Byte

    Serializes the given object into an Array of Byte

    Definition Classes
    SerializerWithStringManifestSerializer

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to any2stringadd[SerializerWithStringManifest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SerializerWithStringManifest, B)
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to ArrowAssoc[SerializerWithStringManifest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (SerializerWithStringManifest) ⇒ Boolean, msg: ⇒ Any): SerializerWithStringManifest
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to Ensuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SerializerWithStringManifest) ⇒ Boolean): SerializerWithStringManifest
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to Ensuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): SerializerWithStringManifest
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to Ensuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SerializerWithStringManifest
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to Ensuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to StringFormat[SerializerWithStringManifest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def fromBinary(bytes: Array[Byte], manifest: Option[Class[_]]): AnyRef

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

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

    Definition Classes
    SerializerWithStringManifestSerializer
  17. final def fromBinary(bytes: Array[Byte], clazz: Class[_]): AnyRef

    Java API: deserialize with type hint

    Java API: deserialize with type hint

    Definition Classes
    Serializer
    Annotations
    @throws( classOf[NotSerializableException] )
  18. final def fromBinary(bytes: Array[Byte]): AnyRef

    Java API: deserialize without type hint

    Java API: deserialize without type hint

    Definition Classes
    Serializer
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def includeManifest: Boolean

    Returns whether this serializer needs a manifest in the fromBinary method

    Returns whether this serializer needs a manifest in the fromBinary method

    Definition Classes
    SerializerWithStringManifestSerializer
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  31. def [B](y: B): (SerializerWithStringManifest, B)
    Implicit
    This member is added by an implicit conversion from SerializerWithStringManifest to ArrowAssoc[SerializerWithStringManifest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializer

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SerializerWithStringManifest to any2stringadd[SerializerWithStringManifest]

Inherited by implicit conversion StringFormat from SerializerWithStringManifest to StringFormat[SerializerWithStringManifest]

Inherited by implicit conversion Ensuring from SerializerWithStringManifest to Ensuring[SerializerWithStringManifest]

Inherited by implicit conversion ArrowAssoc from SerializerWithStringManifest to ArrowAssoc[SerializerWithStringManifest]

Ungrouped