Corda provides a module that extends the popular Jackson serialisation engine. Jackson is often used to serialise to and from JSON, but also supports other formats such as YaML and XML. Jackson is itself very modular and has a variety of plugins that extend its functionality. You can learn more at the Jackson home page.
To gain support for JSON serialisation of common Corda data types, include a dependency on
in your Gradle or Maven build file.
Then you can obtain a Jackson
ObjectMapper instance configured for use using the
method. There are variants of this method for obtaining Jackson’s configured in other ways: if you have an RPC
connection to the node (see “Client RPC”) then your JSON mapper can resolve identities found in objects.
The API is described in detail here:
import net.corda.jackson.JacksonSupport val mapper = JacksonSupport.createNonRpcMapper() val json = mapper.writeValueAsString(myCordaState) // myCordaState can be any object.
import net.corda.jackson.JacksonSupport ObjectMapper mapper = JacksonSupport.createNonRpcMapper() String json = mapper.writeValueAsString(myCordaState) // myCordaState can be any object.
The way mappers interact with identity and RPC is likely to change in a future release.