Package org.infinispan.commons.marshall

Interface AdvancedExternalizer<T>

All Superinterfaces:
Externalizer<T>, Serializable
All Known Subinterfaces:
LambdaExternalizer<T>
All Known Implementing Classes:
AbstractExternalizer, AdminFlagExternalizer, ByteBufferImpl.Externalizer, ImmutableListCopy.Externalizer, Immutables.ImmutableMapWrapperExternalizer, Immutables.ImmutableSetWrapperExternalizer, InstanceReusingAdvancedExternalizer, MurmurHash3.Externalizer, NoStateExternalizer, SingletonExternalizer, SuppliedExternalizer, WrappedByteArray.Externalizer
@Deprecated(forRemoval=true) public interface AdvancedExternalizer<T> extends Externalizer<T>
Deprecated, for removal: This API element is subject to removal in a future version.
since 10.0, will be removed in a future release. Please configure a SerializationContextInitializer and utilise ProtoStream annotations on Java objects instead, or specify a custom Marshaller implementation via the SerializationConfiguration.
AdvancedExternalizer provides an alternative way to provide externalizers for marshalling/unmarshalling user defined classes that overcome the deficiencies of the more user-friendly externalizer definition model explained in Externalizer. The first noticeable difference is that this method does not require user classes to be annotated in anyway, so it can be used with classes for which source code is not available or that cannot be modified. The bound between the externalizer and the classes that are marshalled/unmarshalled is set by providing an implementation for getTypeClasses() which should return the list of classes that this externalizer can marshall. Secondly, in order to save the maximum amount of space possible in the payloads generated, this externalizer method requires externalizer implementations to provide a positive identified via getId() implementations or via XML/programmatic configuration that identifies the externalizer when unmarshalling a payload. In order for this to work however, this externalizer method requires externalizers to be registered on cache manager creation time via XML or programmatic configuration. On the contrary, externalizers based on Externalizer and SerializeWith require no pre-registration whatsoever. Internally, Infinispan uses this advanced externalizer mechanism in order to marshall/unmarshall internal classes. Finally, AbstractExternalizer provides default implementations for some of the methods defined in this interface and so it's generally recommended that implementations extend that abstract class instead of implementing AdvancedExternalizer directly. Even though AdvancedExternalizer currently extends Serializable indirectly, there's no requirement for the advanced externalizer to be marshalled, because the pre-registration done on startup allows the marshaller to identify the externalizer from the given id.
Since:
5.0
Author:
Galder Zamarreño

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    USER_EXT_ID_MIN
    Deprecated, for removal: This API element is subject to removal in a future version.
    The minimum ID which will be respected by Infinispan for user specified AdvancedExternalizer implementations.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an integer that identifies the externalizer type.
    Set<Class<? extends T>>
    getTypeClasses()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a collection of Class instances representing the types that this AdvancedExternalizer can marshall.

    Methods inherited from interface org.infinispan.commons.marshall.Externalizer

    readObject, writeObject

  • Field Details

    • USER_EXT_ID_MIN

      static final int USER_EXT_ID_MIN
      Deprecated, for removal: This API element is subject to removal in a future version.
      The minimum ID which will be respected by Infinispan for user specified AdvancedExternalizer implementations.
      See Also:

  • Method Details

    • getTypeClasses

      Set<Class<? extends T>> getTypeClasses()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a collection of Class instances representing the types that this AdvancedExternalizer can marshall. Clearly, empty sets are not allowed. The externalizer framework currently requires all individual types to be listed since it does not make assumptions based on super classes or interfaces.
      Returns:
      A set containing the Class instances that can be marshalled.

    • getId

      Integer getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an integer that identifies the externalizer type. This is used at read time to figure out which AdvancedExternalizer should read the contents of the incoming buffer. Using a positive integer allows for very efficient variable length encoding of numbers, and it's much more efficient than shipping AdvancedExternalizer implementation class information around. Negative values are not allowed. Implementers of this interface can use any positive integer as long as it does not clash with any other identifier in the system. You can find information on the pre-assigned identifier ranges in here. It's highly recommended that maintaining of these identifiers is done in a centralized way and you can do so by making annotations reference a set of statically defined identifiers in a separate class or interface. Such class/interface gives a global view of the identifiers in use and so can make it easier to assign new ids. Implementors can optionally avoid giving a meaningful implementation to this method (i.e. return null) and instead rely on XML or programmatic configuration to provide the AdvancedExternalizer id. If no id can be determined via the implementation or XML/programmatic configuration, an error will be reported. If an id has been defined both via the implementation and XML/programmatic configuration, the value defined via XML/programmatic configuration will be used ignoring the other.
      Returns:
      A positive identifier for the AdvancedExternalizer.