Packages

c

com.digitalasset.canton.console

LocalMediatorReference

class LocalMediatorReference extends MediatorReference with LocalMediatorReferenceCommon with LocalInstanceReference with BaseInspection[MediatorNode]

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

Instance Constructors

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

Type Members

  1. type Status = MediatorNodeStatus
  2. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  3. implicit class ShowEitherSyntax[L, R] extends AnyRef

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

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

    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  6. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  7. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  8. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  9. 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
  10. 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. object db extends Helpful
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Database related operations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Database")
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def access[T](ops: (MediatorNode) => T): T
    Attributes
    protected[console]
    Definition Classes
    BaseInspection
  6. 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
  7. def adminCommand[Result](grpcCommand: 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
    LocalInstanceReferenceCommonAdminCommandRunner
  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
    InstanceReferenceCommon
    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: MediatorNodeConfig
    Definition Classes
    LocalMediatorReferenceLocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Returns the mediator configuration", flag = console.this.Help.Summary.<init>$default$2)
  14. val consoleEnvironment: ConsoleEnvironment
  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
    MediatorReference → AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. def executionContext: ExecutionContext
    Attributes
    protected[canton]
    Definition Classes
    LocalMediatorReferenceInstanceReferenceCommon
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    InstanceReferenceCommon → AnyRef → Any
  23. def health: HealthAdministrationCommon[Status]
    Definition Classes
    MediatorReferenceInstanceReferenceCommon
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  24. 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"))
  25. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  26. def id: MediatorId
    Definition Classes
    MediatorReferenceCommonInstanceReferenceCommon
    Annotations
    @Summary(s = "Yields the mediator id of this mediator. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the mediator has not yet been initialised)."
    , flag = console.this.Help.Summary.<init>$default$2)
  27. def indicateOmittedFields[T]: (T) => Option[Tree]

    Use this to indicate that you've omitted fields from pretty printing

    Use this to indicate that you've omitted fields from pretty printing

    Definition Classes
    PrettyUtil
  28. val instanceType: String
    Attributes
    protected
    Definition Classes
    MediatorReferenceInstanceReferenceCommon
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  31. def is_running: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  32. val keys: EnterpriseLocalKeyAdministrationGroup
    Definition Classes
    LocalMediatorReferenceCommonLocalInstanceReferenceCommonInstanceReferenceCommon
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  33. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    MediatorReferenceNamedLogging
  35. def mediator: MediatorAdministrationGroupWithInit
    Definition Classes
    MediatorReference
    Annotations
    @Summary(s = "Manage the mediator", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Mediator")
  36. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  37. val name: String
  38. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. 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
  44. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  45. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  46. def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree only written if not matching the default value

    A tree only written if not matching the default value

    Definition Classes
    PrettyUtil
  47. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  48. 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
  49. def parties: PartiesAdministrationGroup
    Definition Classes
    MediatorReferenceInstanceReference
  50. def pretty: Pretty[InstanceReferenceCommon]

    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
    InstanceReferenceCommonPrettyPrinting
  51. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  52. 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
  53. 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
  54. 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
  55. 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
  56. 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
  57. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  58. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  59. def runningNode: Option[MediatorNodeBootstrap]
    Attributes
    protected[console]
    Definition Classes
    LocalMediatorReferenceBaseInspection
  60. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  61. 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
  62. def start(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  63. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  64. def startingNode: Option[MediatorNodeBootstrap]
    Attributes
    protected[console]
    Definition Classes
    LocalMediatorReferenceBaseInspection
  65. def stop(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  66. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  67. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  68. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  69. 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
  70. def topology: TopologyAdministrationGroup
  71. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  72. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceCommonAdminCommandRunner
  73. def underlying: Option[MediatorNode]
    Definition Classes
    BaseInspection
  74. 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
  75. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  76. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  77. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  78. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  80. 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
    Deprecated

Inherited from LocalInstanceReference

Inherited from NoTracing

Inherited from MediatorReference

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