com.scalar.dl.ledger.model

Class ContractRegistrationRequest

java.lang.Object

com.scalar.dl.ledger.model.AbstractRequest

com.scalar.dl.ledger.model.ContractRegistrationRequest

@Immutable
public class ContractRegistrationRequest
extends AbstractRequest

A request for contract registration.

Constructor Summary

Constructors

Constructor and Description

ContractRegistrationRequest(java.lang.String contractId, java.lang.String contractBinaryName, byte[] contractByteCode, java.lang.String contractProperties, java.lang.String entityId, int keyVersion, byte[] signature) Constructs a ContractRegistrationRequest with the specified contract id, contract binary name, contract itself in byte-code format, entity ID, key version and signature of the request.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this object.
java.lang.String	getContractBinaryName() Returns the binary name of the contract.
byte[]	getContractByteCode() Returns the contract in byte-code format.
java.lang.String	getContractId() Returns the id of the contract.
java.util.Optional<java.lang.String>	getContractProperties() Returns the properties of the contract.
byte[]	getSignature() Returns the signature of the request.
int	hashCode() Returns a hash code value for the object.
static byte[]	serialize(java.lang.String contractId, java.lang.String contractBinaryName, byte[] contractByteCode, java.lang.String contractProperties, java.lang.String entityId, int keyVersion)
void	validateWith(com.scalar.dl.ledger.crypto.SignatureValidator validator) Validates if the request is not tampered.

Methods inherited from class com.scalar.dl.ledger.model.AbstractRequest

getEntityId, getKeyVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

ContractRegistrationRequest

public ContractRegistrationRequest(java.lang.String contractId,
                                   java.lang.String contractBinaryName,
                                   byte[] contractByteCode,
                                   @Nullable
                                   java.lang.String contractProperties,
                                   java.lang.String entityId,
                                   int keyVersion,
                                   byte[] signature)

Constructs a ContractRegistrationRequest with the specified contract id, contract binary name, contract itself in byte-code format, entity ID, key version and signature of the request.

Parameters:

contractId - an id of a registered contract to execute

contractBinaryName - a binary name of a registered contract to execute

contractByteCode - a contract itself in byte-code format

contractProperties - properties in json format

entityId - an entity ID

keyVersion - the version of a digital signature certificate or a HMAC secret key

signature - a signature of the request

Method Detail

getContractId

public java.lang.String getContractId()

Returns the id of the contract.

Returns:

the id of the contract

getContractBinaryName

public java.lang.String getContractBinaryName()

Returns the binary name of the contract.

Returns:

the binary name of the contract

getContractByteCode

public byte[] getContractByteCode()

Returns the contract in byte-code format.

Returns:

the contract in byte-code format

getContractProperties

public java.util.Optional<java.lang.String> getContractProperties()

Returns the properties of the contract.

Returns:

an Optional with the properties of the contract

getSignature

public byte[] getSignature()

Returns the signature of the request. The signature is either a HMAC signature or a digital signature.

Returns:

the signature of the request

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class AbstractRequest

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object o)

Indicates whether some other object is "equal to" this object. The other object is considered equal if it is the same instance or if:

• both super class instances are equal and
• it is also an ContractRegistrationRequest and
• both instances have the same items such as contract id, contract name, contract, and signatures.

Overrides:

equals in class AbstractRequest

Parameters:

o - an object to be tested for equality

Returns:

true if the other object is "equal to" this object otherwise false

validateWith

public void validateWith(com.scalar.dl.ledger.crypto.SignatureValidator validator)

Validates if the request is not tampered.

Specified by:

validateWith in class AbstractRequest

Parameters:

validator - a SignatureValidator

Throws:

com.scalar.dl.ledger.exception.SignatureException - if the request is invalid.

serialize

public static byte[] serialize(java.lang.String contractId,
                               java.lang.String contractBinaryName,
                               byte[] contractByteCode,
                               @Nullable
                               java.lang.String contractProperties,
                               java.lang.String entityId,
                               int keyVersion)