Packages

c

com.digitalasset.canton.console

LocalDomainManagerReference

class LocalDomainManagerReference extends DomainManagerNodeReference with BaseInspection[DomainManagerNode] with LocalInstanceReference

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalDomainManagerReference
  2. LocalInstanceReference
  3. BaseInspection
  4. DomainManagerNodeReference
  5. SetupAdministration
  6. NoTracing
  7. SequencerConnectionAdministration
  8. DomainAdministration
  9. InstanceReference
  10. CertificateAdministration
  11. PrettyPrinting
  12. PrettyUtil
  13. ShowUtil
  14. ShowSyntax
  15. ToShowOps
  16. FeatureFlagFilter
  17. NamedLogging
  18. Helpful
  19. AdminCommandRunner
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LocalDomainManagerReference(consoleEnvironment: EnterpriseConsoleEnvironment, name: String)

Type Members

  1. type InstanceId = DomainId
  2. type Status = SimpleStatus
  3. class Setup extends Helpful
    Definition Classes
    SetupAdministration
  4. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  5. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  6. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  7. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  9. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  10. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  11. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  12. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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. def access[T](ops: (DomainManagerNode) => T): T
    Attributes
    protected[console]
    Definition Classes
    BaseInspection
  5. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  6. def adminCommand[Result](grpcCommand: GrpcAdminCommand[_, _, Result], httpCommand: HttpAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run an admin command and return its result.

    Run an admin command and return its result. Depending on the admin client config details, it will either run the GRPC or the HTTP admin command.

    Attributes
    protected[console]
    Definition Classes
    LocalInstanceReferenceAdminCommandRunner
  7. def adminCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run a GRPC admin command and return its result.

    Run a GRPC admin command and return its result. Most of the commands are only defined for the GRPC interface, so we default to showing an error message if the command is called for a node configured with an HTTP interface.

    Attributes
    protected[console]
    Definition Classes
    AdminCommandRunner
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  10. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  11. def clear_cache(): Unit
    Definition Classes
    InstanceReference
    Annotations
    @Summary(s = "Clear locally cached variables", flag = FeatureFlag.Testing) @Description(s = "Some commands cache values on the client side. Use this command to explicitly clear the caches of these values.")
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def config: DomainManagerConfig
    Definition Classes
    LocalDomainManagerReferenceLocalInstanceReference
    Annotations
    @Summary(s = "Returns the domain configuration", flag = console.this.Help.Summary.<init>$default$2)
  14. val consoleEnvironment: EnterpriseConsoleEnvironment
  15. def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    BaseInspection
  16. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(obj: Any): Boolean
    Definition Classes
    DomainManagerNodeReference → AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  22. def health: HealthAdministration[Status]
    Definition Classes
    DomainManagerNodeReferenceDomainAdministrationInstanceReference
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  23. 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"))
  24. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  25. def id: DomainId
    Definition Classes
    DomainManagerNodeReferenceDomainAdministrationInstanceReference
    Annotations
    @Summary(s = "Yields the globally unique id of this domain. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the domain has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  26. val instanceType: String
    Attributes
    protected
    Definition Classes
    DomainManagerNodeReferenceInstanceReference
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  29. def is_running: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  30. def keys: LocalKeyAdministrationGroup
    Definition Classes
    LocalInstanceReferenceInstanceReference
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DomainManagerNodeReferenceNamedLogging
  33. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  34. val name: String
  35. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. val nodes: Nodes[CantonNode, CantonNodeBootstrap[CantonNode]]
    Attributes
    protected
    Definition Classes
    LocalDomainManagerReferenceLocalInstanceReference
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  42. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  43. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  44. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  45. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  46. def parties: PartiesAdministrationGroup
    Definition Classes
    DomainManagerNodeReferenceInstanceReference
    Annotations
    @Summary(s = "Inspect configured parties", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Parties")
  47. def pretty: Pretty[InstanceReference]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    InstanceReferencePrettyPrinting
  48. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  49. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  50. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  51. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  52. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  53. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  54. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  55. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  56. def runningNode: Option[CantonNodeBootstrap[DomainManagerNode]]
    Attributes
    protected[console]
    Definition Classes
    LocalDomainManagerReferenceBaseInspection
  57. def setup: Setup
    Definition Classes
    SetupAdministration
    Annotations
    @Summary(s = "Set up onboarding of nodes", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Setup")
  58. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  59. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  60. def start(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  61. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  62. def stop(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  63. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  64. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  65. def timeouts: ConsoleCommandTimeout
    Attributes
    protected
    Definition Classes
    DomainAdministration
  66. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  67. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  68. def topology: TopologyAdministrationGroup
    Definition Classes
    DomainManagerNodeReferenceDomainAdministrationInstanceReference
    Annotations
    @Summary(s = "Topology management related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Topology") @Description(s = "This group contains access to the full set of topology management commands.")
  69. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  70. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  71. def underlying: Option[DomainManagerNode]
    Definition Classes
    BaseInspection
  72. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  73. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  74. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  77. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  78. object db extends Helpful
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Database related operations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Database")
  79. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")
  80. object participants extends Helpful
    Definition Classes
    DomainAdministration
    Annotations
    @Summary(s = "Manage participant permissions", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participants")
  81. object service extends Helpful
    Definition Classes
    DomainAdministration
    Annotations
    @Summary(s = "Domain service commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Service")
  82. object sequencer_connection extends Helpful
    Definition Classes
    SequencerConnectionAdministration
    Annotations
    @Summary(s = "Manage sequencer connection", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Sequencer Connection")

Deprecated Value Members

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

Inherited from LocalInstanceReference

Inherited from SetupAdministration

Inherited from NoTracing

Inherited from DomainAdministration

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped