membership/net.corda.v5.membership/GroupParameters

GroupParameters

interface GroupParameters : LayeredPropertyMap

This interface represents a set of group parameters under which all members of a group are expected to abide by. Parameters are stored as a LayeredPropertyMap and exposed via interface properties.

Note: any values in the group parameters values map need to be a.) serializable for P2P (AMQP) and checkpoints (Kryo) b.) comparable with .equals()

Example usages:

GroupParameters groupParameters = fullTransaction.getMembershipParameters();
int minimumPlatformVersion = groupParameters.getMinimumPlatformVersion();
Instant modifiedTime = groupParameters.getModifiedTime();
int epoch = groupParameters.getEpoch();
Collection<NotaryInfo> notaries = groupParameters.getNotaries();
Content copied to clipboard
val groupParameters = fullTransaction.membershipParameters
val minimumPlatformVersion = groupParameters?.minimumPlatformVersion
val modifiedTime = groupParameters?.modifiedTime
val epoch = groupParameters?.epoch
val notaries = groupParameters?.notaries
Content copied to clipboard

Functions

Link copied to clipboard
abstract operator fun get(key: String): String?
Link copied to clipboard
abstract fun <T> parse(key: String, clazz: Class<out T>): T
Link copied to clipboard
abstract fun <T> parseList(itemKeyPrefix: String, clazz: Class<out T>): List<T>
Link copied to clipboard
abstract fun <T> parseOrNull(key: String, clazz: Class<out T>): T?
Link copied to clipboard
abstract fun <T> parseSet(itemKeyPrefix: String, clazz: Class<out T>): Set<T>

Properties

Link copied to clipboard
abstract val entries: Set<Map.Entry<String, String?>>
Link copied to clipboard
abstract val epoch: Int

An Int representing the version of the group parameters. This is incremented on each modification to the group parameters.

Link copied to clipboard
abstract val minimumPlatformVersion: Int

The minimum platform version required to be running on in order to transact within a group.

Link copied to clipboard
abstract val modifiedTime: Instant

The Instant representing the last time the group parameters were modified.

Link copied to clipboard
abstract val notaries: Collection<NotaryInfo>

A collection of all available notary services in the group.