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 Pekko 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 pekko.actor.ActorSystem start-up, where two constructors are tried in order:
- taking exactly one argument of type pekko.actor.ExtendedActorSystem, and
- without arguments
Be sure to always use the pekko.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
- Alphabetic
- By Inheritance
- SerializerWithStringManifest
- Serializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SerializerWithStringManifest()
Abstract Value Members
- 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
infromBinary
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])
- 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 Pekko internal usage.
- Definition Classes
- SerializerWithStringManifest → Serializer
- 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. - 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.
Note that the array must not be mutated by the serializer after it has been returned.
- Definition Classes
- SerializerWithStringManifest → Serializer
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toany2stringadd[SerializerWithStringManifest] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SerializerWithStringManifest, B)
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toArrowAssoc[SerializerWithStringManifest] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (SerializerWithStringManifest) => Boolean, msg: => Any): SerializerWithStringManifest
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toEnsuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SerializerWithStringManifest) => Boolean): SerializerWithStringManifest
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toEnsuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SerializerWithStringManifest
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toEnsuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SerializerWithStringManifest
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toEnsuring[SerializerWithStringManifest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
- SerializerWithStringManifest → Serializer
- 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])
- final def fromBinary(bytes: Array[Byte]): AnyRef
Java API: deserialize without type hint
Java API: deserialize without type hint
- Definition Classes
- Serializer
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- SerializerWithStringManifest → Serializer
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toStringFormat[SerializerWithStringManifest] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (SerializerWithStringManifest, B)
- Implicit
- This member is added by an implicit conversion from SerializerWithStringManifest toArrowAssoc[SerializerWithStringManifest] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.