net.corda.client.jackson

Class JacksonSupport

net.corda.client.jackson.JacksonSupport

public class JacksonSupport

Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for the java.time API, some core types, and Kotlin data classes.

Note that Jackson can also be used to serialise/deserialise other formats such as Yaml and XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JacksonSupport.AmountDeserializer Deprecated.
static class	JacksonSupport.AmountSerializer Deprecated.
static class	JacksonSupport.AnonymousPartyDeserializer Deprecated.
static class	JacksonSupport.AnonymousPartySerializer Deprecated.
static class	JacksonSupport.CordaX500NameDeserializer Deprecated.
static class	JacksonSupport.CordaX500NameSerializer Deprecated.
static class	JacksonSupport.IdentityObjectMapper Deprecated.
static class	JacksonSupport.NoPartyObjectMapper Deprecated.
static class	JacksonSupport.NodeInfoDeserializer Deprecated.
static class	JacksonSupport.NodeInfoSerializer Deprecated.
static class	JacksonSupport.OpaqueBytesDeserializer Deprecated.
static class	JacksonSupport.OpaqueBytesSerializer Deprecated.
static class	JacksonSupport.PartyDeserializer Deprecated.
static class	JacksonSupport.PartySerializer Deprecated.
static class	JacksonSupport.PublicKeyDeserializer Deprecated.
static class	JacksonSupport.PublicKeySerializer Deprecated.
static class	JacksonSupport.RpcObjectMapper Deprecated.
static class	JacksonSupport.SecureHashDeserializer<T extends SecureHash> Deprecated.
static class	JacksonSupport.SecureHashSerializer Deprecated.
static class	JacksonSupport.SignedTransactionMixin Deprecated.
static class	JacksonSupport.ToStringSerializer Deprecated.
static class	JacksonSupport.WireTransactionMixin Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static JacksonSupport	INSTANCE Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for the java.time API, some core types, and Kotlin data classes.

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultMapper(CordaRPCOps rpc, com.fasterxml.jackson.core.JsonFactory factory, boolean fuzzyIdentityMatch, boolean fullParties) Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultMapper(CordaRPCOps rpc, com.fasterxml.jackson.core.JsonFactory factory, boolean fuzzyIdentityMatch) Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultMapper(CordaRPCOps rpc, com.fasterxml.jackson.core.JsonFactory factory) Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultMapper(CordaRPCOps rpc) Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createInMemoryMapper(IdentityService identityService, com.fasterxml.jackson.core.JsonFactory factory, boolean fuzzyIdentityMatch, boolean fullParties) Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createInMemoryMapper(IdentityService identityService, com.fasterxml.jackson.core.JsonFactory factory, boolean fuzzyIdentityMatch) Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createInMemoryMapper(IdentityService identityService, com.fasterxml.jackson.core.JsonFactory factory) Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createInMemoryMapper(IdentityService identityService) Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.
static com.fasterxml.jackson.databind.ObjectMapper	createNonRpcMapper(com.fasterxml.jackson.core.JsonFactory factory, boolean fullParties) For testing or situations where deserialising parties is not required
static com.fasterxml.jackson.databind.ObjectMapper	createNonRpcMapper(com.fasterxml.jackson.core.JsonFactory factory) For testing or situations where deserialising parties is not required
static com.fasterxml.jackson.databind.ObjectMapper	createNonRpcMapper() For testing or situations where deserialising parties is not required
com.fasterxml.jackson.databind.Module	getCordaModule() Deprecated.

Field Detail

INSTANCE

public static JacksonSupport INSTANCE

Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for the java.time API, some core types, and Kotlin data classes.

Note that Jackson can also be used to serialise/deserialise other formats such as Yaml and XML.

Method Detail

getCordaModule

public com.fasterxml.jackson.databind.Module getCordaModule()

Deprecated.

createDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc,
                                                                              com.fasterxml.jackson.core.JsonFactory factory,
                                                                              boolean fuzzyIdentityMatch,
                                                                              boolean fullParties)

Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.

Parameters:

fuzzyIdentityMatch - If false, fields mapped to class Party objects must be in X.500 name form and precisely match an identity known from the network map. If true, the name is matched more leniently but if the match is ambiguous a JsonParseException is thrown.

fullParties - If true then class Party objects will be serialised as JSON objects, with the owning key serialised in addition to the name. For class PartyAndCertificate objects the cert path will be included.

createDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc,
                                                                              com.fasterxml.jackson.core.JsonFactory factory,
                                                                              boolean fuzzyIdentityMatch)

Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.

Parameters:

fuzzyIdentityMatch - If false, fields mapped to class Party objects must be in X.500 name form and precisely match an identity known from the network map. If true, the name is matched more leniently but if the match is ambiguous a JsonParseException is thrown.

createDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc,
                                                                              com.fasterxml.jackson.core.JsonFactory factory)

Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.

createDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc)

Creates a Jackson ObjectMapper that uses RPC to deserialise parties from string names.

createNonRpcMapper

public static com.fasterxml.jackson.databind.ObjectMapper createNonRpcMapper(com.fasterxml.jackson.core.JsonFactory factory,
                                                                             boolean fullParties)

For testing or situations where deserialising parties is not required

Parameters:

fullParties - If true then class Party objects will be serialised as JSON objects, with the owning key serialised in addition to the name. For class PartyAndCertificate objects the cert path will be included.

createNonRpcMapper

public static com.fasterxml.jackson.databind.ObjectMapper createNonRpcMapper(com.fasterxml.jackson.core.JsonFactory factory)

For testing or situations where deserialising parties is not required

createNonRpcMapper

public static com.fasterxml.jackson.databind.ObjectMapper createNonRpcMapper()

For testing or situations where deserialising parties is not required

createInMemoryMapper

public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService,
                                                                               com.fasterxml.jackson.core.JsonFactory factory,
                                                                               boolean fuzzyIdentityMatch,
                                                                               boolean fullParties)

Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.

Parameters:

fuzzyIdentityMatch - If false, fields mapped to class Party objects must be in X.500 name form and precisely match an identity known from the network map. If true, the name is matched more leniently but if the match is ambiguous a JsonParseException is thrown.

fullParties - If true then class Party objects will be serialised as JSON objects, with the owning key serialised in addition to the name. For class PartyAndCertificate objects the cert path will be included.

See Also:

interface IdentityService

createInMemoryMapper

public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService,
                                                                               com.fasterxml.jackson.core.JsonFactory factory,
                                                                               boolean fuzzyIdentityMatch)

Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.

Parameters:

fuzzyIdentityMatch - If false, fields mapped to class Party objects must be in X.500 name form and precisely match an identity known from the network map. If true, the name is matched more leniently but if the match is ambiguous a JsonParseException is thrown.

See Also:

interface IdentityService

createInMemoryMapper

public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService,
                                                                               com.fasterxml.jackson.core.JsonFactory factory)

Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.

See Also:

interface IdentityService

createInMemoryMapper

public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService)

Creates a Jackson ObjectMapper that uses an interface IdentityService directly inside the node to deserialise parties from string names.

See Also:

interface IdentityService