net.corda.node.services.messaging / CordaRPCOps

CordaRPCOps

interface CordaRPCOps : RPCOps

RPC operations that the node exposes to clients using the Java client library. These can be called from client apps and are implemented by the node in the ServerRPCOps class.



Inherited Properties

protocolVersion abstract val protocolVersion: Int

Returns the RPC protocol version. Exists since version 0 so guaranteed to be present.

Functions

addVaultTransactionNote abstract fun addVaultTransactionNote(txnId: SecureHash, txnNote: String): Unit
executeCommand abstract fun executeCommand(command: ClientToServiceCommand): TransactionBuildResult

Executes the given command if the user is permissioned to do so, possibly triggering cash creation etc. TODO: The signature of this is weird because its the remains of an old service call, we should have a call for each command instead.

getVaultTransactionNotes abstract fun getVaultTransactionNotes(txnId: SecureHash): Iterable<String>
networkMapUpdates abstract fun networkMapUpdates(): <ERROR CLASS><List<NodeInfo>, <ERROR CLASS><MapChange>>

Returns all parties currently visible on the network with their advertised services and an observable of future updates to the network.

nodeIdentity abstract fun nodeIdentity(): NodeInfo

Returns Nodes identity, assuming this will not change while the node is running.

stateMachineRecordedTransactionMapping abstract fun stateMachineRecordedTransactionMapping(): <ERROR CLASS><List<StateMachineTransactionMapping>, <ERROR CLASS><StateMachineTransactionMapping>>

Returns a snapshot list of existing state machine id - recorded transaction hash mappings, and a stream of future such mappings as well.

stateMachinesAndUpdates abstract fun stateMachinesAndUpdates(): <ERROR CLASS><List<StateMachineInfo>, <ERROR CLASS><StateMachineUpdate>>

Returns a pair of currently in-progress state machine infos and an observable of future state machine adds/removes.

vaultAndUpdates abstract fun vaultAndUpdates(): <ERROR CLASS><List<StateAndRef<ContractState>>, <ERROR CLASS><Update>>

Returns a pair of head states in the vault and an observable of future updates to the vault.

verifiedTransactions abstract fun verifiedTransactions(): <ERROR CLASS><List<SignedTransaction>, <ERROR CLASS><SignedTransaction>>

Returns a pair of all recorded transactions and an observable of future recorded ones.

Inheritors

CordaRPCOpsImpl class CordaRPCOpsImpl : CordaRPCOps

Server side implementations of RPCs available to MQ based client tools. Execution takes place on the server thread (i.e. serially). Arguments are serialised and deserialised automatically.