o
com.digitalasset.canton.console.commands.TopologyAdministrationGroup
participant_synchronizer_permissions
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")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- participant_synchronizer_permissions
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def find(synchronizerId: SynchronizerId, participantId: ParticipantId): Option[ListParticipantSynchronizerPermissionResult]
- Annotations
- @Summary(s = "Looks up the participant permission for a participant on a synchronizer", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Returns the optional participant synchronizer permission.""")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(store: TopologyStoreId, proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterUid: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListParticipantSynchronizerPermissionResult]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def propose(synchronizerId: SynchronizerId, participantId: ParticipantId, permission: ParticipantPermission, loginAfter: Option[CantonTimestamp] = None, limits: Option[ParticipantSynchronizerLimits] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), store: Option[TopologyStoreId] = None, mustFullyAuthorize: Boolean = false, serial: Option[PositiveInt] = None, change: TopologyChangeOp = TopologyChangeOp.Replace): SignedTopologyTransaction[TopologyChangeOp, ParticipantSynchronizerPermission]
- Annotations
- @Summary(s = "Propose changes to the synchronizer permissions of participants.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Synchronizer operators may use this command to change a participant's permissions on a synchronizer.
synchronizerId: the target synchronizer
participantId: the participant whose permissions should be changed
permission: the participant's permission
loginAfter: the earliest time a participant may connect to the synchronizer
limits: synchronizer limits for this participant
store: - "Authorized": the topology transaction will be stored in the node's authorized store and automatically
propagated to connected synchronizers, if applicable.
- "<synchronizer id>": the topology transaction will be directly submitted to the specified synchronizer without
storing it locally first. This also means it will _not_ be synchronized to other synchronizers
automatically.
mustFullyAuthorize: when set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. if this is not the case, the request fails.
when set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.
serial: the expected serial this topology transaction should have. Serials must be contiguous and start at 1.
This transaction will be rejected if another fully authorized transaction with the same serial already
exists, or if there is a gap between this serial and the most recently used serial.
If None, the serial will be automatically selected by the node.""")
- def revoke(synchronizerId: SynchronizerId, participantId: ParticipantId, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), mustFullyAuthorize: Boolean = false, store: Option[TopologyStoreId] = None): SignedTopologyTransaction[TopologyChangeOp, ParticipantSynchronizerPermission]
- Annotations
- @Summary(s = "Revokes the synchronizer permissions of a participant.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Synchronizer operators may use this command to revoke a participant's permissions on a synchronizer.
synchronizerId: the target synchronizer
participantId: the participant whose permissions should be revoked
store: - "Authorized": the topology transaction will be stored in the node's authorized store and automatically
propagated to connected synchronizers, if applicable.
- "<synchronizer id>": the topology transaction will be directly submitted to the specified synchronizer without
storing it locally first. This also means it will _not_ be synchronized to other synchronizers
automatically.
mustFullyAuthorize: when set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. if this is not the case, the request fails.
when set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])