object participant_domain_states extends Helpful
- Annotations
- @Summary(s = "Inspect participant domain states", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participant Domain States")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- participant_domain_states
- 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
- def active(domainId: DomainId, participantId: ParticipantId): Boolean
- Annotations
- @Summary(s = "Returns true if the given participant is currently active on the given domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Active means that the participant has been granted at least observation rights on the domain
|and that the participant has registered a domain trust certificate""")
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authorize(ops: TopologyChangeOp, domain: DomainId, participant: ParticipantId, side: RequestSide, permission: ParticipantPermission = ParticipantPermission.Submission, trustLevel: TrustLevel = TrustLevel.Ordinary, signedBy: Option[Fingerprint] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), replaceExisting: Boolean = true): ByteString
- Annotations
- @Summary(s = "Change participant domain states", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Change the association of a participant to a domain.
|In order to activate a participant on a domain, we need both authorisation: the participant authorising
|its uid to be present on a particular domain and the domain to authorise the presence of a participant
|on said domain.
|If both identifiers are in the same namespace, then the request-side can be Both. If they differ, then
|we need to say whether the request comes from the domain (RequestSide.From) or from the participant
|(RequestSide.To). And, we need the matching request of the other side.
ops: Either Add or Remove the mapping
signedBy: Refers to the optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
domain: The unique identifier of the domain we want the participant to join.
participant: The unique identifier of the participant.
side: The request side (RequestSide.From if we the transaction is from the perspective of the domain, RequestSide.To from the participant.)
permission: The privilege of the given participant which allows us to restrict an association (e.g. Confirmation or Observation). Will use the lower of if different between To/From.
trustLevel: The trust level of the participant on the given domain. Will use the lower of if different between To/From.
replaceExisting: If true (default), replace any existing mapping with the new setting
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
""")
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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(filterStore: String = "", useStateStore: Boolean = true, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = None, filterDomain: String = "", filterParticipant: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListParticipantDomainStateResult]
- Annotations
- @Summary(s = "List participant domain states", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the participant domain transactions present in the stores. Participant domain states
|are topology transactions used to permission a participant on a given domain.
|A participant domain state has a request-side that identifies whether the mapping is authorized by the
|participant (From), by the domain (To) or by both (Both).
|In order to use a participant on a domain, both have to authorize such a mapping. This means that by
|authorizing such a topology transaction, a participant acknowledges its presence on a domain, whereas
|a domain permissions the participant on that domain.
|
filterStore: Filter for topology stores starting with the given filter string (Authorized, <domain-id>, Requested)
useStateStore: If true (default), only properly authorized transactions that are part of the state will be selected.
timeQuery: The time query allows to customize the query by time. The following options are supported:
TimeQuery.HeadState (default): The most recent known state.
TimeQuery.Snapshot(ts): The state at a certain point in time.
TimeQuery.Range(fromO, toO): Time-range of when the transaction was added to the store
operation: Optionally, what type of operation the transaction should have. State store only has "Add".
filterSigningKey: Filter for transactions that are authorized with a key that starts with the given filter string.
filterDomain: Filter for domains starting with the given filter string.
filterParticipant: Filter for participants starting with the given filter string.
protocolVersion: Export the topology transactions in the optional protocol version.
|""")
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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])