Packages

case class CantonCommunityConfig(domains: Map[InstanceName, CommunityDomainConfig] = Map.empty, participants: Map[InstanceName, CommunityParticipantConfig] = Map.empty, remoteDomains: Map[InstanceName, RemoteDomainConfig] = Map.empty, remoteParticipants: Map[InstanceName, RemoteParticipantConfig] = Map.empty, monitoring: MonitoringConfig = MonitoringConfig(), parameters: CantonParameters = CantonParameters(), features: CantonFeatures = CantonFeatures()) extends CantonConfig with ConfigDefaults[DefaultPorts, CantonCommunityConfig] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonCommunityConfig
  2. Serializable
  3. Product
  4. Equals
  5. ConfigDefaults
  6. CantonConfig
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CantonCommunityConfig(domains: Map[InstanceName, CommunityDomainConfig] = Map.empty, participants: Map[InstanceName, CommunityParticipantConfig] = Map.empty, remoteDomains: Map[InstanceName, RemoteDomainConfig] = Map.empty, remoteParticipants: Map[InstanceName, RemoteParticipantConfig] = Map.empty, monitoring: MonitoringConfig = MonitoringConfig(), parameters: CantonParameters = CantonParameters(), features: CantonFeatures = CantonFeatures())

Type Members

  1. type DomainConfigType = CommunityDomainConfig
    Definition Classes
    CantonCommunityConfigCantonConfig
  2. type ParticipantConfigType = CommunityParticipantConfig
    Definition Classes
    CantonCommunityConfigCantonConfig

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. val domains: Map[InstanceName, CommunityDomainConfig]

    all domains that this Canton process can operate

    all domains that this Canton process can operate

    domains are grouped by their alias, which is used to identify domains locally

    Definition Classes
    CantonCommunityConfigCantonConfig
  7. def domainsByString: Map[String, DomainConfigType]

    Use domains instead!

    Use domains instead!

    Definition Classes
    CantonConfig
  8. def dumpString: String

    renders the config as json (used for dumping config for diagnostic purposes)

    renders the config as json (used for dumping config for diagnostic purposes)

    Definition Classes
    CantonCommunityConfigCantonConfig
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val features: CantonFeatures

    control which features are enabled

    control which features are enabled

    Definition Classes
    CantonCommunityConfigCantonConfig
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def mkPortDescription: String
    Attributes
    protected
    Definition Classes
    CantonConfig
  14. val monitoring: MonitoringConfig

    determines how this Canton process can be monitored

    determines how this Canton process can be monitored

    Definition Classes
    CantonCommunityConfigCantonConfig
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def nodeParametersFor[A](cachedNodeParameters: Map[InstanceName, A], kind: String, name: InstanceName): A
    Attributes
    protected
    Definition Classes
    CantonConfig
  17. def nodePortsDescription(nodeName: InstanceName, portDescriptions: Seq[String]): String
    Attributes
    protected
    Definition Classes
    CantonConfig
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val parameters: CantonParameters

    per-environment parameters to control enabled features and set testing parameters

    per-environment parameters to control enabled features and set testing parameters

    Definition Classes
    CantonCommunityConfigCantonConfig
  21. val participants: Map[InstanceName, CommunityParticipantConfig]

    all participants that this Canton process can operate or connect to

    all participants that this Canton process can operate or connect to

    participants are grouped by their local name

    Definition Classes
    CantonCommunityConfigCantonConfig
  22. def participantsByString: Map[String, ParticipantConfigType]

    Use participants instead!

    Use participants instead!

    Definition Classes
    CantonConfig
  23. lazy val portDescription: String

    Produces a message in the structure "da:admin-api=1,public-api=2;participant1:admin-api=3,ledger-api=4".

    Produces a message in the structure "da:admin-api=1,public-api=2;participant1:admin-api=3,ledger-api=4". Helpful for diagnosing port already bound issues during tests. Allows any config value to be be null (can happen with invalid configs or config stubbed in tests)

    Definition Classes
    CantonConfig
  24. def portDescriptionFromConfig[C](config: C)(apiNamesAndExtractors: Seq[(String, (C) => ServerConfig)]): Seq[String]
    Attributes
    protected
    Definition Classes
    CantonConfig
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val remoteDomains: Map[InstanceName, RemoteDomainConfig]

    all remotely running domains to which the console can connect and operate on

    all remotely running domains to which the console can connect and operate on

    Definition Classes
    CantonCommunityConfigCantonConfig
  27. def remoteDomainsByString: Map[String, RemoteDomainConfig]

    Use remoteDomains instead!

    Use remoteDomains instead!

    Definition Classes
    CantonConfig
  28. val remoteParticipants: Map[InstanceName, RemoteParticipantConfig]

    all remotely running participants to which the console can connect and operate on

    all remotely running participants to which the console can connect and operate on

    Definition Classes
    CantonCommunityConfigCantonConfig
  29. def remoteParticipantsByString: Map[String, RemoteParticipantConfig]

    Use remoteParticipants instead!

    Use remoteParticipants instead!

    Definition Classes
    CantonConfig
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def validate: Validated[NonEmpty[Seq[String]], Unit]

    run a validation on the current config and return possible warning messages

    run a validation on the current config and return possible warning messages

    Definition Classes
    CantonCommunityConfigCantonConfig
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. def withDefaults(ports: DefaultPorts): CantonCommunityConfig

    Returns this configuration with defaults set if necessary.

    Returns this configuration with defaults set if necessary.

    Definition Classes
    CantonCommunityConfigConfigDefaults

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CantonConfig

Inherited from AnyRef

Inherited from Any

Ungrouped