com.scalar.dl.ledger.contract

Class ContractEntry

java.lang.Object

com.scalar.dl.ledger.contract.ContractEntry

@ThreadSafe
public class ContractEntry
extends java.lang.Object

A container for (the bytecode of) a registered contract and data about that contract. In addition to the contract, a ContractEntry will keep track of:

• the id of an entity who registered the contract
• a certificate version
• a contract id
• the binary name of the contract
• any corresponding properties of the contract
• the time in which the contract was registered
• the signature of the contract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContractEntry.Key A Key to associate a contract id with a ClientIdentityKey.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINARY_NAME
static java.lang.String	BYTE_CODE
static java.lang.String	ENTITY_ID
static java.lang.String	ID
static java.lang.String	KEY_VERSION
static java.lang.String	PROPERTIES
static java.lang.String	REGISTERED_AT
static java.lang.String	SIGNATURE

Constructor Summary

Constructors

Constructor and Description

ContractEntry(java.lang.String id, java.lang.String binaryName, java.lang.String entityId, int keyVersion, byte[] byteCode, java.lang.String properties, long registeredAt, byte[] signature) Constructs a ContractEntry with the specified contract id, contract binary name, entity id, certificate version, bytecode of the contract, properties of the contract, the time the contract was registered at, and the signature of the contract.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this object.
static ContractEntry	from(ContractRegistrationRequest request) Turns a ContractRegistrationRequest into a ContractEntry by adding a registered at time, and returns it.
java.lang.String	getBinaryName() Returns the binary name of the ContractEntry.
byte[]	getByteCode() Returns the bytecode of the contract contained in the ContractEntry.
ClientIdentityKey	getClientIdentityKey() Returns the ClientIdentityKey of the ContractEntry.
java.lang.String	getEntityId() Returns the entity id that holds the certificate of the ContractEntry.
java.lang.String	getId() Returns the id of the ContractEntry.
ContractEntry.Key	getKey() Returns the Key of the ContractEntry.
int	getKeyVersion() Returns the version of the certificate or the HMAC secret key of the ContractEntry.
java.util.Optional<java.lang.String>	getProperties() Returns the properties of the ContractEntry (may be empty).
long	getRegisteredAt() Returns the registered at time of the ContractEntry.
byte[]	getSignature() Returns the properties of the ContractEntry (may be empty).
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_ID

public static final java.lang.String ENTITY_ID

See Also:

Constant Field Values

KEY_VERSION

public static final java.lang.String KEY_VERSION

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

BINARY_NAME

public static final java.lang.String BINARY_NAME

See Also:

Constant Field Values

BYTE_CODE

public static final java.lang.String BYTE_CODE

See Also:

Constant Field Values

PROPERTIES

public static final java.lang.String PROPERTIES

See Also:

Constant Field Values

REGISTERED_AT

public static final java.lang.String REGISTERED_AT

See Also:

Constant Field Values

SIGNATURE

public static final java.lang.String SIGNATURE

See Also:

Constant Field Values

Constructor Detail

ContractEntry

public ContractEntry(java.lang.String id,
                     java.lang.String binaryName,
                     java.lang.String entityId,
                     int keyVersion,
                     byte[] byteCode,
                     @Nullable
                     java.lang.String properties,
                     long registeredAt,
                     byte[] signature)

Constructs a ContractEntry with the specified contract id, contract binary name, entity id, certificate version, bytecode of the contract, properties of the contract, the time the contract was registered at, and the signature of the contract.

Parameters:

id - a contract id

binaryName - a binary name of the contract

entityId - an entity id

keyVersion - a certificate version

byteCode - bytecode of the contract

properties - properties of the contract

registeredAt - the time the contract was registered

signature - the signature of the contract

Method Detail

getKey

public ContractEntry.Key getKey()

Returns the Key of the ContractEntry. A Key is made up of the contract id and a CertificateEntry.Key.

Returns:

the Key of the ContractEntry

getClientIdentityKey

public ClientIdentityKey getClientIdentityKey()

Returns the ClientIdentityKey of the ContractEntry. The ClientIdentityKey is made up of the entity id and version.

Returns:

the ClientIdentityKey of the ContractEntry

getId

public java.lang.String getId()

Returns the id of the ContractEntry.

Returns:

the id of the ContractEntry

getBinaryName

public java.lang.String getBinaryName()

Returns the binary name of the ContractEntry.

Returns:

the binary name of the ContractEntry

getEntityId

public java.lang.String getEntityId()

Returns the entity id that holds the certificate of the ContractEntry.

Returns:

the entity id of the ContractEntry

getKeyVersion

public int getKeyVersion()

Returns the version of the certificate or the HMAC secret key of the ContractEntry.

Returns:

the version of the certificate or the HMAC secret key of the ContractEntry

getByteCode

public byte[] getByteCode()

Returns the bytecode of the contract contained in the ContractEntry.

Returns:

the bytecode of the contract contained in the ContractEntry

getProperties

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

Returns the properties of the ContractEntry (may be empty).

Returns:

the properties of the ContractEntry

getRegisteredAt

public long getRegisteredAt()

Returns the registered at time of the ContractEntry.

Returns:

the registered at time of the ContractEntry

getSignature

public byte[] getSignature()

Returns the properties of the ContractEntry (may be empty).

Returns:

the properties of the ContractEntry

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

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 also an ContractEntry and both instances have the same

• id
• entity id
• key version
• contract bytecode
• contract properties
• registered at time
• signature

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to be tested for equality

Returns:

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

from

public static ContractEntry from(ContractRegistrationRequest request)

Turns a ContractRegistrationRequest into a ContractEntry by adding a registered at time, and returns it.

Parameters:

request - a ContractRegistrationRequest

Returns:

a ContractEntry