corda / net.corda.jackson / JacksonSupport

JacksonSupport

object 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.

Types

AmountDeserializer object AmountDeserializer : JsonDeserializer<Amount<*>>
AmountSerializer object AmountSerializer : JsonSerializer<Amount<*>>
AnonymousPartyDeserializer object AnonymousPartyDeserializer : JsonDeserializer<AnonymousParty>
AnonymousPartySerializer object AnonymousPartySerializer : JsonSerializer<AnonymousParty>
CalendarDeserializer object CalendarDeserializer : JsonDeserializer<BusinessCalendar>
CompositeKeyDeserializer object CompositeKeyDeserializer : JsonDeserializer<CompositeKey>
CompositeKeySerializer object CompositeKeySerializer : JsonSerializer<CompositeKey>
IdentityObjectMapper class IdentityObjectMapper : PartyObjectMapper, ObjectMapper
NoPartyObjectMapper class NoPartyObjectMapper : PartyObjectMapper, ObjectMapper
NodeInfoDeserializer object NodeInfoDeserializer : JsonDeserializer<NodeInfo>
NodeInfoSerializer object NodeInfoSerializer : JsonSerializer<NodeInfo>
OpaqueBytesDeserializer object OpaqueBytesDeserializer : JsonDeserializer<OpaqueBytes>
OpaqueBytesSerializer object OpaqueBytesSerializer : JsonSerializer<OpaqueBytes>
PartyDeserializer object PartyDeserializer : JsonDeserializer<Party>
PartyObjectMapper interface PartyObjectMapper
PartySerializer object PartySerializer : JsonSerializer<Party>
PublicKeyDeserializer object PublicKeyDeserializer : JsonDeserializer<EdDSAPublicKey>
PublicKeySerializer object PublicKeySerializer : JsonSerializer<EdDSAPublicKey>
RpcObjectMapper class RpcObjectMapper : PartyObjectMapper, ObjectMapper
SecureHashDeserializer class SecureHashDeserializer<T : SecureHash> : JsonDeserializer<T>

Implemented as a class so that we can instantiate for T.

SecureHashSerializer object SecureHashSerializer : JsonSerializer<SecureHash>
ToStringSerializer object ToStringSerializer : JsonSerializer<Any>

Properties

cordaModule val cordaModule: Module

Functions

createDefaultMapper fun createDefaultMapper(rpc: CordaRPCOps, factory: JsonFactory = JsonFactory()): ObjectMapper

Mapper requiring RPC support to deserialise parties from names

createInMemoryMapper fun createInMemoryMapper(identityService: IdentityService, factory: JsonFactory = JsonFactory()): ObjectMapper

For testing with an in memory identity service

createNonRpcMapper fun createNonRpcMapper(factory: JsonFactory = JsonFactory()): ObjectMapper

For testing or situations where deserialising parties is not required