corda / net.corda.core.serialization

Package net.corda.core.serialization

Supporting data types and classes for serialization of Corda data types.

Types

ClassWhitelist

interface ClassWhitelist

ObjectWithCompatibleContext

data class ObjectWithCompatibleContext<out T : Any>

SerializationContext

interface SerializationContext

Parameters to serialization and deserialization.

SerializationCustomSerializer

interface SerializationCustomSerializer<OBJ, PROXY>

Allows CorDapps to provide custom serializers for third party libraries where those libraries cannot be recompiled with the -parameters flag rendering their classes natively serializable by Corda. In this case a proxy serializer can be written that extends this type whose purpose is to move between those an unserializable types and an intermediate representation.

SerializationDefaults

object SerializationDefaults

Global singletons to be used as defaults that are injected elsewhere (generally, in the node or in RPC client).

SerializationFactory

abstract class SerializationFactory

An abstraction for serializing and deserializing objects, with support for versioning of the wire format via a header / prefix in the bytes.

SerializationToken

interface SerializationToken

This represents a token in the serialized stream for an instance of a type that implements SerializeAsToken.

SerializationWhitelist

interface SerializationWhitelist

Provide a subclass of this via the java.util.ServiceLoader mechanism to be able to whitelist types for serialisation that you cannot otherwise annotate. The name of the class must appear in a text file on the classpath under the path META-INF/services/net.corda.core.serialization.SerializationWhitelist

SerializeAsToken

interface SerializeAsToken

This interface should be implemented by classes that want to substitute a token representation of themselves if they are serialized because they have a lot of internal state that does not serialize (well).

SerializeAsTokenContext

interface SerializeAsTokenContext

A context for mapping SerializationTokens to/from SerializeAsTokens.

SerializedBytes

class SerializedBytes<T : Any> : OpaqueBytes

A type safe wrapper around a byte array that contains a serialised object. You can call SerializedBytes.deserialize to get the original object back.

SingletonSerializationToken

class SingletonSerializationToken : SerializationToken

A class representing a SerializationToken for some object that is not serializable but can be looked up (when deserialized) via just the class name.

SingletonSerializeAsToken

abstract class SingletonSerializeAsToken : SerializeAsToken

A base class for implementing large objects / components / services that need to serialize themselves to a string token to indicate which instance the token is a serialized form of.

Annotations

ConstructorForDeserialization

annotation class ConstructorForDeserialization

Annotation indicating a constructor to be used to reconstruct instances of a class during deserialization.

CordaSerializable

annotation class CordaSerializable

This annotation is a marker to indicate that a class is permitted and intended to be serialized as part of Node messaging.

CordaSerializationTransformEnumDefault

annotation class CordaSerializationTransformEnumDefault

This annotation is used to mark an enumerated type as having had a new constant appended to it. For each additional constant added a new annotation should be appended to the class. If more than one is required the wrapper annotation CordaSerializationTransformEnumDefaults should be used to encapsulate them

CordaSerializationTransformEnumDefaults

annotation class CordaSerializationTransformEnumDefaults

This annotation is used to mark an enumerated type as having had multiple members added, It acts as a container annotation for instances of CordaSerializationTransformEnumDefault, each of which details individual additions.

CordaSerializationTransformRename

annotation class CordaSerializationTransformRename

This annotation is used to mark a class has having had a property element. It is used by the AMQP deserializer to allow instances with different versions of the class on their Class Path to successfully deserialize the object.

CordaSerializationTransformRenames

annotation class CordaSerializationTransformRenames

This annotation is used to mark a class as having had multiple elements renamed as a container annotation for instances of CordaSerializationTransformRename, each of which details an individual rename.

DeprecatedConstructorForDeserialization

annotation class DeprecatedConstructorForDeserialization

This annotation is a marker to indicate which secondary constructors should be considered, and in which order, for evolving objects during their deserialization.

Exceptions

MissingAttachmentsException

class MissingAttachmentsException : CordaException

Thrown during deserialization to indicate that an attachment needed to construct the WireTransaction is not found.

Type Aliases

VersionHeader

typealias VersionHeader = ByteSequence

Extensions for External Classes

java.sql.Blob

kotlin.ByteArray

Functions

deserialize

fun <T : Any> ByteSequence.deserialize(serializationFactory: SerializationFactory = SerializationFactory.defaultFactory, context: SerializationContext = serializationFactory.defaultContext): T

Convenience extension method for deserializing a ByteSequence, utilising the defaults.

fun <T : Any> SerializedBytes<T>.deserialize(serializationFactory: SerializationFactory = SerializationFactory.defaultFactory, context: SerializationContext = serializationFactory.defaultContext): T

Convenience extension method for deserializing SerializedBytes with type matching, utilising the defaults.

deserializeWithCompatibleContext

fun <T : Any> ByteSequence.deserializeWithCompatibleContext(serializationFactory: SerializationFactory = SerializationFactory.defaultFactory, context: SerializationContext = serializationFactory.defaultContext): ObjectWithCompatibleContext<T>

Additionally returns SerializationContext which was used for encoding. It might be helpful to know SerializationContext to use the same encoding in the reply.

serialize

fun <T : Any> T.serialize(serializationFactory: SerializationFactory = SerializationFactory.defaultFactory, context: SerializationContext = serializationFactory.defaultContext): SerializedBytes<T>

Convenience extension method for serializing an object of type T, utilising the defaults.