Packages

trait CantonConfig extends AnyRef

Root configuration parameters for a single Canton process.

Linear Supertypes
AnyRef, Any
Known Subclasses
CantonCommunityConfig, CantonEnterpriseConfig
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonConfig
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type DomainConfigType <: DomainConfig with ConfigDefaults[DefaultPorts, DomainConfigType]
  2. abstract type ParticipantConfigType <: LocalParticipantConfig with ConfigDefaults[DefaultPorts, ParticipantConfigType]

Abstract Value Members

  1. abstract def domains: Map[InstanceName, DomainConfigType]

    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

  2. abstract def dumpString: String

    dump config to string (without sensitive data)

  3. abstract def features: CantonFeatures

    control which features are enabled

  4. abstract def monitoring: MonitoringConfig

    determines how this Canton process can be monitored

  5. abstract def parameters: CantonParameters

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

  6. abstract def participants: Map[InstanceName, ParticipantConfigType]

    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

  7. abstract def remoteDomains: Map[InstanceName, RemoteDomainConfig]

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

  8. abstract def remoteParticipants: Map[InstanceName, RemoteParticipantConfig]

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

  9. abstract def validate: Validated[NonEmpty[Seq[String]], Unit]

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

Concrete 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. def domainsByString: Map[String, DomainConfigType]

    Use domains instead!

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mkPortDescription: String
    Attributes
    protected
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def nodeParametersFor[A](cachedNodeParameters: Map[InstanceName, A], kind: String, name: InstanceName): A
    Attributes
    protected
  15. def nodePortsDescription(nodeName: InstanceName, portDescriptions: Seq[String]): String
    Attributes
    protected
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def participantsByString: Map[String, ParticipantConfigType]

    Use participants instead!

  19. 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)

  20. def portDescriptionFromConfig[C](config: C)(apiNamesAndExtractors: Seq[(String, (C) => ServerConfig)]): Seq[String]
    Attributes
    protected
  21. def remoteDomainsByString: Map[String, RemoteDomainConfig]

    Use remoteDomains instead!

  22. def remoteParticipantsByString: Map[String, RemoteParticipantConfig]

    Use remoteParticipants instead!

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped