Class DefaultStringKeySerializer

  • All Implemented Interfaces:
    io.micronaut.core.serialize.ObjectSerializer

    public class DefaultStringKeySerializer
    extends java.lang.Object
    implements io.micronaut.core.serialize.ObjectSerializer

    The default key serializer used by caches that require serializing the keys as strings. Builds a key from the configured cache name and String conversion of the object as dictated by ConversionService.

    Note this implementation does not support deserialization

    Since:
    1.0
    • Field Summary

      • Fields inherited from interface io.micronaut.core.serialize.ObjectSerializer

        JDK
    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultStringKeySerializer​(java.lang.String cacheName, java.nio.charset.Charset charset, io.micronaut.core.convert.ConversionService<?> conversionService)
      Construct a default serializer for given parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T> java.util.Optional<T> deserialize​(java.io.InputStream inputStream, java.lang.Class<T> requiredType)  
      java.util.Optional<byte[]> serialize​(java.lang.Object object)  
      void serialize​(java.lang.Object object, java.io.OutputStream outputStream)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface io.micronaut.core.serialize.ObjectSerializer

        deserialize, deserialize, deserialize, deserialize
    • Constructor Detail

      • DefaultStringKeySerializer

        public DefaultStringKeySerializer​(java.lang.String cacheName,
                                          java.nio.charset.Charset charset,
                                          io.micronaut.core.convert.ConversionService<?> conversionService)
        Construct a default serializer for given parameters.
        Parameters:
        cacheName - The cache key or name
        charset - The charset used for serialization and de-serializing instance from the to/from cache
        conversionService - To convert value/object from the cache to String
    • Method Detail

      • serialize

        public java.util.Optional<byte[]> serialize​(java.lang.Object object)
                                             throws io.micronaut.core.serialize.exceptions.SerializationException
        Specified by:
        serialize in interface io.micronaut.core.serialize.ObjectSerializer
        Throws:
        io.micronaut.core.serialize.exceptions.SerializationException
      • serialize

        public void serialize​(java.lang.Object object,
                              java.io.OutputStream outputStream)
                       throws io.micronaut.core.serialize.exceptions.SerializationException
        Specified by:
        serialize in interface io.micronaut.core.serialize.ObjectSerializer
        Throws:
        io.micronaut.core.serialize.exceptions.SerializationException
      • deserialize

        public <T> java.util.Optional<T> deserialize​(java.io.InputStream inputStream,
                                                     java.lang.Class<T> requiredType)
                                              throws io.micronaut.core.serialize.exceptions.SerializationException
        Specified by:
        deserialize in interface io.micronaut.core.serialize.ObjectSerializer
        Throws:
        io.micronaut.core.serialize.exceptions.SerializationException