docs/net.corda.core.serialization.internal

Package-level declarations

Types

class AttachmentsClassLoader(attachments: List<Attachment>, val params: NetworkParameters, sampleTxId: SecureHash, isAttachmentTrusted: (Attachment) -> Boolean, parent: ClassLoader = ClassLoader.getSystemClassLoader()) : URLClassLoader

A custom ClassLoader that knows how to load classes from a set of attachments. The attachments themselves only need to provide JAR streams, and so could be fetched from a database, local disk, etc. Constructing an AttachmentsClassLoader is somewhat expensive, as every attachment is scanned to ensure that there are no overlapping file paths. In addition, every JAR is scanned to ensure that it doesn't violate the package namespace ownership rules.

AttachmentsClassLoaderBuilder

@VisibleForTesting

object AttachmentsClassLoaderBuilder

This is just a factory that provides caches to optimise expensive construction/loading of classloaders, serializers, whitelisted classes.

AttachmentsClassLoaderCache

interface AttachmentsClassLoaderCache

AttachmentsClassLoaderCacheImpl

class AttachmentsClassLoaderCacheImpl(cacheFactory: NamedCacheFactory) : SingletonSerializeAsToken, AttachmentsClassLoaderCache

AttachmentsClassLoaderKey

data class AttachmentsClassLoaderKey(val hashes: Set<SecureHash>, val params: NetworkParameters)

AttachmentsClassLoaderSimpleCacheImpl

class AttachmentsClassLoaderSimpleCacheImpl(cacheSize: Int) : AttachmentsClassLoaderCache

AttachmentsHolder

interface AttachmentsHolder

AttachmentURLStreamHandlerFactory

object AttachmentURLStreamHandlerFactory : URLStreamHandlerFactory

Registers a new internal "attachment" protocol. This will not be exposed as an API.

CheckpointSerializationContext

@DoNotImplement

interface CheckpointSerializationContext

Parameters to checkpoint serialization and deserialization.

CheckpointSerializationDefaults

object CheckpointSerializationDefaults

CheckpointSerializer

@DoNotImplement

interface CheckpointSerializer

CustomSerializationSchemeUtils

class CustomSerializationSchemeUtils

MissingSerializerException

open class MissingSerializerException : NotSerializableException

Thrown by the serialization framework, probably indicating that a custom serializer needs to be included in a transaction.

SerializationEnvironment

interface SerializationEnvironment

Properties

_allEnabledSerializationEnvs

val _allEnabledSerializationEnvs: List<<Error class: unknown class><String, SerializationEnvironment>>

_contextSerializationEnv

val _contextSerializationEnv: ThreadLocalToggleField<SerializationEnvironment>

_driverSerializationEnv

val _driverSerializationEnv: SimpleToggleField<SerializationEnvironment>

_inheritableContextSerializationEnv

val _inheritableContextSerializationEnv: InheritableThreadLocalToggleField<SerializationEnvironment>

_rpcClientSerializationEnv

val _rpcClientSerializationEnv: SimpleToggleField<SerializationEnvironment>

effectiveSerializationEnv

val effectiveSerializationEnv: SerializationEnvironment

nodeSerializationEnv

var nodeSerializationEnv: SerializationEnvironment?

Should be set once in main.

Functions

checkpointDeserialize

inline fun <T : Any> ByteArray.checkpointDeserialize(context: CheckpointSerializationContext = effectiveSerializationEnv.checkpointContext): T

Convenience extension method for deserializing a ByteArray, utilising the default factory.

inline fun <T : Any> SerializedBytes<T>.checkpointDeserialize(context: CheckpointSerializationContext = effectiveSerializationEnv.checkpointContext): T

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

inline fun <T : Any> ByteSequence.checkpointDeserialize(context: CheckpointSerializationContext = effectiveSerializationEnv.checkpointContext): T

checkpointSerialize

fun <T : Any> T.checkpointSerialize(context: CheckpointSerializationContext = effectiveSerializationEnv.checkpointContext): SerializedBytes<T>

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