Package com.couchbase.client.java.codec

Class JacksonJsonSerializer

java.lang.Object

com.couchbase.client.java.codec.JacksonJsonSerializer

All Implemented Interfaces:

JsonSerializer

public class JacksonJsonSerializer
extends Object
implements JsonSerializer

A serializer backed by a user-provided Jackson ObjectMapper.

In order to use this class you must add Jackson to your class path.

Make sure to register JsonValueModule with your ObjectMapper so it can handle Couchbase JsonObject instances.

Likewise, if you're using the Encrypted annotation for Couchbase Field-Level Encryption, make sure to register EncryptionModule.

Example usage without Couchbase Field-Level Encryption:

 ObjectMapper mapper = new ObjectMapper();
 mapper.registerModule(new JsonValueModule());

 ClusterEnvironment env = ClusterEnvironment.builder()
     .jsonSerializer(new JacksonJsonSerializer(mapper))
     .build();
 

Example usage with Couchbase Field-Level Encryption:

 CryptoManager cryptoManager = ...

 ObjectMapper mapper = new ObjectMapper();
 mapper.registerModule(new JsonValueModule());
 mapper.registerModule(new EncryptionModule(cryptoManager));

 ClusterEnvironment env = ClusterEnvironment.builder()
     .cryptoManager(cryptoManager)
     .jsonSerializer(new JacksonJsonSerializer(mapper))
     .build();
 

See Also:

JsonValueModule, EncryptionModule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JacksonJsonSerializer.PreflightCheckSubject

Method Summary

Modifier and Type	Method	Description
static JacksonJsonSerializer	create()	Returns a new instance backed by a default ObjectMapper without encryption support.
static JacksonJsonSerializer	create(CryptoManager cryptoManager)	Returns a new instance backed by a default ObjectMapper with optional encryption support.
static JacksonJsonSerializer	create(com.fasterxml.jackson.databind.ObjectMapper mapper)	Returns a new instance backed by the given ObjectMapper.
<T> T	deserialize(TypeRef<T> target, byte[] input)	Deserializes raw input into the target type.
<T> T	deserialize(Class<T> target, byte[] input)	Deserializes raw input into the target class.
static void	preflightCheck()	Throws something if the user-provided Jackson library is absent or broken.
byte[]	serialize(Object input)	Serializes the given input into its encoded byte array form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static JacksonJsonSerializer create(com.fasterxml.jackson.databind.ObjectMapper mapper)

Returns a new instance backed by the given ObjectMapper.

Parameters:

mapper - the custom ObjectMapper to use.

Returns:

the Jackson JSON serializer with a custom object mapper.

create

public static JacksonJsonSerializer create()

Returns a new instance backed by a default ObjectMapper without encryption support.

Returns:

the Jackson JSON serializer with the default object mapper.

create

public static JacksonJsonSerializer create(CryptoManager cryptoManager)

Returns a new instance backed by a default ObjectMapper with optional encryption support.

Parameters:

cryptoManager - (nullable) The manager to use for activating the Encrypted annotation, or null to disable encryption support.

Returns:

the Jackson JSON serializer with a provided crypto manager.

serialize

public byte[] serialize(Object input)

Description copied from interface: JsonSerializer

Serializes the given input into its encoded byte array form.

Specified by:

serialize in interface JsonSerializer

Parameters:

input - the object as input.

Returns:

the serialized output.

deserialize

public <T> T deserialize(Class<T> target,
                         byte[] input)

Description copied from interface: JsonSerializer

Deserializes raw input into the target class.

Specified by:

deserialize in interface JsonSerializer

Type Parameters:

T - the generic type to deserialize into.

Parameters:

target - the target class.

input - the raw input.

Returns:

the deserialized output.

deserialize

public <T> T deserialize(TypeRef<T> target,
                         byte[] input)

Description copied from interface: JsonSerializer

Deserializes raw input into the target type.

Specified by:

deserialize in interface JsonSerializer

Type Parameters:

T - the type to deserialize into.

Parameters:

target - the target type.

input - the raw input.

Returns:

the deserialized output.

preflightCheck

@Internal
public static void preflightCheck()
                           throws Throwable

Throws something if the user-provided Jackson library is absent or broken.

Throws:

Throwable - if JacksonJsonSerializer should not be used.

Implementation Note:

Looking for ObjectMapper on the class path is not sufficient; we've seen at least one case where ObjectMapper was present but its dependencies were missing.