c

com.digitalasset.canton.console.commands

TopologyAdministrationGroup

class TopologyAdministrationGroup extends ConsoleCommandGroup with Helpful with FeatureFlagFilter

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologyAdministrationGroup
  2. ConsoleCommandGroup
  3. FeatureFlagFilter
  4. NamedLogging
  5. Helpful
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TopologyAdministrationGroup(instance: InstanceReference, topologyQueueStatus: => Option[TopologyQueueStatus], consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  6. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. val consoleEnvironment: ConsoleEnvironment
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  12. implicit lazy val executionContext: ExecutionContext
    Attributes
    protected[canton]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  16. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  17. def init_id(identifier: String, namespace: String = "", delegations: Seq[GenericSignedTopologyTransaction] = Seq.empty, delegationFiles: Seq[String] = Seq.empty, waitForReady: Boolean = true): Unit
    Annotations
    @Summary(s = "Initialize the node with a unique identifier", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Every node in Canton is identified using a unique identifier, which is composed
    |of a user-chosen string and the fingerprint of a signing key. The signing key is the root key
    |defining a so-called namespace, where the signing key has the ultimate control over
    |issuing new identifiers.
    |During initialisation, we have to pick such a unique identifier.
    |By default, initialisation happens automatically, but it can be changed to either initialize
    |manually or to read a set of identities and certificates from a file.
    |
    |Automatic node initialisation is usually turned off to preserve the identity of a participant or synchronizer
    |node (during major version upgrades) or if the root namespace key of the node is
    |kept offline.
    |
    |If known, the namespace can be set to verify that it matches the root certificate.
    |Otherwise it will be read from the delegation.
    |
    |Optionally, a set of delegations can be provided if the root namespace key is not available.
    |These delegations can be either in files or passed as objects. Their version needs to match the
    |necessary protocol version of the synchronizers we are going to connect to.
    |"""
    )
  18. def init_id_from_uid(identifier: UniqueIdentifier, delegations: Seq[GenericSignedTopologyTransaction] = Seq.empty, delegationFiles: Seq[String] = Seq.empty, waitForReady: Boolean = true): Unit
    Annotations
    @Summary(s = "Initialize the node with a unique identifier", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Every node in Canton is identified using a unique identifier, which is composed
    |of a user-chosen string and the fingerprint of a signing key. The signing key is the root key
    |defining a so-called namespace, where the signing key has the ultimate control over
    |issuing new identifiers.
    |During initialisation, we have to pick such a unique identifier.
    |By default, initialisation happens automatically, but it can be changed to either initialize
    |manually or to read a set of identities and delegations from a file.
    |
    |Automatic node initialisation is usually turned off to preserve the identity of a participant or synchronizer
    |node (during major version upgrades) or if the root namespace key of the node is
    |kept offline.
    |
    |Optionally, a set of delegations can be provided if the root namespace key is not available.
    |These delegations can be either in files or passed as objects. Their version needs to match the
    |necessary protocol version of the synchronizers we are going to connect to.
    |"""
    )
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
  22. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. val runner: AdminCommandRunner
    Attributes
    protected
    Definition Classes
    TopologyAdministrationGroupConsoleCommandGroup
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. object decentralized_namespaces extends Helpful
    Annotations
    @Summary(s = "Manage decentralized namespaces", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Decentralized namespaces")
  34. object mediators extends Helpful
    Annotations
    @Summary(s = "Inspect mediator synchronizer state", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Mediator Synchronizer State")
  35. object namespace_delegations extends Helpful
    Annotations
    @Summary(s = "Manage namespace delegations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Namespace delegations")
  36. object owner_to_key_mappings extends Helpful
    Annotations
    @Summary(s = "Manage owner to key mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Owner to key mappings")
  37. object participant_synchronizer_permissions extends Helpful
    Annotations
    @Summary(s = "Inspect participant synchronizer permissions", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participant Synchronizer Permissions")
  38. object participant_synchronizer_states extends Helpful
    Annotations
    @Summary(s = "Inspect participant synchronizer states", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participant Synchronizer States")
  39. object party_hosting_limits extends Helpful
    Annotations
    @Summary(s = "Manage party hosting limits", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party hosting limits")
  40. object party_to_key_mappings extends Helpful
    Annotations
    @Summary(s = "Manage party to key mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party to key mappings")
  41. object party_to_participant_mappings extends Helpful
    Annotations
    @Summary(s = "Manage party to participant mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party to participant mappings")
  42. object sequencers extends Helpful
    Annotations
    @Summary(s = "Inspect sequencer synchronizer state", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Sequencer Synchronizer State")
  43. object stores extends Helpful
    Annotations
    @Summary(s = "Inspect topology stores", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Topology stores")
  44. object synchronisation
    Annotations
    @Summary(s = "Topology synchronisation helpers", flag = FeatureFlag.Preview) @Group(name = "Synchronisation Helpers")
  45. object synchronizer_bootstrap
  46. object synchronizer_parameters extends Helpful
    Annotations
    @Summary(s = "Manage synchronizer parameters state", flag = FeatureFlag.Preview) @Group(name = "Synchronizer Parameters State")
  47. object synchronizer_trust_certificates extends Helpful
    Annotations
    @Summary(s = "Manage synchronizer trust certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Synchronizer trust certificates")
  48. object transactions
    Annotations
    @Summary(s = "Inspect all topology transactions at once", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "All Transactions")
  49. object vetted_packages extends Helpful
    Annotations
    @Summary(s = "Manage package vettings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Vetted Packages")

Deprecated Value Members

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

    (Since version 9)

Inherited from ConsoleCommandGroup

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped