final case class CantonConfig(sequencers: Map[InstanceName, SequencerNodeConfig] = Map.empty, mediators: Map[InstanceName, MediatorNodeConfig] = Map.empty, participants: Map[InstanceName, ParticipantNodeConfig] = Map.empty, remoteSequencers: Map[InstanceName, RemoteSequencerConfig] = Map.empty, remoteMediators: Map[InstanceName, RemoteMediatorConfig] = Map.empty, remoteParticipants: Map[InstanceName, RemoteParticipantConfig] = Map.empty, monitoring: MonitoringConfig = MonitoringConfig(), parameters: CantonParameters = CantonParameters(), features: CantonFeatures = CantonFeatures()) extends UniformCantonConfigValidation with ConfigDefaults[DefaultPorts, CantonConfig] with Product with Serializable
Root configuration parameters for a single Canton process.
- sequencers
All locally running sequencers that this Canton process can connect and operate on.
- mediators
All locally running mediators that this Canton process can connect and operate on.
- participants
All locally running participants that this Canton process can connect and operate on.
- remoteSequencers
All remotely running sequencers that this Canton process can connect and operate on.
- remoteMediators
All remotely running mediators that this Canton process can connect and operate on.
- remoteParticipants
All remotely running participants to which the console can connect and operate on.
- monitoring
determines how this Canton process can be monitored
- parameters
per-environment parameters to control enabled features and set testing parameters
- features
control which features are enabled
- Alphabetic
- By Inheritance
- CantonConfig
- Serializable
- Product
- Equals
- ConfigDefaults
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CantonConfig(sequencers: Map[InstanceName, SequencerNodeConfig] = Map.empty, mediators: Map[InstanceName, MediatorNodeConfig] = Map.empty, participants: Map[InstanceName, ParticipantNodeConfig] = Map.empty, remoteSequencers: Map[InstanceName, RemoteSequencerConfig] = Map.empty, remoteMediators: Map[InstanceName, RemoteMediatorConfig] = Map.empty, remoteParticipants: Map[InstanceName, RemoteParticipantConfig] = Map.empty, monitoring: MonitoringConfig = MonitoringConfig(), parameters: CantonParameters = CantonParameters(), features: CantonFeatures = CantonFeatures())
- sequencers
All locally running sequencers that this Canton process can connect and operate on.
- mediators
All locally running mediators that this Canton process can connect and operate on.
- participants
All locally running participants that this Canton process can connect and operate on.
- remoteSequencers
All remotely running sequencers that this Canton process can connect and operate on.
- remoteMediators
All remotely running mediators that this Canton process can connect and operate on.
- remoteParticipants
All remotely running participants to which the console can connect and operate on.
- monitoring
determines how this Canton process can be monitored
- parameters
per-environment parameters to control enabled features and set testing parameters
- features
control which features are enabled
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allNodes: Map[InstanceName, LocalNodeConfig]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asSingleNode(instanceName: InstanceName): CantonConfig
reduces the configuration into a single node configuration (used for external testing)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]
Returns all validation errors that are specific to this Canton configuration class.
Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.
Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.
- Attributes
- protected
- Definition Classes
- UniformCantonConfigValidation → CustomCantonConfigValidation
- def dumpString: String
renders the config as a string (used for dumping config for diagnostic purposes)
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val features: CantonFeatures
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mediators: Map[InstanceName, MediatorNodeConfig]
- def mediatorsByString: Map[String, MediatorNodeConfig]
Use
mediatorsinstead! - def mergeDynamicChanges(newConfig: CantonConfig): CantonConfig
- val monitoring: MonitoringConfig
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nodeParametersFor[A](cachedNodeParameters: Map[InstanceName, A], kind: String, name: InstanceName): A
- Attributes
- protected
- def nodePortsDescription(nodeName: InstanceName, portDescriptions: Seq[String]): String
- Attributes
- protected
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val parameters: CantonParameters
- val participants: Map[InstanceName, ParticipantNodeConfig]
- def participantsByString: Map[String, ParticipantNodeConfig]
Use
participantsinstead! - 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)
- def portDescriptionFromConfig[C](config: C)(apiNamesAndExtractors: Seq[(String, (C) => ServerConfig)]): Seq[String]
- Attributes
- protected
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val remoteMediators: Map[InstanceName, RemoteMediatorConfig]
- def remoteMediatorsByString: Map[String, RemoteMediatorConfig]
Use
remoteMediatorsinstead! - val remoteParticipants: Map[InstanceName, RemoteParticipantConfig]
- def remoteParticipantsByString: Map[String, RemoteParticipantConfig]
Use
remoteParticipantsinstead! - val remoteSequencers: Map[InstanceName, RemoteSequencerConfig]
- def remoteSequencersByString: Map[String, RemoteSequencerConfig]
Use
remoteSequencersinstead! - val sequencers: Map[InstanceName, SequencerNodeConfig]
- def sequencersByString: Map[String, SequencerNodeConfig]
Use
sequencersinstead! - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(edition: CantonEdition): Validated[NonEmpty[Seq[String]], Unit]
run a validation on the current config and return possible warning messages
- final def validate[T >: CantonConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withDefaults(defaults: DefaultPorts, edition: CantonEdition): CantonConfig
Returns this configuration with defaults set for the given edition if necessary.
Returns this configuration with defaults set for the given edition if necessary.
- Definition Classes
- CantonConfig → ConfigDefaults