com.scalar.dl.ledger.contract

Class JacksonBasedContract

java.lang.Object

com.scalar.dl.ledger.contract.JacksonBasedContract

public abstract class JacksonBasedContract
extends java.lang.Object

A base contract using Jackson for the Ledger data, invoke method arguments, and invoke method return type. You can create your contracts based on it. It is recommended to use this class in most cases to balance development productivity and performance well.

Constructor Summary

Constructors

Constructor and Description
JacksonBasedContract()

Method Summary

Modifier and Type	Method and Description
CertificateEntry.Key	getCertificateKey() Deprecated.
ClientIdentityKey	getClientIdentityKey()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
abstract T	invoke(Ledger<T> ledger, T argument, T properties) Invokes the contract to Ledger with the specified argument and the pre-registered contract properties.
protected T	invoke(java.lang.String contractId, Ledger<T> ledger, T argument) Invokes the specified contract to Ledger with the specified argument.
boolean	isRoot()
protected void	setContext(T context) Sets a contract runtime context to pass it to functions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JacksonBasedContract

public JacksonBasedContract()

Method Detail

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

isRoot

public boolean isRoot()

getCertificateKey

@Deprecated
public CertificateEntry.Key getCertificateKey()

Deprecated.

This method will be deleted in 5.0.0. Note that, although it returns CertificateEntry.Key, but it returns the entity ID and key version of a certificate or HMAC secret key tied to the contract.

getClientIdentityKey

public ClientIdentityKey getClientIdentityKey()

setContext

protected void setContext(@Nullable
                          T context)

Sets a contract runtime context to pass it to functions. Setting a new context overwrites the previous one.

Parameters:

context - a contract runtime context

invoke

@Nullable
public abstract T invoke(Ledger<T> ledger,
                                   T argument,
                                   @Nullable
                                   T properties)

Invokes the contract to Ledger with the specified argument and the pre-registered contract properties. An implementation of the ContractBase should throw ContractContextException if it faces application-level contextual error (such as lack of balance in payment application).

Parameters:

ledger - tamper-evident ledger

argument - contract argument

properties - pre-registered contract properties

Returns:

json-formatted result

invoke

@Nullable
protected T invoke(java.lang.String contractId,
                             Ledger<T> ledger,
                             T argument)

Invokes the specified contract to Ledger with the specified argument.

Parameters:

contractId - another contract ID to invoke

ledger - tamper-evident ledger

argument - contract argument

Returns:

contract execution result