Packages

c

com.digitalasset.canton.console.commands

LocalParticipantPartiesAdministrationGroup

class LocalParticipantPartiesAdministrationGroup extends ParticipantPartiesAdministrationGroup with FeatureFlagFilter

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

Instance Constructors

  1. new LocalParticipantPartiesAdministrationGroup(reference: LocalParticipantReference, runner: AdminCommandRunner with BaseInspection[ParticipantNode] with ParticipantAdministration with BaseLedgerApiAdministration, 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 await_topology_observed[T <: ParticipantReference](partyAssignment: Set[(PartyId, T)], timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.bounded)(implicit env: ConsoleEnvironment): Unit
    Annotations
    @Summary(s = "Waits for any topology changes to be observed", flag = FeatureFlag.Preview) @Description(s = "Will throw an exception if the given topology has not been observed within the given timeout.")
  6. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  7. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. val consoleEnvironment: ConsoleEnvironment
  10. def defaultLimit: PositiveInt
    Attributes
    protected
    Definition Classes
    PartiesAdministrationGroup
  11. def disable(name: Identifier, force: Boolean = false): Unit
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "Disable party on participant", flag = console.this.Help.Summary.<init>$default$2)
  12. def enable(name: String, displayName: Option[String] = None, waitForDomain: DomainChoice = DomainChoice.Only(Seq()), synchronizeParticipants: Seq[ParticipantReference] = Seq()): PartyId
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "Enable/add party to participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This function registers a new party with the current participant within the participants
    |namespace. The function fails if the participant does not have appropriate signing keys
    |to issue the corresponding PartyToParticipant topology transaction.
    |Optionally, a local display name can be added. This display name will be exposed on the
    |ledger API party management endpoint.
    |Specifying a set of domains via the `WaitForDomain` parameter ensures that the domains have
    |enabled/added a party by the time the call returns, but other participants connected to the same domains may not
    |yet be aware of the party.
    |Additionally, a sequence of additional participants can be added to be synchronized to
    |ensure that the party is known to these participants as well before the function terminates.
    |"""
    )
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def find(filterParty: String): PartyId
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "Find a party from a filter string", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Will search for all parties that match this filter string. If it finds exactly one party, it
    |will return that one. Otherwise, the function will throw."""
    )
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. 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"))
  20. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  21. def hosted(filterParty: String = "", filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListPartiesResult]
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "List parties hosted by this participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Inspect the parties hosted by this participant as used for synchronisation.
    |The response is built from the timestamped topology transactions of each domain, excluding the
    |authorized store of the given node. The search will include all hosted parties and is equivalent
    |to running the `list` method using the participant id of the invoking participant.
    |
    filterParty: Filter by parties starting with the given string.
    filterDomain: Filter by domains whose id starts with the given string.
    asOf: Optional timestamp to inspect the topology state at a given point in time.
    limit: How many items to return (defaults to canton.parameters.console.default-limit)

    Example: participant1.parties.hosted(filterParty="alice")"""
    )
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def list(filterParty: String = "", filterParticipant: String = "", filterDomain: String = "", asOf: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[ListPartiesResult]
    Definition Classes
    PartiesAdministrationGroup
    Annotations
    @Summary(s = "List active parties, their active participants, and the participants' permissions on domains.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Inspect the parties known by this participant as used for synchronisation.
    |The response is built from the timestamped topology transactions of each domain, excluding the
    |authorized store of the given node. For each known party, the list of active
    |participants and their permission on the domain for that party is given.
    |
    filterParty: Filter by parties starting with the given string.
    filterParticipant: Filter for parties that are hosted by a participant with an id starting with the given string
    filterDomain: Filter by domains whose id starts with the given string.
    asOf: Optional timestamp to inspect the topology state at a given point in time.
    limit: Limit on the number of parties fetched (defaults to canton.parameters.console.default-limit).

    Example: participant1.parties.list(filterParty="alice")
    """
    )
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. val loggerFactory: NamedLoggerFactory
  26. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def set_display_name(party: PartyId, displayName: String): Unit
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "Set party display name", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Locally set the party display name (shown on the ledger-api) to the given value")
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def update(party: PartyId, modifier: (PartyDetails) => PartyDetails): PartyDetails
    Definition Classes
    ParticipantPartiesAdministrationGroup
    Annotations
    @Summary(s = "Update participant-local party details", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Currently you can update only the annotations.
    |You cannot update other user attributes.
    party: party to be updated,
    modifier: a function to modify the party details, e.g.: `partyDetails => { partyDetails.copy(annotations = partyDetails.annotations.updated("a", "b").removed("c")) }`"""
    )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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
    Deprecated

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped