object owner_to_key_mappings extends OwnerToKeyMappingsGroup with Helpful
- Definition Classes
- TopologyAdministrationGroup → TopologyAdministrationGroupCommon
- Annotations
- @Summary(s = "Manage owner to key mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Owner to key mappings")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- owner_to_key_mappings
- Helpful
- OwnerToKeyMappingsGroup
- 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 authorize(ops: TopologyChangeOp, keyOwner: KeyOwner, key: Fingerprint, purpose: KeyPurpose, signedBy: Option[Fingerprint] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), force: Boolean = false): ByteString
- Annotations
- @Summary(s = "Change an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Change a owner to key mapping. A key owner is anyone in the system that needs a key-pair known
|to all members (participants, mediator, sequencer, topology manager) of a domain.
ops: Either Add or Remove the key mapping update.
signedBy: Optional fingerprint of the authorizing key which in turn refers to a specific, locally existing certificate.
ownerType: Role of the following owner (Participant, Sequencer, Mediator, DomainTopologyManager)
owner: Unique identifier of the owner.
key: Fingerprint of key
purposes: The purposes of the owner to key mapping.
force: removing the last key is dangerous and must therefore be manually forced
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() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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, filterKeyOwnerType: Option[KeyOwnerCode] = None, filterKeyOwnerUid: String = "", filterKeyPurpose: Option[KeyPurpose] = None, filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListOwnerToKeyMappingResult]
- Annotations
- @Summary(s = "List owner to key mapping transactions", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List the owner to key mapping transactions present in the stores. Owner to key mappings
|are topology transactions defining that a certain key is used by a certain key owner.
|Key owners are participants, sequencers, mediators and domains.
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.
filterKeyOwnerType: Filter for a particular type of key owner (KeyOwnerCode).
filterKeyOwnerUid: Filter for key owners unique identifier starting with the given filter string.
filterKeyPurpose: Filter for keys with a particular purpose (Encryption or Signing)
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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def rotate_key(owner: KeyOwner, currentKey: PublicKey, newKey: PublicKey): Unit
- Definition Classes
- owner_to_key_mappings → OwnerToKeyMappingsGroup
- def rotate_key(nodeInstance: InstanceReferenceCommon, owner: KeyOwner, currentKey: PublicKey, newKey: PublicKey): Unit
- Definition Classes
- owner_to_key_mappings → OwnerToKeyMappingsGroup
- Annotations
- @Summary(s = "Rotate the key for an owner to key mapping", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Rotates the key for an existing owner to key mapping by issuing a new owner to key mapping with the new key
|and removing the previous owner to key mapping with the previous key.
nodeInstance: The node instance that is used to verify that both current and new key pertain to this node.
|This avoids conflicts when there are different nodes with the same uuid (i.e., multiple sequencers).
owner: The owner of the owner to key mapping
currentKey: The current public key that will be rotated
newKey: The new public key that has been generated
|""")
- 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])