Package net.corda.v5.membership

Interface GroupParameters

  • All Implemented Interfaces:
    net.corda.v5.base.types.LayeredPropertyMap 
    
public interface GroupParameters
 implements 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 are exposed by GET methods.

    Note that 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:

    • Java:
      
GroupParameters groupParameters = fullTransaction.getMembershipParameters();
Instant modifiedTime = groupParameters.getModifiedTime();
int epoch = groupParameters.getEpoch();
Collection<NotaryInfo> notaries = groupParameters.getNotaries();
    • Kotlin:
      
val groupParameters = fullTransaction.membershipParameters
val modifiedTime = groupParameters?.modifiedTime
val epoch = groupParameters?.epoch
val notaries = groupParameters?.notaries

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Instant getModifiedTime()
      abstract int getEpoch()
      abstract Collection<NotaryInfo> getNotaries()

      • Methods inherited from class net.corda.v5.base.types.LayeredPropertyMap

        get, getEntries, parse, parseList, parseOrNull, parseSet

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getModifiedTime

        @NotNull() abstract Instant getModifiedTime()
        Returns:

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

      • getEpoch

         abstract int getEpoch()
        Returns:

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