Class Serialization

  • All Implemented Interfaces:
    Extension

    public class Serialization
    extends java.lang.Object
    implements Extension
    Serialization module. Contains methods for serialization and deserialization as well as locating a Serializer for a particular class as defined in the mapping in the configuration.
    • Method Detail

      • currentTransportInformation

        public static scala.util.DynamicVariable<Serialization.Information> currentTransportInformation()
        INTERNAL API: This holds a reference to the current transport serialization information used for serializing local actor refs, or if serializer library e.g. custom serializer/deserializer in Jackson need access to the current ActorSystem.
        Returns:
        (undocumented)
      • serializedActorPath

        public static java.lang.String serializedActorPath​(ActorRef actorRef)
        The serialized path of an actorRef, based on the current transport serialization information. If there is no external address available in the given ActorRef then the systems default address will be used and that is retrieved from the ThreadLocal Serialization.Information that was set with withTransportInformation(scala.Function0<T>).
        Parameters:
        actorRef - (undocumented)
        Returns:
        (undocumented)
      • getCurrentTransportInformation

        public static Serialization.Information getCurrentTransportInformation()
        Gets the serialization information from a ThreadLocal that was assigned via withTransportInformation(scala.Function0<T>). The information is needed for serializing local actor refs, or if serializer library e.g. custom serializer/deserializer in Jackson need access to the current ActorSystem.

        Returns:
        (undocumented)
        Throws:
        java.lang.IllegalStateException - if the information was not set
      • AllowJavaSerialization

        public boolean AllowJavaSerialization()
      • serialize

        public scala.util.Try<byte[]> serialize​(java.lang.Object o)
        Serializes the given AnyRef/java.lang.Object according to the Serialization configuration to either an Array of Bytes or an Exception if one was thrown.
        Parameters:
        o - (undocumented)
        Returns:
        (undocumented)
      • deserialize

        public <T> scala.util.Try<T> deserialize​(byte[] bytes,
                                                 int serializerId,
                                                 scala.Option<java.lang.Class<? extends T>> clazz)
        Deserializes the given array of bytes using the specified serializer id, using the optional type hint to the Serializer. Returns either the resulting object or an Exception if one was thrown.
        Parameters:
        bytes - (undocumented)
        serializerId - (undocumented)
        clazz - (undocumented)
        Returns:
        (undocumented)
      • deserialize

        public scala.util.Try<java.lang.Object> deserialize​(byte[] bytes,
                                                            int serializerId,
                                                            java.lang.String manifest)
        Deserializes the given array of bytes using the specified serializer id, using the optional type hint to the Serializer. Returns either the resulting object or an Exception if one was thrown.
        Parameters:
        bytes - (undocumented)
        serializerId - (undocumented)
        manifest - (undocumented)
        Returns:
        (undocumented)
      • deserializeByteBuffer

        public java.lang.Object deserializeByteBuffer​(java.nio.ByteBuffer buf,
                                                      int serializerId,
                                                      java.lang.String manifest)
                                               throws java.io.NotSerializableException
        Deserializes the given ByteBuffer of bytes using the specified serializer id, using the optional type hint to the Serializer. Returns either the resulting object or throws an exception if deserialization fails.
        Parameters:
        buf - (undocumented)
        serializerId - (undocumented)
        manifest - (undocumented)
        Returns:
        (undocumented)
        Throws:
        java.io.NotSerializableException
      • deserialize

        public <T> scala.util.Try<T> deserialize​(byte[] bytes,
                                                 java.lang.Class<T> clazz)
        Deserializes the given array of bytes using the specified type to look up what Serializer should be used. Returns either the resulting object or an Exception if one was thrown.
        Parameters:
        bytes - (undocumented)
        clazz - (undocumented)
        Returns:
        (undocumented)
      • findSerializerFor

        public Serializer findSerializerFor​(java.lang.Object o)
        Returns the Serializer configured for the given object, returns the NullSerializer if it's null.

        Throws akka.ConfigurationException if no serialization-bindings is configured for the class of the object.

        Parameters:
        o - (undocumented)
        Returns:
        (undocumented)
      • serializerFor

        public Serializer serializerFor​(java.lang.Class<?> clazz)
                                 throws java.io.NotSerializableException
        Returns the configured Serializer for the given Class. The configured Serializer is used if the configured class isAssignableFrom from the clazz, i.e. the configured class is a super class or implemented interface. In case of ambiguity it is primarily using the most specific configured class, and secondly the entry configured first.

        Throws java.io.NotSerializableException if no serialization-bindings is configured for the class.

        Parameters:
        clazz - (undocumented)
        Returns:
        (undocumented)
        Throws:
        java.io.NotSerializableException
      • serializerOf

        public scala.util.Try<Serializer> serializerOf​(java.lang.String serializerFQN)
        Tries to load the specified Serializer by the fully-qualified name; the actual loading is performed by the system&rsquo;s DynamicAccess.
        Parameters:
        serializerFQN - (undocumented)
        Returns:
        (undocumented)
      • bindings

        public scala.collection.immutable.Seq<scala.Tuple2<java.lang.Class<?>,​Serializer>> bindings()
        bindings is a Seq of tuple representing the mapping from Class to Serializer. It is primarily ordered by the most specific classes first, and secondly in the configured order.
        Returns:
        (undocumented)
      • serializerByIdentity

        public scala.collection.immutable.Map<java.lang.Object,​Serializer> serializerByIdentity()
        Maps from a Serializer Identity (Int) to a Serializer instance (optimization)
        Returns:
        (undocumented)
      • shouldWarnAboutJavaSerializer

        public boolean shouldWarnAboutJavaSerializer​(java.lang.Class<?> serializedClass,
                                                     Serializer serializer)
        INTERNAL API
        Parameters:
        serializedClass - (undocumented)
        serializer - (undocumented)
        Returns:
        (undocumented)