Reconnecting
Wrapper over CordaRPCOps that handles exceptions when the node or the connection to the node fail.
All operations are retried on failure, except flow start operations that die before receiving a valid FlowHandle, in which case a CouldNotStartFlowException is thrown.
When calling methods that return a DataFeed like CordaRPCOps.vaultTrackBy, the returned DataFeed.updates object will no longer be a usable rx.Observable but an instance of ReconnectingObservable. The caller has to explicitly cast to ReconnectingObservable and call ReconnectingObservable.subscribe. If used as an rx.Observable it will just fail. The returned DataFeed.snapshot is the snapshot as it was when the feed was first retrieved.
Note: There is no guarantee that observations will not be lost.
This class is not a stable API. Any project that wants to use it, must copy and paste it.
Constructors
Types
Helper class useful for reconnecting to a Node.
Properties
Functions
Accept network parameters with given hash, hash is obtained through networkParametersFeed method. Information is sent back to the zone operator that the node accepted the parameters update - this process cannot be undone. Only parameters that are scheduled for update can be accepted, if different hash is provided this method will fail. Note: This operation may be restricted only to node administrators.
Add note(s) to an existing Vault transaction.
Checks whether an attachment with the given hash is stored on the node.
Clear all network map data from local node cache. Notice that after invoking this method your node will lose network map data and effectively won't be able to start any flow with the peers until network map is downloaded again on next poll - from additional-node-infos directory or from network map server. It depends on the polling interval when it happens. You can also use refreshNetworkMapCache to force next fetch from network map server (not from directory - it will happen automatically). If you run local test deployment and want clear view of the network, you may want to clear also additional-node-infos directory, because cache can be repopulated from there.
Returns the node's current time.
Returns all finished flows that were started with a client ID for which the client ID mapping has not been removed. This version only returns the client ids for flows started by the same user currently calling finishedFlowsWithClientIds.
Returns all finished flows that were started with a client id by all RPC users for which the client ID mapping has not been removed.
Retrieve existing note(s) for a given Vault transaction.
Returns whether the flows draining mode is enabled.
Returns whether the node is waiting for pending flows to complete before shutting down. Disabling draining mode cancels this state.
Attempts to kill a flow. This is not a clean termination and should be reserved for exceptional cases such as stuck fibers.
Returns all parties currently visible on the network with their advertised services and an observable of future updates to the network.
Returns all parties currently visible on the network with their advertised services.
Returns DataFeed object containing information on currently scheduled parameters update (null if none are currently scheduled) and observable with future update events. Any update that occurs before the deadline automatically cancels the current one. Only the latest update can be accepted. Note: This operation may be restricted only to node administrators.
Returns Node's NodeDiagnosticInfo, including the version details as well as the information about installed CorDapps.
Returns a node's info from the network map cache, where known. Notice that when there are more than one node for a given name (in case of distributed services) first service node found will be returned.
Returns network's notary identities, assuming this will not change while the node is running.
Get a notary identity by name.
Download an attachment JAR by ID.
Returns a list of candidate matches for a given string, with optional fuzzy(ish) matching. Fuzzy matching may get smarter with time e.g. to correct spelling errors, so you should not hard-code indexes into the results but rather show them via a user interface and let the user pick the one they wanted.
Returns the Party corresponding to the given key, if found.
Returns a DataFeed of the number of pending flows. The Observable for the updates will complete the moment all pending flows will have terminated.
Queries attachments metadata
Reattach to an existing flow that was started with startFlowDynamicWithClientId and has a clientId.
Poll network map server if available for the network map. Notice that you need to have compatibilityZone or networkServices configured. This is normally done automatically on the regular time interval, but you may wish to have the fresh view of network earlier.
Enumerates the class names of the flows that this node knows about.
Removes a flow's clientId to result/ exception mapping. If the mapping is of a running flow, then the mapping will not get removed. This version will only remove flow's that were started by the same user currently calling removeClientId.
Removes a flow's clientId to result/ exception mapping. If the mapping is of a running flow, then the mapping will not get removed. This version can be called for all client ids, ignoring which user originally started a flow with clientId.
This function runs a flow and retries until it completes successfully.
Sets the value of the node's flows draining mode. If this mode is enabled, the node will reject new flows through RPC, ignore scheduled flows, and do not process initial session messages, meaning that P2P counterparties will not be able to initiate new flows involving the node.
Extension function for type safe invocation of flows from Kotlin, for example:
Start the given flow with the given arguments. logicType must be annotated with net.corda.core.flows.StartableByRPC.
Start the given flow with the given arguments and a clientId.
Extension function for type safe invocation of flows from Kotlin, with clientId.
Extension function for type safe invocation of flows from Kotlin, with progress tracking enabled.
Start the given flow with the given arguments, returning an Observable with a single observation of the result of running the flow. logicType must be annotated with net.corda.core.flows.StartableByRPC.
Returns a snapshot list of existing state machine id - recorded transaction hash mappings, and a stream of future such mappings as well.
Returns a snapshot list of existing state machine id - recorded transaction hash mappings.
Returns a data feed of currently in-progress state machine infos and an observable of future state machine adds/removes.
Returns a list of currently in-progress state machine infos.
Uploads a jar to the node, returns it's hash.
Uploads a jar including metadata to the node, returns it's hash.
Returns a snapshot of vault states for a given query criteria (and optional order and paging specification)
Returns a snapshot (as per queryBy) and an observable of future updates to the vault for the given query criteria.
Returns a CordaFuture which completes when the node has registered wih the network map service. It can also complete with an exception if it is unable to.
Returns the well known identity from an abstract party. This is intended to resolve the well known identity from a confidential identity, however it transparently handles returning the well known identity back if a well known identity is passed in.
Returns the Party with the X.500 principal as it's Party.name.