diff --git a/docs/build/doctrees/json.doctree b/docs/build/doctrees/json.doctree new file mode 100644 index 0000000000..0d6270164b Binary files /dev/null and b/docs/build/doctrees/json.doctree differ diff --git a/docs/build/doctrees/shell.doctree b/docs/build/doctrees/shell.doctree new file mode 100644 index 0000000000..bca233d27e Binary files /dev/null and b/docs/build/doctrees/shell.doctree differ diff --git a/docs/build/html/_sources/json.txt b/docs/build/html/_sources/json.txt new file mode 100644 index 0000000000..126c9f5791 --- /dev/null +++ b/docs/build/html/_sources/json.txt @@ -0,0 +1,42 @@ +.. highlight:: kotlin +.. raw:: html + + + + +JSON +==== + +Corda provides a module that extends the popular Jackson serialisation engine. Jackson is often used to serialise +to and from JSON, but also supports other formats such as YaML and XML. Jackson is itself very modular and has +a variety of plugins that extend its functionality. You can learn more at the `Jackson home page `_. + +To gain support for JSON serialisation of common Corda data types, include a dependency on ``net.corda:jackson:XXX`` +in your Gradle or Maven build file, where XXX is of course the Corda version you are targeting (0.9 for M9, for instance). +Then you can obtain a Jackson ``ObjectMapper`` instance configured for use using the ``JacksonSupport.createNonRpcMapper()`` +method. There are variants of this method for obtaining Jackson's configured in other ways: if you have an RPC +connection to the node (see ":doc:`clientrpc`") then your JSON mapper can resolve identities found in objects. + +The API is described in detail here: + +* `Kotlin API docs `_ +* `JavaDoc `_ + +.. container:: codeset + + .. sourcecode:: kotlin + + import net.corda.jackson.JacksonSupport + + val mapper = JacksonSupport.createNonRpcMapper() + val json = mapper.writeValueAsString(myCordaState) // myCordaState can be any object. + + .. sourcecode:: java + + import net.corda.jackson.JacksonSupport + + ObjectMapper mapper = JacksonSupport.createNonRpcMapper() + String json = mapper.writeValueAsString(myCordaState) // myCordaState can be any object. + + +.. note:: The way mappers interact with identity and RPC is likely to change in a future release. diff --git a/docs/build/html/_sources/shell.txt b/docs/build/html/_sources/shell.txt new file mode 100644 index 0000000000..e5d0089966 --- /dev/null +++ b/docs/build/html/_sources/shell.txt @@ -0,0 +1,143 @@ +.. highlight:: kotlin +.. raw:: html + + + + +Shell +===== + +The Corda shell is an embedded command line that allows an administrator to control and monitor the node. +Some of its features include: + +* Invoking any of the RPCs the node exposes to applications. +* Starting flows. +* View a dashboard of threads, heap usage, VM properties. +* Uploading and downloading zips from the attachment store. +* Issue SQL queries to the underlying database. +* View JMX metrics and monitoring exports. +* UNIX style pipes for both text and objects, an ``egrep`` command and a command for working with columnular data. + +.. note:: A future version of Corda will add SSH access to the node. + +It is based on the popular `CRaSH`_ shell used in various other projects and supports many of the same features. + +The shell may be disabled by passing the ``--no-local-shell`` flag to the node. + +Getting help +------------ + +You can run ``help`` to list the available commands. + +The shell has a ``man`` command that can be used to get interactive help on many commands. You can also use the +``--help`` or ``-h`` flags to a command to get info about what switches it supports. + +Commands may have subcommands, in the same style as ``git``. In that case running the command by itself will +list the supported subcommands. + +Starting flows and performing remote method calls +------------------------------------------------- + +**Flows** are the way the ledger is changed. If you aren't familiar with them, please review ":doc:`flow-state-machines`" +first. The ``flow list`` command can be used to list the flows understood by the node and ``flow start`` can be +used to start them. The ``flow start`` command takes the class name of a flow, or *any unambiguous substring* and +then the data to be passed to the flow constructor. The unambiguous substring feature is helpful for reducing +the needed typing. If the match is ambiguous the possible matches will be printed out. If a flow has multiple +constructors then the names and types of the arguments will be used to try and determine which to use automatically. +If the match against available constructors is unclear, the reasons each available constructor failed to match +will be printed out. In the case of an ambiguous match, the first applicable will be used. + +**RPCs** (remote procedure calls) are commands that can be sent to the node to query it, control it and manage it. +RPCs don't typically do anything that changes the global ledger, but they may change node-specific data in the +database. Each RPC is one method on the ``CordaRPCOps`` interface, and may return a stream of events that will +be shown on screen until you press Ctrl-C. You perform an RPC by using ``run`` followed by the name. + +.. raw:: html + +
Documentation of available RPCs

+ +Whichever form of change is used, there is a need to provide *parameters* to either the RPC or the flow +constructor. Because parameters can be any arbitrary Java object graph, we need a convenient syntax to express +this sort of data. The shell uses a syntax called `Yaml`_ to do this. + +Data syntax +----------- + +Yaml (yet another markup language) is a simple JSON-like way to describe object graphs. It has several features +that make it helpful for our use case, like a lightweight syntax and support for "bare words" which mean you can +often skip the quotes around strings. Here is an example of how this syntax is used: + +``flow start CashIssue amount: $1000, issueRef: 1234, recipient: Bank A, notary: Notary Service`` + +This invokes a constructor of a flow with the following prototype in the code: + +.. container:: codeset + + .. sourcecode:: kotlin + + class CashIssueFlow(val amount: Amount, + val issueRef: OpaqueBytes, + val recipient: Party, + val notary: Party) : AbstractCashFlow(progressTracker) + +Here, everything after ``CashIssue`` is specifying the arguments to the constructor of a flow. In Yaml, an object +is specified as a set of ``key: value`` pairs and in our form, we separate them by commas. There are a few things +to note about this syntax: + +* When a parameter is of type ``Amount`` you can write it as either one of the dollar symbol ($), + pound (£), euro (€) followed by the amount as a decimal, or as the value followed by the ISO currency code + e.g. "100.12 CHF" +* ``OpaqueBytes`` is filled with the contents of whatever is provided as a string. +* ``Party`` objects are looked up by name. +* Strings do not need to be surrounded by quotes unless they contain a comma or embedded quotes. This makes it + a lot more convenient to type such strings. + +Other types also have sensible mappings from strings. See `the defined parsers`_ for more information. + +Nested objects can be created using curly braces, as in ``{ a: 1, b: 2}``. This is helpful when no particular +parser is defined for the type you need, for instance, if an API requires a ``Pair`` +which could be represented as ``{ first: foo, second: 123 }``. + +The same syntax is also used to specify the parameters for RPCs, accessed via the ``run`` command, like this: + +``run getCashBalances`` + +Attachments +----------- + +The shell can be used to upload and download attachments from the node interactively. To learn more, see +the tutorial ":doc:`tutorial-attachments`". + +Extending the shell +------------------- + +The shell can be extended using commands written in either Java or `Groovy`_ (Groovy is a scripting language that +is Java compatible). Such commands have full access to the node internal APIs and thus can be used to achieve +almost anything. + +A full tutorial on how to write such commands is out of scope for this documentation, to learn more please +refer to the `CRaSH`_ documentation. New commands can be placed in the ``shell-commands`` subdirectory in the +node directory. Edits to existing commands will be used automatically, but at this time commands added after the +node has started won't be automatically detected. Commands should be named in all lower case with either a +``.java`` or ``.groovy`` extension. + +.. warning:: Commands written in Groovy ignore Java security checks, so have unrestricted access to node and JVM + internals regardless of any sandboxing that may be in place. Don't allow untrusted users to edit files in the + shell-commands directory! + +Limitations +----------- + +The shell will be enhanced over time. The currently known limitations include: + +* SSH access is currently not available. +* There is no command completion for flows or RPCs. +* Command history is not preserved across restarts. +* The ``jdbc`` command requires you to explicitly log into the database first. +* Commands placed in the ``shell-commands`` directory are only noticed after the node is restarted. +* The ``jul`` command advertises access to logs, but it doesn't work with the logging framework we're using. + +.. _Yaml: http://www.yaml.org/spec/1.2/spec.html +.. _the defined parsers: api/kotlin/corda/net.corda.jackson/-jackson-support/index.html +.. _Groovy: http://groovy-lang.org/ +.. _CRaSH: http://www.crashub.org/ \ No newline at end of file diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.Companion.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.Companion.html new file mode 100644 index 0000000000..0d9e5d9218 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.Companion.html @@ -0,0 +1,174 @@ + + + + + + +ContractStateModel.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ContractStateModel.Companion

+
+
+
    +
  • net.corda.client.jfx.model.ContractStateModel.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    ContractStateModel
    +
    +
    +
    +
    public static class ContractStateModel.Companion
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.html new file mode 100644 index 0000000000..0db25c96bc --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ContractStateModel.html @@ -0,0 +1,333 @@ + + + + + + +ContractStateModel + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ContractStateModel

+
+
+
    +
  • net.corda.client.jfx.model.ContractStateModel
    • +
+
+
    +
  • +
    +
    +
    public class ContractStateModel
    +

    This model exposes the list of owned contract states.

    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ContractStateModel() +
      This model exposes the list of owned contract states.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      javafx.collections.ObservableList<net.corda.core.contracts.Amount>getCash() 
      javafx.collections.ObservableList<net.corda.core.contracts.StateAndRef>getCashStates() 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ContractStateModel

        +
        public ContractStateModel()
        +

        This model exposes the list of owned contract states.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCashStates

        +
        public javafx.collections.ObservableList<net.corda.core.contracts.StateAndRef> getCashStates()
        +
        • +
      + + + +
        +
      • +

        getCash

        +
        public javafx.collections.ObservableList<net.corda.core.contracts.Amount> getCash()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/Diff.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/Diff.html new file mode 100644 index 0000000000..d5c01b6215 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/Diff.html @@ -0,0 +1,361 @@ + + + + + + +Diff + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class Diff<T extends ContractState>

+
+
+
    +
  • net.corda.client.jfx.model.Diff<T>
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Diff(java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> added, + java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> removed) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.Collection<net.corda.core.contracts.StateAndRef>component1() 
      java.util.Collection<net.corda.core.contracts.StateAndRef>component2() 
      Diff<T>copy(java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> added, + java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> removed) 
      booleanequals(java.lang.Object p) 
      java.util.Collection<net.corda.core.contracts.StateAndRef>getAdded() 
      java.util.Collection<net.corda.core.contracts.StateAndRef>getRemoved() 
      inthashCode() 
      java.lang.StringtoString() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Diff

        +
        public Diff(java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> added,
+            java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> removed)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAdded

        +
        public java.util.Collection<net.corda.core.contracts.StateAndRef> getAdded()
        +
        • +
      + + + +
        +
      • +

        getRemoved

        +
        public java.util.Collection<net.corda.core.contracts.StateAndRef> getRemoved()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public java.util.Collection<net.corda.core.contracts.StateAndRef> component1()
        +
        • +
      + + + +
        +
      • +

        component2

        +
        public java.util.Collection<net.corda.core.contracts.StateAndRef> component2()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public Diff<T> copy(java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> added,
+                    java.util.Collection<? extends net.corda.core.contracts.StateAndRef<? extends T>> removed)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRate.html new file mode 100644 index 0000000000..5541b530e1 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRate.html @@ -0,0 +1,224 @@ + + + + + + +ExchangeRate + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Interface ExchangeRate

+
+
+
+
    +
  • +
    +
    +
    public ExchangeRate
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Default Methods 
      Modifier and TypeMethod and Description
      doublerate(java.util.Currency from, + java.util.Currency to) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        rate

        +
        double rate(java.util.Currency from,
+            java.util.Currency to)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModel.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModel.html new file mode 100644 index 0000000000..dbae6a2e38 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModel.html @@ -0,0 +1,266 @@ + + + + + + +ExchangeRateModel + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ExchangeRateModel

+
+
+
    +
  • net.corda.client.jfx.model.ExchangeRateModel
    • +
+
+
    +
  • +
    +
    +
    public class ExchangeRateModel
    +

    This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ExchangeRateModel() +
      This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExchangeRateModel

        +
        public ExchangeRateModel()
        +

        This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExchangeRate

        +
        public javafx.beans.value.ObservableValue<net.corda.client.jfx.model.ExchangeRate> getExchangeRate()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModelKt.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModelKt.html new file mode 100644 index 0000000000..5bbd06657f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ExchangeRateModelKt.html @@ -0,0 +1,247 @@ + + + + + + +ExchangeRateModelKt + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ExchangeRateModelKt

+
+
+
    +
  • net.corda.client.jfx.model.ExchangeRateModelKt
    • +
+
+
    +
  • +
    +
    +
    public class ExchangeRateModelKt
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        exchangeAmount

        +
        public static Amount<java.util.Currency> exchangeAmount(ExchangeRate $receiver,
+                                                        Amount<java.util.Currency> amount,
+                                                        java.util.Currency to)
        +
        • +
      + + + +
        +
      • +

        exchangeDouble

        +
        public static double exchangeDouble(ExchangeRate $receiver,
+                                    Amount<java.util.Currency> amount,
+                                    java.util.Currency to)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/FlowStatus.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/FlowStatus.html new file mode 100644 index 0000000000..1c2d86085f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/FlowStatus.html @@ -0,0 +1,329 @@ + + + + + + +FlowStatus + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class FlowStatus

+
+
+
    +
  • net.corda.client.jfx.model.FlowStatus
    • +
+
+
    +
  • +
    +
    +
    public class FlowStatus
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FlowStatus

        +
        public FlowStatus(java.lang.String status)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStatus

        +
        public java.lang.String getStatus()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public java.lang.String component1()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public FlowStatus copy(java.lang.String status)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/GatheredTransactionData.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/GatheredTransactionData.html new file mode 100644 index 0000000000..17f5702c7a --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/GatheredTransactionData.html @@ -0,0 +1,361 @@ + + + + + + +GatheredTransactionData + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class GatheredTransactionData

+
+
+
    +
  • net.corda.client.jfx.model.GatheredTransactionData
    • +
+
+
    +
  • +
    +
    +
    public class GatheredTransactionData
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GatheredTransactionData

        +
        public GatheredTransactionData(PartiallyResolvedTransaction transaction,
+                               javafx.collections.ObservableList<? extends net.corda.client.jfx.model.StateMachineData> stateMachines)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getStateMachines

        +
        public javafx.collections.ObservableList<? extends net.corda.client.jfx.model.StateMachineData> getStateMachines()
        +
        • +
      + + + + + + + +
        +
      • +

        component2

        +
        public javafx.collections.ObservableList<? extends net.corda.client.jfx.model.StateMachineData> component2()
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Resolved.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Resolved.html new file mode 100644 index 0000000000..02f2641cb8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Resolved.html @@ -0,0 +1,291 @@ + + + + + + +InputResolution.Resolved + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class InputResolution.Resolved

+
+
+
    +
  • InputResolution
    • +
  • +
      +
    • net.corda.client.jfx.model.PartiallyResolvedTransaction.InputResolution.Resolved
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Resolved

        +
        public Resolved(StateAndRef<? extends net.corda.core.contracts.ContractState> stateAndRef)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStateAndRef

        +
        public StateAndRef<net.corda.core.contracts.ContractState> getStateAndRef()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Unresolved.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Unresolved.html new file mode 100644 index 0000000000..145be05dab --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/InputResolution.Unresolved.html @@ -0,0 +1,256 @@ + + + + + + +InputResolution.Unresolved + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class InputResolution.Unresolved

+
+
+
    +
  • InputResolution
    • +
  • +
      +
    • net.corda.client.jfx.model.PartiallyResolvedTransaction.InputResolution.Unresolved
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Unresolved

        +
        public Unresolved(StateRef stateRef)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/Models.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/Models.html new file mode 100644 index 0000000000..6b593c5dd7 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/Models.html @@ -0,0 +1,278 @@ + + + + + + +Models + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class Models

+
+
+
    +
  • net.corda.client.jfx.model.Models
    • +
+
+
    +
  • +
    +
    +
    public class Models
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static ModelsINSTANCE 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <M> Mget(kotlin.reflect.KClass<M> klass, + kotlin.reflect.KClass<?> origin) 
      <M> java.lang.ObjectinitModel(kotlin.reflect.KClass<M> klass) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INSTANCE

        +
        public static Models INSTANCE
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initModel

        +
        public <M> java.lang.Object initModel(kotlin.reflect.KClass<M> klass)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public <M> M get(kotlin.reflect.KClass<M> klass,
+                 kotlin.reflect.KClass<?> origin)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ModelsKt.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ModelsKt.html new file mode 100644 index 0000000000..ba57605d42 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ModelsKt.html @@ -0,0 +1,170 @@ + + + + + + +ModelsKt + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ModelsKt

+
+
+
    +
  • net.corda.client.jfx.model.ModelsKt
    • +
+
+
    +
  • +
    +
    +
    public class ModelsKt
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/NetworkIdentityModel.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/NetworkIdentityModel.html new file mode 100644 index 0000000000..4ec79c7cbc --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/NetworkIdentityModel.html @@ -0,0 +1,328 @@ + + + + + + +NetworkIdentityModel + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class NetworkIdentityModel

+
+
+
    +
  • net.corda.client.jfx.model.NetworkIdentityModel
    • +
+
+
    +
  • +
    +
    +
    public class NetworkIdentityModel
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo>getMyIdentity() 
      javafx.collections.ObservableList<net.corda.core.node.NodeInfo>getNetworkIdentities() 
      javafx.collections.ObservableList<net.corda.core.node.NodeInfo>getNotaries() 
      javafx.collections.ObservableList<net.corda.core.node.NodeInfo>getParties() 
      javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo>lookup(CompositeKey compositeKey) 
      javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo>lookup(java.security.PublicKey publicKey) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NetworkIdentityModel

        +
        public NetworkIdentityModel()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNetworkIdentities

        +
        public javafx.collections.ObservableList<net.corda.core.node.NodeInfo> getNetworkIdentities()
        +
        • +
      + + + +
        +
      • +

        getParties

        +
        public javafx.collections.ObservableList<net.corda.core.node.NodeInfo> getParties()
        +
        • +
      + + + +
        +
      • +

        getNotaries

        +
        public javafx.collections.ObservableList<net.corda.core.node.NodeInfo> getNotaries()
        +
        • +
      + + + +
        +
      • +

        getMyIdentity

        +
        public javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo> getMyIdentity()
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo> lookup(CompositeKey compositeKey)
        +
        • +
      + + + +
        +
      • +

        lookup

        +
        public javafx.beans.value.ObservableValue<net.corda.core.node.NodeInfo> lookup(java.security.PublicKey publicKey)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/NodeMonitorModel.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/NodeMonitorModel.html new file mode 100644 index 0000000000..9166558a58 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/NodeMonitorModel.html @@ -0,0 +1,370 @@ + + + + + + +NodeMonitorModel + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class NodeMonitorModel

+
+
+
    +
  • net.corda.client.jfx.model.NodeMonitorModel
    • +
+
+
    +
  • +
    +
    +
    public class NodeMonitorModel
    +

    This model exposes raw event streams to and from the node.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NodeMonitorModel() +
      This model exposes raw event streams to and from the node.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      rx.Observable<net.corda.core.node.services.NetworkMapCache.MapChange>getNetworkMap() 
      rx.Observable<net.corda.client.jfx.model.ProgressTrackingEvent>getProgressTracking() 
      javafx.beans.property.SimpleObjectProperty<net.corda.core.messaging.CordaRPCOps>getProxyObservable() 
      rx.Observable<net.corda.core.node.services.StateMachineTransactionMapping>getStateMachineTransactionMapping() 
      rx.Observable<net.corda.core.messaging.StateMachineUpdate>getStateMachineUpdates() 
      rx.Observable<net.corda.core.transactions.SignedTransaction>getTransactions() 
      rx.Observable<net.corda.core.node.services.Vault.Update>getVaultUpdates() 
      voidregister(com.google.common.net.HostAndPort nodeHostAndPort, + java.lang.String username, + java.lang.String password) +
      Register for updates to/from a given vault. +TODO provide an unsubscribe mechanism
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NodeMonitorModel

        +
        public NodeMonitorModel()
        +

        This model exposes raw event streams to and from the node.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStateMachineUpdates

        +
        public rx.Observable<net.corda.core.messaging.StateMachineUpdate> getStateMachineUpdates()
        +
        • +
      + + + +
        +
      • +

        getVaultUpdates

        +
        public rx.Observable<net.corda.core.node.services.Vault.Update> getVaultUpdates()
        +
        • +
      + + + +
        +
      • +

        getTransactions

        +
        public rx.Observable<net.corda.core.transactions.SignedTransaction> getTransactions()
        +
        • +
      + + + +
        +
      • +

        getStateMachineTransactionMapping

        +
        public rx.Observable<net.corda.core.node.services.StateMachineTransactionMapping> getStateMachineTransactionMapping()
        +
        • +
      + + + +
        +
      • +

        getProgressTracking

        +
        public rx.Observable<net.corda.client.jfx.model.ProgressTrackingEvent> getProgressTracking()
        +
        • +
      + + + +
        +
      • +

        getNetworkMap

        +
        public rx.Observable<net.corda.core.node.services.NetworkMapCache.MapChange> getNetworkMap()
        +
        • +
      + + + +
        +
      • +

        getProxyObservable

        +
        public javafx.beans.property.SimpleObjectProperty<net.corda.core.messaging.CordaRPCOps> getProxyObservable()
        +
        • +
      + + + +
        +
      • +

        register

        +
        public void register(com.google.common.net.HostAndPort nodeHostAndPort,
+                     java.lang.String username,
+                     java.lang.String password)
        +

        Register for updates to/from a given vault. +TODO provide an unsubscribe mechanism

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.Companion.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.Companion.html new file mode 100644 index 0000000000..04686cd405 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.Companion.html @@ -0,0 +1,231 @@ + + + + + + +PartiallyResolvedTransaction.Companion + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class PartiallyResolvedTransaction.Companion

+
+
+
    +
  • net.corda.client.jfx.model.PartiallyResolvedTransaction.Companion
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromSignedTransaction

        +
        public PartiallyResolvedTransaction fromSignedTransaction(SignedTransaction transaction,
+                                                          javafx.collections.ObservableMap<net.corda.core.crypto.SecureHash,net.corda.core.transactions.SignedTransaction> transactions)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.InputResolution.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.InputResolution.html new file mode 100644 index 0000000000..2fcbd9f4a1 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.InputResolution.html @@ -0,0 +1,256 @@ + + + + + + +PartiallyResolvedTransaction.InputResolution + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class PartiallyResolvedTransaction.InputResolution

+
+
+
    +
  • net.corda.client.jfx.model.PartiallyResolvedTransaction.InputResolution
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStateRef

        +
        public StateRef getStateRef()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.html new file mode 100644 index 0000000000..724adcdec0 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/PartiallyResolvedTransaction.html @@ -0,0 +1,467 @@ + + + + + + +PartiallyResolvedTransaction + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class PartiallyResolvedTransaction

+
+
+
    +
  • net.corda.client.jfx.model.PartiallyResolvedTransaction
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.Companion.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.Companion.html new file mode 100644 index 0000000000..d95b8277a0 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.Companion.html @@ -0,0 +1,229 @@ + + + + + + +ProgressTrackingEvent.Companion + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ProgressTrackingEvent.Companion

+
+
+
    +
  • net.corda.client.jfx.model.ProgressTrackingEvent.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    ProgressTrackingEvent
    +
    +
    +
    +
    public static class ProgressTrackingEvent.Companion
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createStreamFromStateMachineInfo

        +
        public rx.Observable<net.corda.client.jfx.model.ProgressTrackingEvent> createStreamFromStateMachineInfo(StateMachineInfo stateMachine)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.html new file mode 100644 index 0000000000..71f1d2b555 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/ProgressTrackingEvent.html @@ -0,0 +1,417 @@ + + + + + + +ProgressTrackingEvent + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class ProgressTrackingEvent

+
+
+
    +
  • net.corda.client.jfx.model.ProgressTrackingEvent
    • +
+
+
    +
  • +
    +
    +
    public class ProgressTrackingEvent
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ProgressTrackingEvent

        +
        public ProgressTrackingEvent(StateMachineRunId stateMachineId,
+                             java.lang.String message)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        • +
      + + + + + + + +
        +
      • +

        component2

        +
        public java.lang.String component2()
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineData.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineData.html new file mode 100644 index 0000000000..552b1607a4 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineData.html @@ -0,0 +1,393 @@ + + + + + + +StateMachineData + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class StateMachineData

+
+
+
    +
  • net.corda.client.jfx.model.StateMachineData
    • +
+
+
    +
  • +
    +
    +
    public class StateMachineData
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StateMachineData(StateMachineRunId id, + javafx.beans.value.ObservableValue<net.corda.client.jfx.model.FlowStatus> flowStatus, + javafx.beans.value.ObservableValue<net.corda.client.jfx.model.StateMachineStatus> stateMachineStatus) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StateMachineData

        +
        public StateMachineData(StateMachineRunId id,
+                        javafx.beans.value.ObservableValue<net.corda.client.jfx.model.FlowStatus> flowStatus,
+                        javafx.beans.value.ObservableValue<net.corda.client.jfx.model.StateMachineStatus> stateMachineStatus)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getFlowStatus

        +
        public javafx.beans.value.ObservableValue<net.corda.client.jfx.model.FlowStatus> getFlowStatus()
        +
        • +
      + + + +
        +
      • +

        getStateMachineStatus

        +
        public javafx.beans.value.ObservableValue<net.corda.client.jfx.model.StateMachineStatus> getStateMachineStatus()
        +
        • +
      + + + + + + + +
        +
      • +

        component2

        +
        public javafx.beans.value.ObservableValue<net.corda.client.jfx.model.FlowStatus> component2()
        +
        • +
      + + + +
        +
      • +

        component3

        +
        public javafx.beans.value.ObservableValue<net.corda.client.jfx.model.StateMachineStatus> component3()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public StateMachineData copy(StateMachineRunId id,
+                             javafx.beans.value.ObservableValue<net.corda.client.jfx.model.FlowStatus> flowStatus,
+                             javafx.beans.value.ObservableValue<net.corda.client.jfx.model.StateMachineStatus> stateMachineStatus)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Added.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Added.html new file mode 100644 index 0000000000..4241150741 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Added.html @@ -0,0 +1,256 @@ + + + + + + +StateMachineStatus.Added + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class StateMachineStatus.Added

+
+
+
    +
  • StateMachineStatus
    • +
  • +
      +
    • net.corda.client.jfx.model.StateMachineStatus.Added
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    StateMachineStatus
    +
    +
    +
    +
    public static class StateMachineStatus.Added
+extends StateMachineStatus
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Added

        +
        public Added(java.lang.String stateMachineName)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Removed.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Removed.html new file mode 100644 index 0000000000..58a77bd987 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.Removed.html @@ -0,0 +1,256 @@ + + + + + + +StateMachineStatus.Removed + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class StateMachineStatus.Removed

+
+
+
    +
  • StateMachineStatus
    • +
  • +
      +
    • net.corda.client.jfx.model.StateMachineStatus.Removed
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    StateMachineStatus
    +
    +
    +
    +
    public static class StateMachineStatus.Removed
+extends StateMachineStatus
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Removed

        +
        public Removed(java.lang.String stateMachineName)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.html new file mode 100644 index 0000000000..c32ac8f090 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/StateMachineStatus.html @@ -0,0 +1,266 @@ + + + + + + +StateMachineStatus + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class StateMachineStatus

+
+
+
    +
  • net.corda.client.jfx.model.StateMachineStatus
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        getStateMachineName

        +
        public java.lang.String getStateMachineName()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventSinkDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventSinkDelegate.html new file mode 100644 index 0000000000..4d83f7f514 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventSinkDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.EventSinkDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.EventSinkDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.EventSinkDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.EventSinkDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EventSinkDelegate

        +
        public EventSinkDelegate(kotlin.reflect.KClass<M> klass,
+                         kotlin.jvm.functions.Function1<? super M,? extends error.NonExistentClass> eventSinkProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public NonExistentClass getValue(java.lang.Object thisRef,
+                                 kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getEventSinkProperty

        +
        public kotlin.jvm.functions.Function1<M,NonExistentClass> getEventSinkProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventStreamDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventStreamDelegate.html new file mode 100644 index 0000000000..a50c55c9d6 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.EventStreamDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.EventStreamDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.EventStreamDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.EventStreamDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.EventStreamDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EventStreamDelegate

        +
        public EventStreamDelegate(kotlin.reflect.KClass<M> klass,
+                           kotlin.jvm.functions.Function1<? super M,? extends error.NonExistentClass> eventStreamProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public NonExistentClass getValue(java.lang.Object thisRef,
+                                 kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getEventStreamProperty

        +
        public kotlin.jvm.functions.Function1<M,NonExistentClass> getEventStreamProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObjectPropertyDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObjectPropertyDelegate.html new file mode 100644 index 0000000000..6f72b042fe --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObjectPropertyDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObjectPropertyDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObjectPropertyDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObjectPropertyDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObjectPropertyDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObjectPropertyDelegate

        +
        public ObjectPropertyDelegate(kotlin.reflect.KClass<M> klass,
+                              kotlin.jvm.functions.Function1<? super M,? extends javafx.beans.property.ObjectProperty<T>> objectPropertyProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public javafx.beans.property.ObjectProperty<T> getValue(java.lang.Object thisRef,
+                                                        kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObjectPropertyProperty

        +
        public kotlin.jvm.functions.Function1<M,javafx.beans.property.ObjectProperty> getObjectPropertyProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableDelegate.html new file mode 100644 index 0000000000..c5e5903c15 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObservableDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObservableDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObservableDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObservableDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableDelegate

        +
        public ObservableDelegate(kotlin.reflect.KClass<M> klass,
+                          kotlin.jvm.functions.Function1<? super M,? extends rx.Observable<T>> observableProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public rx.Observable<T> getValue(java.lang.Object thisRef,
+                                 kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObservableProperty

        +
        public kotlin.jvm.functions.Function1<M,rx.Observable> getObservableProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListDelegate.html new file mode 100644 index 0000000000..a7ec31f917 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObservableListDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObservableListDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObservableListDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObservableListDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableListDelegate

        +
        public ObservableListDelegate(kotlin.reflect.KClass<M> klass,
+                              kotlin.jvm.functions.Function1<? super M,? extends javafx.collections.ObservableList<T>> observableListProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public javafx.collections.ObservableList<T> getValue(java.lang.Object thisRef,
+                                                     kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObservableListProperty

        +
        public kotlin.jvm.functions.Function1<M,javafx.collections.ObservableList> getObservableListProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListReadOnlyDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListReadOnlyDelegate.html new file mode 100644 index 0000000000..bbb0e97b12 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableListReadOnlyDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObservableListReadOnlyDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObservableListReadOnlyDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObservableListReadOnlyDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObservableListReadOnlyDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableListReadOnlyDelegate

        +
        public ObservableListReadOnlyDelegate(kotlin.reflect.KClass<M> klass,
+                                      kotlin.jvm.functions.Function1<? super M,? extends javafx.collections.ObservableList<? extends T>> observableListReadOnlyProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public javafx.collections.ObservableList<? extends T> getValue(java.lang.Object thisRef,
+                                                               kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObservableListReadOnlyProperty

        +
        public kotlin.jvm.functions.Function1<M,javafx.collections.ObservableList> getObservableListReadOnlyProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableValueDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableValueDelegate.html new file mode 100644 index 0000000000..4db9cfab55 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObservableValueDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObservableValueDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObservableValueDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObservableValueDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObservableValueDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableValueDelegate

        +
        public ObservableValueDelegate(kotlin.reflect.KClass<M> klass,
+                               kotlin.jvm.functions.Function1<? super M,? extends javafx.beans.value.ObservableValue<T>> observableValueProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public javafx.beans.value.ObservableValue<T> getValue(java.lang.Object thisRef,
+                                                      kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObservableValueProperty

        +
        public kotlin.jvm.functions.Function1<M,javafx.beans.value.ObservableValue> getObservableValueProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObserverDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObserverDelegate.html new file mode 100644 index 0000000000..e419698942 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.ObserverDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.ObserverDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.ObserverDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.ObserverDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.ObserverDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObserverDelegate

        +
        public ObserverDelegate(kotlin.reflect.KClass<M> klass,
+                        kotlin.jvm.functions.Function1<? super M,? extends rx.Observer<T>> observerProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public rx.Observer<T> getValue(java.lang.Object thisRef,
+                               kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getObserverProperty

        +
        public kotlin.jvm.functions.Function1<M,rx.Observer> getObserverProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.SubjectDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.SubjectDelegate.html new file mode 100644 index 0000000000..b801945fc3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.SubjectDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.SubjectDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.SubjectDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.SubjectDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.SubjectDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SubjectDelegate

        +
        public SubjectDelegate(kotlin.reflect.KClass<M> klass,
+                       kotlin.jvm.functions.Function1<? super M,? extends rx.subjects.Subject<T,T>> subjectProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public rx.subjects.Subject<T,T> getValue(java.lang.Object thisRef,
+                                         kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getSubjectProperty

        +
        public kotlin.jvm.functions.Function1<M,rx.subjects.Subject> getSubjectProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.WritableValueDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.WritableValueDelegate.html new file mode 100644 index 0000000000..dea1ee2742 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.WritableValueDelegate.html @@ -0,0 +1,309 @@ + + + + + + +TrackedDelegate.WritableValueDelegate + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate.WritableValueDelegate<M,T>

+
+
+
    +
  • TrackedDelegate
    • +
  • +
      +
    • net.corda.client.jfx.model.TrackedDelegate.WritableValueDelegate<M,T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TrackedDelegate<M>
    +
    +
    +
    +
    public static class TrackedDelegate.WritableValueDelegate<M,T>
+extends TrackedDelegate
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WritableValueDelegate

        +
        public WritableValueDelegate(kotlin.reflect.KClass<M> klass,
+                             kotlin.jvm.functions.Function1<? super M,? extends javafx.beans.value.WritableValue<T>> writableValueProperty)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        public javafx.beans.value.WritableValue<T> getValue(java.lang.Object thisRef,
+                                                    kotlin.reflect.KProperty<?> property)
        +
        • +
      + + + +
        +
      • +

        getWritableValueProperty

        +
        public kotlin.jvm.functions.Function1<M,javafx.beans.value.WritableValue> getWritableValueProperty()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.html new file mode 100644 index 0000000000..9aba3a0ab5 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TrackedDelegate.html @@ -0,0 +1,284 @@ + + + + + + +TrackedDelegate + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TrackedDelegate<M>

+
+
+
    +
  • net.corda.client.jfx.model.TrackedDelegate<M>
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKlass

        +
        public kotlin.reflect.KClass<M> getKlass()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Failed.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Failed.html new file mode 100644 index 0000000000..9d3b4217d2 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Failed.html @@ -0,0 +1,256 @@ + + + + + + +TransactionCreateStatus.Failed + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TransactionCreateStatus.Failed

+
+
+
    +
  • TransactionCreateStatus
    • +
  • +
      +
    • net.corda.client.jfx.model.TransactionCreateStatus.Failed
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TransactionCreateStatus
    +
    +
    +
    +
    public static class TransactionCreateStatus.Failed
+extends TransactionCreateStatus
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Failed

        +
        public Failed(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Started.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Started.html new file mode 100644 index 0000000000..59fae35e8b --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.Started.html @@ -0,0 +1,256 @@ + + + + + + +TransactionCreateStatus.Started + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TransactionCreateStatus.Started

+
+
+
    +
  • TransactionCreateStatus
    • +
  • +
      +
    • net.corda.client.jfx.model.TransactionCreateStatus.Started
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    TransactionCreateStatus
    +
    +
    +
    +
    public static class TransactionCreateStatus.Started
+extends TransactionCreateStatus
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Started

        +
        public Started(java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.html new file mode 100644 index 0000000000..ffe511b73a --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionCreateStatus.html @@ -0,0 +1,266 @@ + + + + + + +TransactionCreateStatus + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TransactionCreateStatus

+
+
+
    +
  • net.corda.client.jfx.model.TransactionCreateStatus
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionDataModel.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionDataModel.html new file mode 100644 index 0000000000..599088ef3b --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/TransactionDataModel.html @@ -0,0 +1,263 @@ + + + + + + +TransactionDataModel + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.model
+

Class TransactionDataModel

+
+
+
    +
  • net.corda.client.jfx.model.TransactionDataModel
    • +
+
+
    +
  • +
    +
    +
    public class TransactionDataModel
    +

    This model provides an observable list of transactions and what state machines/flows recorded them

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TransactionDataModel() +
      This model provides an observable list of transactions and what state machines/flows recorded them
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransactionDataModel

        +
        public TransactionDataModel()
        +

        This model provides an observable list of transactions and what state machines/flows recorded them

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPartiallyResolvedTransactions

        +
        public javafx.collections.ObservableList<net.corda.client.jfx.model.PartiallyResolvedTransaction> getPartiallyResolvedTransactions()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-frame.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-frame.html new file mode 100644 index 0000000000..e78c1f8358 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-frame.html @@ -0,0 +1,42 @@ + + + + + + +net.corda.client.jfx.model + + + + + + +

net.corda.client.jfx.model

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-summary.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-summary.html new file mode 100644 index 0000000000..0368b72dea --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-summary.html @@ -0,0 +1,234 @@ + + + + + + +net.corda.client.jfx.model + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.corda.client.jfx.model

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-tree.html b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-tree.html new file mode 100644 index 0000000000..4ae5f41b07 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/model/package-tree.html @@ -0,0 +1,184 @@ + + + + + + +net.corda.client.jfx.model Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.corda.client.jfx.model

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AggregatedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AggregatedList.html new file mode 100644 index 0000000000..59f806d8f2 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AggregatedList.html @@ -0,0 +1,419 @@ + + + + + + +AggregatedList + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class AggregatedList<A,E,K>

+
+
+
    +
  • net.corda.client.jfx.utils.AggregatedList<A,E,K>
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AggregatedList(javafx.collections.ObservableList<? extends E> list, + kotlin.jvm.functions.Function1<? super E,? extends K> toKey, + kotlin.jvm.functions.Function2<? super K,? super javafx.collections.ObservableList<E>,? extends A> assemble) +
      Given an ObservableList and a grouping key K, class AggregatedList groups the elements by the key into a fresh +ObservableList for each group and exposes the groups as an observable list of As by calling assemble on each.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Aget(int index) 
      kotlin.jvm.functions.Function2<K,javafx.collections.ObservableList,A>getAssemble() 
      intgetSize() 
      intgetSourceIndex(int index) +
      We cannot implement this as aggregations are one to many
      +
      kotlin.jvm.functions.Function1<E,K>getToKey() 
      java.lang.Objectremove(int p) 
      java.lang.ObjectremoveAt(int p) 
      intsize() 
      voidsourceChanged(javafx.collections.ListChangeListener.Change<? extends E> c) 
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AmountBindings.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AmountBindings.html new file mode 100644 index 0000000000..5f22163f50 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AmountBindings.html @@ -0,0 +1,310 @@ + + + + + + +AmountBindings + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class AmountBindings

+
+
+
    +
  • net.corda.client.jfx.utils.AmountBindings
    • +
+
+
    +
  • +
    +
    +
    public class AmountBindings
    +

    Utility bindings for the class Amount type, similar in spirit to Bindings

    +
    +
    See Also:
    +
    class Amount
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static AmountBindingsINSTANCE +
      Utility bindings for the class Amount type, similar in spirit to Bindings
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      javafx.beans.value.ObservableValue<kotlin.Pair>exchange(javafx.beans.value.ObservableValue<java.util.Currency> currency, + javafx.beans.value.ObservableValue<net.corda.client.jfx.model.ExchangeRate> exchangeRate) 
      <T> NonExistentClasssum(javafx.collections.ObservableList<net.corda.core.contracts.Amount> amounts, + T token) 
      javafx.beans.value.ObservableValue<net.corda.core.contracts.Amount>sumAmountExchange(javafx.collections.ObservableList<net.corda.core.contracts.Amount> amounts, + javafx.beans.value.ObservableValue<java.util.Currency> currency, + javafx.beans.value.ObservableValue<net.corda.client.jfx.model.ExchangeRate> exchangeRate) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sum

        +
        public <T> NonExistentClass sum(javafx.collections.ObservableList<net.corda.core.contracts.Amount> amounts,
+                                T token)
        +
        • +
      + + + +
        +
      • +

        exchange

        +
        public javafx.beans.value.ObservableValue<kotlin.Pair> exchange(javafx.beans.value.ObservableValue<java.util.Currency> currency,
+                                                                javafx.beans.value.ObservableValue<net.corda.client.jfx.model.ExchangeRate> exchangeRate)
        +
        • +
      + + + +
        +
      • +

        sumAmountExchange

        +
        public javafx.beans.value.ObservableValue<net.corda.core.contracts.Amount> sumAmountExchange(javafx.collections.ObservableList<net.corda.core.contracts.Amount> amounts,
+                                                                                             javafx.beans.value.ObservableValue<java.util.Currency> currency,
+                                                                                             javafx.beans.value.ObservableValue<net.corda.client.jfx.model.ExchangeRate> exchangeRate)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AssociatedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AssociatedList.html new file mode 100644 index 0000000000..98c085cd9f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/AssociatedList.html @@ -0,0 +1,295 @@ + + + + + + +AssociatedList + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class AssociatedList<K,A,B>

+
+
+
    +
  • ReadOnlyBackedObservableMapBase
    • +
  • +
      +
    • net.corda.client.jfx.utils.AssociatedList<K,A,B>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class AssociatedList<K,A,B>
+extends ReadOnlyBackedObservableMapBase
    +

    class AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

    +
    +
    See Also:
    +
    class AssociatedList
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AssociatedList

        +
        public AssociatedList(javafx.collections.ObservableList<? extends A> sourceList,
+                      kotlin.jvm.functions.Function1<? super A,? extends K> toKey,
+                      kotlin.jvm.functions.Function2<? super K,? super A,? extends B> assemble)
        +

        class AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

        +
        +
        Parameters:
        +
        sourceList - The source list.
        +
        toKey - Function returning the key.
        +
        assemble - The function to assemble the final map element from the list element and the associated key.
        +
        See Also:
        +
        class AssociatedList
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSourceList

        +
        public javafx.collections.ObservableList<? extends A> getSourceList()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ChosenList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ChosenList.html new file mode 100644 index 0000000000..058e781020 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ChosenList.html @@ -0,0 +1,342 @@ + + + + + + +ChosenList + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ChosenList<E>

+
+
+
    +
  • net.corda.client.jfx.utils.ChosenList<E>
    • +
+
+
    +
  • +
    +
    +
    public class ChosenList<E>
    +

    class ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

    Example: +val filteredStates = ChosenList(EasyBind.map(filterCriteriaType) { type -> + when (type) { + is (ByCurrency) -> statesFilteredByCurrency + is (ByIssuer) -> statesFilteredByIssuer + } +})

    The above will create a list that chooses and delegates to the appropriate filtered list based on the type of filter.

    +
    +
    See Also:
    +
    class ChosenList
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ChosenList(javafx.beans.value.ObservableValue<? extends javafx.collections.ObservableList<? extends E>> chosenListObservable) +
      class ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChosenList

        +
        public ChosenList(javafx.beans.value.ObservableValue<? extends javafx.collections.ObservableList<? extends E>> chosenListObservable)
        +

        class ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

        Example: +val filteredStates = ChosenList(EasyBind.map(filterCriteriaType) { type -> + when (type) { + is (ByCurrency) -> statesFilteredByCurrency + is (ByIssuer) -> statesFilteredByIssuer + } +})

        The above will create a list that chooses and delegates to the appropriate filtered list based on the type of filter.

        +
        +
        See Also:
        +
        class ChosenList
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public E get(int index)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public java.lang.Object removeAt(int p)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ConcatenatedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ConcatenatedList.html new file mode 100644 index 0000000000..74c8f8ff78 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ConcatenatedList.html @@ -0,0 +1,358 @@ + + + + + + +ConcatenatedList + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ConcatenatedList<A>

+
+
+
    +
  • net.corda.client.jfx.utils.ConcatenatedList<A>
    • +
+
+
    +
  • +
    +
    +
    public class ConcatenatedList<A>
    +

    class ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

    +
    +
    See Also:
    +
    class ConcatenatedList
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ConcatenatedList(javafx.collections.ObservableList<javafx.collections.ObservableList> sourceList) +
      class ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConcatenatedList

        +
        public ConcatenatedList(javafx.collections.ObservableList<javafx.collections.ObservableList> sourceList)
        +

        class ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

        +
        +
        See Also:
        +
        class ConcatenatedList
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sourceChanged

        +
        public void sourceChanged(javafx.collections.ListChangeListener.Change<? extends javafx.collections.ObservableList<A>> change)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        getSourceIndex

        +
        public int getSourceIndex(int index)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public java.lang.Object removeAt(int p)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.WrappedObservableValue.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.WrappedObservableValue.html new file mode 100644 index 0000000000..d0609ef79a --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.WrappedObservableValue.html @@ -0,0 +1,277 @@ + + + + + + +FlattenedList.WrappedObservableValue + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class FlattenedList.WrappedObservableValue<A>

+
+
+
    +
  • net.corda.client.jfx.utils.FlattenedList.WrappedObservableValue<A>
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    FlattenedList<A>
    +
    +
    +
    +
    public static class FlattenedList.WrappedObservableValue<A>
    +

    We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

    Note that because of the bookkeeping required for this map, any remove operation and any add operation that +inserts to the middle of the list will be O(N) as we need to scan the map and shift indices accordingly.

    Note also that we're wrapping each ObservableValue, this is required because we want to support reusing of +ObservableValues and we need each to have a different hash.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      WrappedObservableValue(javafx.beans.value.ObservableValue<A> observableValue) +
      We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WrappedObservableValue

        +
        public WrappedObservableValue(javafx.beans.value.ObservableValue<A> observableValue)
        +

        We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

        Note that because of the bookkeeping required for this map, any remove operation and any add operation that +inserts to the middle of the list will be O(N) as we need to scan the map and shift indices accordingly.

        Note also that we're wrapping each ObservableValue, this is required because we want to support reusing of +ObservableValues and we need each to have a different hash.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getObservableValue

        +
        public javafx.beans.value.ObservableValue<A> getObservableValue()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.html new file mode 100644 index 0000000000..7f44b2da57 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/FlattenedList.html @@ -0,0 +1,409 @@ + + + + + + +FlattenedList + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class FlattenedList<A>

+
+
+
    +
  • net.corda.client.jfx.utils.FlattenedList<A>
    • +
+
+
    +
  • +
    +
    +
    public class FlattenedList<A>
    +

    class FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

    +
    +
    See Also:
    +
    class FlattenedList
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class FlattenedList.WrappedObservableValue<A> +
      We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FlattenedList(javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>> sourceList) +
      class FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Aget(int index) 
      java.util.HashMap<net.corda.client.jfx.utils.FlattenedList.WrappedObservableValue,kotlin.Pair>getIndexMap() 
      intgetSize() 
      intgetSourceIndex(int index) 
      javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>>getSourceList() 
      java.lang.Objectremove(int p) 
      java.lang.ObjectremoveAt(int p) 
      intsize() 
      voidsourceChanged(javafx.collections.ListChangeListener.Change<? extends javafx.beans.value.ObservableValue<? extends A>> c) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FlattenedList

        +
        public FlattenedList(javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>> sourceList)
        +

        class FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

        +
        +
        See Also:
        +
        class FlattenedList
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexMap

        +
        public java.util.HashMap<net.corda.client.jfx.utils.FlattenedList.WrappedObservableValue,kotlin.Pair> getIndexMap()
        +
        • +
      + + + +
        +
      • +

        sourceChanged

        +
        public void sourceChanged(javafx.collections.ListChangeListener.Change<? extends javafx.beans.value.ObservableValue<? extends A>> c)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        • +
      + + + +
        +
      • +

        getSourceIndex

        +
        public int getSourceIndex(int index)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        getSourceList

        +
        public javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>> getSourceList()
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public java.lang.Object removeAt(int p)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/LeftOuterJoinedMap.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/LeftOuterJoinedMap.html new file mode 100644 index 0000000000..3e3bc34b78 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/LeftOuterJoinedMap.html @@ -0,0 +1,305 @@ + + + + + + +LeftOuterJoinedMap + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class LeftOuterJoinedMap<K,A,B,C>

+
+
+
    +
  • ReadOnlyBackedObservableMapBase
    • +
  • +
      +
    • net.corda.client.jfx.utils.LeftOuterJoinedMap<K,A,B,C>
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class LeftOuterJoinedMap<K,A,B,C>
+extends ReadOnlyBackedObservableMapBase
    +

    class LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

    +
    +
    See Also:
    +
    class LeftOuterJoinedMap
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LeftOuterJoinedMap

        +
        public LeftOuterJoinedMap(javafx.collections.ObservableMap<K,? extends A> leftTable,
+                          javafx.collections.ObservableMap<K,? extends B> rightTable,
+                          kotlin.jvm.functions.Function3<? super K,? super A,? super javafx.beans.value.ObservableValue<B>,? extends C> assemble)
        +

        class LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

        +
        +
        See Also:
        +
        class LeftOuterJoinedMap
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLeftTable

        +
        public javafx.collections.ObservableMap<K,? extends A> getLeftTable()
        +
        • +
      + + + +
        +
      • +

        getRightTable

        +
        public javafx.collections.ObservableMap<K,? extends B> getRightTable()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.Companion.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.Companion.html new file mode 100644 index 0000000000..4834d920d6 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.Companion.html @@ -0,0 +1,241 @@ + + + + + + +MapValuesList.Companion + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class MapValuesList.Companion

+
+
+
    +
  • net.corda.client.jfx.utils.MapValuesList.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    MapValuesList<K,A,C>
    +
    +
    +
    +
    public static class MapValuesList.Companion
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <K,A,C> MapValuesList<K,A,C>create(javafx.collections.ObservableMap<K,A> sourceMap, + kotlin.jvm.functions.Function1<? super java.util.Map.Entry<? extends K,? extends A>,? extends C> assemble) +
      create is the factory of class MapValuesList.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        public <K,A,C> MapValuesList<K,A,C> create(javafx.collections.ObservableMap<K,A> sourceMap,
+                                           kotlin.jvm.functions.Function1<? super java.util.Map.Entry<? extends K,? extends A>,? extends C> assemble)
        +

        create is the factory of class MapValuesList.

        +
        +
        Parameters:
        +
        sourceMap - The source map.
        +
        assemble - The function to be called for map each entry to construct the final list elements.
        +
        See Also:
        +
        class MapValuesList
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.html new file mode 100644 index 0000000000..9a65cfe798 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MapValuesList.html @@ -0,0 +1,775 @@ + + + + + + +MapValuesList + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class MapValuesList<K,A,C>

+
+
+
    +
  • net.corda.client.jfx.utils.MapValuesList<K,A,C>
    • +
+
+
    +
  • +
    +
    +
    public class MapValuesList<K,A,C>
    +

    class MapValuesList takes an ObservableMap and returns its values as an ObservableList. +The order of returned elements is deterministic but unspecified.

    +
    +
    See Also:
    +
    class MapValuesList
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class MapValuesList.Companion 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanadd(C element) 
      voidadd(int index, + C element) 
      booleanaddAll(C p0) 
      booleanaddAll(int index, + java.util.Collection<? extends C> elements) 
      booleanaddAll(java.util.Collection<? extends C> elements) 
      voidaddListener(javafx.beans.InvalidationListener p0) 
      voidaddListener(javafx.collections.ListChangeListener<? super C> p0) 
      voidclear() 
      booleancontains(java.lang.Object element) 
      booleancontainsAll(java.util.Collection<? extends java.lang.Object> elements) 
      Cget(int index) 
      intgetSize() 
      javafx.collections.ObservableMap<K,A>getSourceMap() 
      intindexOf(java.lang.Object element) 
      booleanisEmpty() 
      java.util.Iterator<C>iterator() 
      intlastIndexOf(java.lang.Object element) 
      java.util.ListIterator<C>listIterator() 
      java.util.ListIterator<C>listIterator(int index) 
      booleanremove(java.lang.Object element) 
      voidremove(int p0, + int p1) 
      java.lang.Objectremove(int p) 
      booleanremoveAll(C p0) 
      booleanremoveAll(java.util.Collection<? extends java.lang.Object> elements) 
      CremoveAt(int index) 
      voidremoveListener(javafx.beans.InvalidationListener p0) 
      voidremoveListener(javafx.collections.ListChangeListener<? super C> p0) 
      booleanretainAll(C p0) 
      booleanretainAll(java.util.Collection<? extends java.lang.Object> elements) 
      Cset(int index, + C element) 
      booleansetAll(java.util.Collection<? extends C> p0) 
      booleansetAll(C p0) 
      intsize() 
      java.util.List<C>subList(int fromIndex, + int toIndex) 
      java.lang.Object[]toArray() 
      <T> T[]toArray(T[] p) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSourceMap

        +
        public javafx.collections.ObservableMap<K,A> getSourceMap()
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        add

        +
        public boolean add(C element)
        +
        • +
      + + + +
        +
      • +

        add

        +
        public void add(int index,
+                C element)
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll(C p0)
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll(int index,
+                      java.util.Collection<? extends C> elements)
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll(java.util.Collection<? extends C> elements)
        +
        • +
      + + + +
        +
      • +

        addListener

        +
        public void addListener(javafx.beans.InvalidationListener p0)
        +
        • +
      + + + +
        +
      • +

        addListener

        +
        public void addListener(javafx.collections.ListChangeListener<? super C> p0)
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(java.lang.Object element)
        +
        • +
      + + + +
        +
      • +

        containsAll

        +
        public boolean containsAll(java.util.Collection<? extends java.lang.Object> elements)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public C get(int index)
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public int indexOf(java.lang.Object element)
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<C> iterator()
        +
        • +
      + + + +
        +
      • +

        lastIndexOf

        +
        public int lastIndexOf(java.lang.Object element)
        +
        • +
      + + + +
        +
      • +

        listIterator

        +
        public java.util.ListIterator<C> listIterator()
        +
        • +
      + + + +
        +
      • +

        listIterator

        +
        public java.util.ListIterator<C> listIterator(int index)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove(java.lang.Object element)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public void remove(int p0,
+                   int p1)
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public boolean removeAll(C p0)
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public boolean removeAll(java.util.Collection<? extends java.lang.Object> elements)
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public C removeAt(int index)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      + + + +
        +
      • +

        removeListener

        +
        public void removeListener(javafx.beans.InvalidationListener p0)
        +
        • +
      + + + +
        +
      • +

        removeListener

        +
        public void removeListener(javafx.collections.ListChangeListener<? super C> p0)
        +
        • +
      + + + +
        +
      • +

        retainAll

        +
        public boolean retainAll(C p0)
        +
        • +
      + + + +
        +
      • +

        retainAll

        +
        public boolean retainAll(java.util.Collection<? extends java.lang.Object> elements)
        +
        • +
      + + + +
        +
      • +

        set

        +
        public C set(int index,
+             C element)
        +
        • +
      + + + +
        +
      • +

        setAll

        +
        public boolean setAll(java.util.Collection<? extends C> p0)
        +
        • +
      + + + +
        +
      • +

        setAll

        +
        public boolean setAll(C p0)
        +
        • +
      + + + +
        +
      • +

        subList

        +
        public java.util.List<C> subList(int fromIndex,
+                                 int toIndex)
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public java.lang.Object[] toArray()
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public <T> T[] toArray(T[] p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MappedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MappedList.html new file mode 100644 index 0000000000..642724240e --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/MappedList.html @@ -0,0 +1,379 @@ + + + + + + +MappedList + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class MappedList<A,B>

+
+
+
    +
  • net.corda.client.jfx.utils.MappedList<A,B>
    • +
+
+
    +
  • +
    +
    +
    public class MappedList<A,B>
    +

    This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

    +
    +
    See Also:
    +
    EasyBind.map, +EasyBind.map
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MappedList(javafx.collections.ObservableList<A> list, + kotlin.jvm.functions.Function1<? super A,? extends B> function) +
      This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MappedList

        +
        public MappedList(javafx.collections.ObservableList<A> list,
+                  kotlin.jvm.functions.Function1<? super A,? extends B> function)
        +

        This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

        +
        +
        See Also:
        +
        EasyBind.map, +EasyBind.map
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sourceChanged

        +
        public void sourceChanged(javafx.collections.ListChangeListener.Change<? extends A> change)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public B get(int index)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        getSourceIndex

        +
        public int getSourceIndex(int index)
        +
        • +
      + + + +
        +
      • +

        getFunction

        +
        public kotlin.jvm.functions.Function1<A,B> getFunction()
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public java.lang.Object removeAt(int p)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableFoldKt.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableFoldKt.html new file mode 100644 index 0000000000..a8e8af4899 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableFoldKt.html @@ -0,0 +1,308 @@ + + + + + + +ObservableFoldKt + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ObservableFoldKt

+
+
+
    +
  • net.corda.client.jfx.utils.ObservableFoldKt
    • +
+
+
    +
  • +
    +
    +
    public class ObservableFoldKt
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <T,R> Rfold(rx.Observable<T> $receiver, + R accumulator, + kotlin.jvm.functions.Function2<? super R,? super T,kotlin.Unit> folderFun) +
      fold takes an rx.Observable stream and applies fold function on it, and collects all elements using the accumulator.
      +
      static <A,B> javafx.beans.value.ObservableValue<B>foldToObservableValue(rx.Observable<A> $receiver, + B initial, + kotlin.jvm.functions.Function2<? super A,? super B,? extends B> folderFun) +
      foldToObservableValue takes an rx.Observable stream and creates an ObservableValue out of it.
      +
      static <A,K> javafx.collections.ObservableMap<K,A>recordAsAssociation(rx.Observable<A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends K> toKey, + kotlin.jvm.functions.Function3<? super K,? super A,? super A,? extends A> merge) +
      This variant simply associates each event with its key.
      +
      static <A> javafx.collections.ObservableList<A>recordInSequence(rx.Observable<A> $receiver) +
      recordInSequence records incoming events on the rx.Observable in sequence.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        foldToObservableValue

        +
        public static <A,B> javafx.beans.value.ObservableValue<B> foldToObservableValue(rx.Observable<A> $receiver,
+                                                                                B initial,
+                                                                                kotlin.jvm.functions.Function2<? super A,? super B,? extends B> folderFun)
        +

        foldToObservableValue takes an rx.Observable stream and creates an ObservableValue out of it.

        +
        +
        Parameters:
        +
        initial - The initial value of the returned observable.
        +
        folderFun - The transformation function to be called on the observable value when a new element is emitted on + the stream.
        +
        +
        • +
      + + + +
        +
      • +

        fold

        +
        public static <T,R> R fold(rx.Observable<T> $receiver,
+                           R accumulator,
+                           kotlin.jvm.functions.Function2<? super R,? super T,kotlin.Unit> folderFun)
        +

        fold takes an rx.Observable stream and applies fold function on it, and collects all elements using the accumulator.

        +
        +
        Parameters:
        +
        accumulator - The accumulator for accumulating elements.
        +
        folderFun - The transformation function to be called on the observable list when a new element is emitted on + the stream, which should modify the list as needed.
        +
        +
        • +
      + + + +
        +
      • +

        recordInSequence

        +
        public static <A> javafx.collections.ObservableList<A> recordInSequence(rx.Observable<A> $receiver)
        +

        recordInSequence records incoming events on the rx.Observable in sequence.

        +
        • +
      + + + +
        +
      • +

        recordAsAssociation

        +
        public static <A,K> javafx.collections.ObservableMap<K,A> recordAsAssociation(rx.Observable<A> $receiver,
+                                                                              kotlin.jvm.functions.Function1<? super A,? extends K> toKey,
+                                                                              kotlin.jvm.functions.Function3<? super K,? super A,? super A,? extends A> merge)
        +

        This variant simply associates each event with its key.

        +
        +
        Parameters:
        +
        toKey - Function retrieving the key to associate with.
        +
        merge - The function to be called if there is an existing element at the key.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableUtilitiesKt.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableUtilitiesKt.html new file mode 100644 index 0000000000..171f4d099c --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ObservableUtilitiesKt.html @@ -0,0 +1,857 @@ + + + + + + +ObservableUtilitiesKt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ObservableUtilitiesKt

+
+
+
    +
  • net.corda.client.jfx.utils.ObservableUtilitiesKt
    • +
+
+
    +
  • +
    +
    +
    public class ObservableUtilitiesKt
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <K,A,B> javafx.collections.ObservableMap<K,B>associateBy(javafx.collections.ObservableList<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends K> toKey, + kotlin.jvm.functions.Function2<? super K,? super A,? extends B> assemble) +
      data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap = people.associateBy(Person::name) { name, person -> person.height }
      +
      static <K,A> javafx.collections.ObservableMap<K,A>associateBy(javafx.collections.ObservableList<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends K> toKey) +
      val people: ObservableList = (..) +val nameToPerson: ObservableMap = people.associateBy(Person::name)
      +
      static <K,A,B> javafx.collections.ObservableMap<K,javafx.collections.ObservableList>associateByAggregation(javafx.collections.ObservableList<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends K> toKey, + kotlin.jvm.functions.Function2<? super K,? super A,? extends B> assemble) +
      val people: ObservableList = (..) +val heightToNames: ObservableMap = people.associateByAggregation(Person::height) { name, person -> person.name }
      +
      static <K,A> javafx.collections.ObservableMap<K,javafx.collections.ObservableList>associateByAggregation(javafx.collections.ObservableList<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends K> toKey) +
      val people: ObservableList = (..) +val heightToPeople: ObservableMap = people.associateByAggregation(Person::height)
      +
      static <A,B> javafx.beans.value.ObservableValue<B>bind(javafx.beans.value.ObservableValue<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends javafx.beans.value.ObservableValue<B>> function) +
      data class Person(val height: ObservableValue) +val person: ObservableValue = (..) +val personHeight: ObservableValue = person.bind { it.height }
      +
      static <A,B> javafx.beans.value.ObservableValue<? extends B>bindOut(javafx.beans.value.ObservableValue<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends javafx.beans.value.ObservableValue<? extends B>> function) +
      A variant of bind that has out variance on the output type. This is sometimes useful when kotlin is too eager to +propagate variance constraints and type inference fails.
      +
      static <A> javafx.collections.ObservableList<A>concatenate(javafx.collections.ObservableList<javafx.collections.ObservableList> $receiver) +
      val groups: ObservableList = (..) +val allPeople: ObservableList = groups.concatenate()
      +
      static <A> javafx.collections.ObservableList<A>filter(javafx.collections.ObservableList<? extends A> $receiver, + javafx.beans.value.ObservableValue<kotlin.jvm.functions.Function1> predicate) +
      enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }
      +
      static <A> javafx.collections.ObservableList<A>filterNotNull(javafx.collections.ObservableList<? extends A> $receiver) +
      data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()
      +
      static <A> javafx.beans.value.ObservableValue<A>first(javafx.collections.ObservableList<A> $receiver) 
      static <A> javafx.beans.value.ObservableValue<A>firstOrDefault(javafx.collections.ObservableList<A> $receiver, + javafx.beans.value.ObservableValue<A> p, + kotlin.jvm.functions.Function1<? super A,java.lang.Boolean> predicate) +
      Return first element of the observable list as observable value. +Return provided default value if the list is empty.
      +
      static <A> javafx.beans.value.ObservableValue<A>firstOrNullObservable(javafx.collections.ObservableList<A> $receiver, + kotlin.jvm.functions.Function1<? super A,java.lang.Boolean> predicate) +
      Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.
      +
      static <A> javafx.collections.ObservableList<A>flatten(javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>> $receiver) +
      data class Person(val height: ObservableValue) +val people: ObservableList = (..) +val heights: ObservableList = people.map(Person::height).flatten()
      +
      static <A,B> javafx.beans.value.ObservableValue<B>foldObservable(javafx.collections.ObservableList<? extends A> $receiver, + B initial, + kotlin.jvm.functions.Function2<? super B,? super A,? extends B> folderFunction) +
      val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)
      +
      static <K,V> javafx.collections.ObservableList<java.util.Map.Entry>getObservableEntries(javafx.collections.ObservableMap<K,V> $receiver) +
      val nameToPerson: ObservableMap = (..) +val people: ObservableList = nameToPerson.getObservableValues()
      +
      static <K,V> javafx.beans.value.ObservableValue<V>getObservableValue(javafx.collections.ObservableMap<K,V> $receiver, + K key) +
      val nameToPerson: ObservableMap = (..) +val john: ObservableValue = nameToPerson.getObservableValue("John")
      +
      static <K,V> javafx.collections.ObservableList<V>getObservableValues(javafx.collections.ObservableMap<K,V> $receiver) +
      val nameToPerson: ObservableMap = (..) +val people: ObservableList = nameToPerson.getObservableValues()
      +
      static <A> javafx.beans.value.ObservableValue<A>getValueAt(javafx.collections.ObservableList<A> $receiver, + int index) 
      static javafx.beans.binding.BooleanBindingisNotNull(javafx.beans.value.ObservableValue<?> $receiver) 
      static <A> javafx.beans.value.ObservableValue<A>last(javafx.collections.ObservableList<A> $receiver) 
      static <A,B,C,K> javafx.collections.ObservableList<C>leftOuterJoin(javafx.collections.ObservableList<A> $receiver, + javafx.collections.ObservableList<B> rightTable, + kotlin.jvm.functions.Function1<? super A,? extends K> leftToJoinKey, + kotlin.jvm.functions.Function1<? super B,? extends K> rightToJoinKey, + kotlin.jvm.functions.Function2<? super A,? super javafx.collections.ObservableList<B>,? extends C> assemble) +
      data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }
      +
      static <A,B,K> javafx.collections.ObservableMap<K,kotlin.Pair>leftOuterJoin(javafx.collections.ObservableList<A> $receiver, + javafx.collections.ObservableList<B> rightTable, + kotlin.jvm.functions.Function1<? super A,? extends K> leftToJoinKey, + kotlin.jvm.functions.Function1<? super B,? extends K> rightToJoinKey) +
      data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)
      +
      static <A> javafx.beans.value.ObservableValue<A>lift(A $receiver) +
      val aliceHeight: ObservableValue = (..) +val bobHeight: ObservableValue = (..) +fun sumHeight(a: Long, b: Long): Long { .. }
      +
      static <A,R> javafx.beans.value.ObservableValue<R>lift(kotlin.jvm.functions.Function1<? super A,? extends R> $receiver, + javafx.beans.value.ObservableValue<A> arg0) 
      static <A,B,R> javafx.beans.value.ObservableValue<R>lift(kotlin.jvm.functions.Function2<? super A,? super B,? extends R> $receiver, + javafx.beans.value.ObservableValue<A> arg0, + javafx.beans.value.ObservableValue<B> arg1) 
      static <A,B,C,R> javafx.beans.value.ObservableValue<R>lift(kotlin.jvm.functions.Function3<? super A,? super B,? super C,? extends R> $receiver, + javafx.beans.value.ObservableValue<A> arg0, + javafx.beans.value.ObservableValue<B> arg1, + javafx.beans.value.ObservableValue<C> arg2) 
      static <A,B,C,D,R>
      javafx.beans.value.ObservableValue<R>      		lift(kotlin.jvm.functions.Function4<? super A,? super B,? super C,? super D,? extends R> $receiver, + javafx.beans.value.ObservableValue<A> arg0, + javafx.beans.value.ObservableValue<B> arg1, + javafx.beans.value.ObservableValue<C> arg2, + javafx.beans.value.ObservableValue<D> arg3) 
      static <A,B> javafx.beans.value.ObservableValue<B>map(javafx.beans.value.ObservableValue<? extends A> $receiver, + kotlin.jvm.functions.Function1<? super A,? extends B> function) +
      val person: ObservableValue = (..) +val personName: ObservableValue = person.map { it.name }
      +
      static <A,B> javafx.collections.ObservableList<B>map(javafx.collections.ObservableList<? extends A> $receiver, + boolean cached, + kotlin.jvm.functions.Function1<? super A,? extends B> function) +
      val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }
      +
      static <A> javafx.collections.ObservableList<A>sequence(java.util.Collection<? extends javafx.beans.value.ObservableValue<? extends A>> $receiver) +
      data class Person(val height: ObservableValue) +val people: List = listOf(alice, bob) +val heights: ObservableList = people.map(Person::height).sequence()
      +
      static <T> javafx.collections.ObservableList<T>unique(javafx.collections.ObservableList<T> $receiver) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        map

        +
        public static <A,B> javafx.beans.value.ObservableValue<B> map(javafx.beans.value.ObservableValue<? extends A> $receiver,
+                                                              kotlin.jvm.functions.Function1<? super A,? extends B> function)
        +

        val person: ObservableValue = (..) +val personName: ObservableValue = person.map { it.name }

        +
        • +
      + + + +
        +
      • +

        map

        +
        public static <A,B> javafx.collections.ObservableList<B> map(javafx.collections.ObservableList<? extends A> $receiver,
+                                                             boolean cached,
+                                                             kotlin.jvm.functions.Function1<? super A,? extends B> function)
        +

        val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

        +
        +
        Parameters:
        +
        cached - If true the results of the mapped function are cached in a backing list. If false each get() will + re-run the function.
        +
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A> javafx.beans.value.ObservableValue<A> lift(A $receiver)
        +

        val aliceHeight: ObservableValue = (..) +val bobHeight: ObservableValue = (..) +fun sumHeight(a: Long, b: Long): Long { .. }

        val aliceBobSumHeight = ::sumHeight.lift(aliceHeight, bobHeight) +val aliceHeightPlus2 = ::sumHeight.lift(aliceHeight, 2L.lift())

        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,R> javafx.beans.value.ObservableValue<R> lift(kotlin.jvm.functions.Function1<? super A,? extends R> $receiver,
+                                                               javafx.beans.value.ObservableValue<A> arg0)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,R> javafx.beans.value.ObservableValue<R> lift(kotlin.jvm.functions.Function2<? super A,? super B,? extends R> $receiver,
+                                                                 javafx.beans.value.ObservableValue<A> arg0,
+                                                                 javafx.beans.value.ObservableValue<B> arg1)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C,R> javafx.beans.value.ObservableValue<R> lift(kotlin.jvm.functions.Function3<? super A,? super B,? super C,? extends R> $receiver,
+                                                                   javafx.beans.value.ObservableValue<A> arg0,
+                                                                   javafx.beans.value.ObservableValue<B> arg1,
+                                                                   javafx.beans.value.ObservableValue<C> arg2)
        +
        • +
      + + + +
        +
      • +

        lift

        +
        public static <A,B,C,D,R> javafx.beans.value.ObservableValue<R> lift(kotlin.jvm.functions.Function4<? super A,? super B,? super C,? super D,? extends R> $receiver,
+                                                                     javafx.beans.value.ObservableValue<A> arg0,
+                                                                     javafx.beans.value.ObservableValue<B> arg1,
+                                                                     javafx.beans.value.ObservableValue<C> arg2,
+                                                                     javafx.beans.value.ObservableValue<D> arg3)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public static <A,B> javafx.beans.value.ObservableValue<B> bind(javafx.beans.value.ObservableValue<? extends A> $receiver,
+                                                               kotlin.jvm.functions.Function1<? super A,? extends javafx.beans.value.ObservableValue<B>> function)
        +

        data class Person(val height: ObservableValue) +val person: ObservableValue = (..) +val personHeight: ObservableValue = person.bind { it.height }

        +
        • +
      + + + +
        +
      • +

        bindOut

        +
        public static <A,B> javafx.beans.value.ObservableValue<? extends B> bindOut(javafx.beans.value.ObservableValue<? extends A> $receiver,
+                                                                            kotlin.jvm.functions.Function1<? super A,? extends javafx.beans.value.ObservableValue<? extends B>> function)
        +

        A variant of bind that has out variance on the output type. This is sometimes useful when kotlin is too eager to +propagate variance constraints and type inference fails.

        +
        • +
      + + + +
        +
      • +

        filter

        +
        public static <A> javafx.collections.ObservableList<A> filter(javafx.collections.ObservableList<? extends A> $receiver,
+                                                              javafx.beans.value.ObservableValue<kotlin.jvm.functions.Function1> predicate)
        +

        enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

        val filteredPeople: ObservableList = people.filter(filterCriterion.map(filterFunction))

        +
        • +
      + + + +
        +
      • +

        filterNotNull

        +
        public static <A> javafx.collections.ObservableList<A> filterNotNull(javafx.collections.ObservableList<? extends A> $receiver)
        +

        data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

        +
        • +
      + + + +
        +
      • +

        foldObservable

        +
        public static <A,B> javafx.beans.value.ObservableValue<B> foldObservable(javafx.collections.ObservableList<? extends A> $receiver,
+                                                                         B initial,
+                                                                         kotlin.jvm.functions.Function2<? super B,? super A,? extends B> folderFunction)
        +

        val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

        +
        • +
      + + + +
        +
      • +

        flatten

        +
        public static <A> javafx.collections.ObservableList<A> flatten(javafx.collections.ObservableList<? extends javafx.beans.value.ObservableValue<? extends A>> $receiver)
        +

        data class Person(val height: ObservableValue) +val people: ObservableList = (..) +val heights: ObservableList = people.map(Person::height).flatten()

        +
        • +
      + + + +
        +
      • +

        sequence

        +
        public static <A> javafx.collections.ObservableList<A> sequence(java.util.Collection<? extends javafx.beans.value.ObservableValue<? extends A>> $receiver)
        +

        data class Person(val height: ObservableValue) +val people: List = listOf(alice, bob) +val heights: ObservableList = people.map(Person::height).sequence()

        +
        • +
      + + + +
        +
      • +

        associateBy

        +
        public static <K,A,B> javafx.collections.ObservableMap<K,B> associateBy(javafx.collections.ObservableList<? extends A> $receiver,
+                                                                        kotlin.jvm.functions.Function1<? super A,? extends K> toKey,
+                                                                        kotlin.jvm.functions.Function2<? super K,? super A,? extends B> assemble)
        +

        data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap = people.associateBy(Person::name) { name, person -> person.height }

        +
        • +
      + + + +
        +
      • +

        associateBy

        +
        public static <K,A> javafx.collections.ObservableMap<K,A> associateBy(javafx.collections.ObservableList<? extends A> $receiver,
+                                                                      kotlin.jvm.functions.Function1<? super A,? extends K> toKey)
        +

        val people: ObservableList = (..) +val nameToPerson: ObservableMap = people.associateBy(Person::name)

        +
        • +
      + + + +
        +
      • +

        associateByAggregation

        +
        public static <K,A,B> javafx.collections.ObservableMap<K,javafx.collections.ObservableList> associateByAggregation(javafx.collections.ObservableList<? extends A> $receiver,
+                                                                                                                   kotlin.jvm.functions.Function1<? super A,? extends K> toKey,
+                                                                                                                   kotlin.jvm.functions.Function2<? super K,? super A,? extends B> assemble)
        +

        val people: ObservableList = (..) +val heightToNames: ObservableMap = people.associateByAggregation(Person::height) { name, person -> person.name }

        +
        • +
      + + + +
        +
      • +

        associateByAggregation

        +
        public static <K,A> javafx.collections.ObservableMap<K,javafx.collections.ObservableList> associateByAggregation(javafx.collections.ObservableList<? extends A> $receiver,
+                                                                                                                 kotlin.jvm.functions.Function1<? super A,? extends K> toKey)
        +

        val people: ObservableList = (..) +val heightToPeople: ObservableMap = people.associateByAggregation(Person::height)

        +
        • +
      + + + +
        +
      • +

        getObservableValue

        +
        public static <K,V> javafx.beans.value.ObservableValue<V> getObservableValue(javafx.collections.ObservableMap<K,V> $receiver,
+                                                                             K key)
        +

        val nameToPerson: ObservableMap = (..) +val john: ObservableValue = nameToPerson.getObservableValue("John")

        +
        • +
      + + + +
        +
      • +

        getObservableValues

        +
        public static <K,V> javafx.collections.ObservableList<V> getObservableValues(javafx.collections.ObservableMap<K,V> $receiver)
        +

        val nameToPerson: ObservableMap = (..) +val people: ObservableList = nameToPerson.getObservableValues()

        +
        • +
      + + + +
        +
      • +

        getObservableEntries

        +
        public static <K,V> javafx.collections.ObservableList<java.util.Map.Entry> getObservableEntries(javafx.collections.ObservableMap<K,V> $receiver)
        +

        val nameToPerson: ObservableMap = (..) +val people: ObservableList = nameToPerson.getObservableValues()

        +
        • +
      + + + +
        +
      • +

        concatenate

        +
        public static <A> javafx.collections.ObservableList<A> concatenate(javafx.collections.ObservableList<javafx.collections.ObservableList> $receiver)
        +

        val groups: ObservableList = (..) +val allPeople: ObservableList = groups.concatenate()

        +
        • +
      + + + +
        +
      • +

        leftOuterJoin

        +
        public static <A,B,C,K> javafx.collections.ObservableList<C> leftOuterJoin(javafx.collections.ObservableList<A> $receiver,
+                                                                           javafx.collections.ObservableList<B> rightTable,
+                                                                           kotlin.jvm.functions.Function1<? super A,? extends K> leftToJoinKey,
+                                                                           kotlin.jvm.functions.Function1<? super B,? extends K> rightToJoinKey,
+                                                                           kotlin.jvm.functions.Function2<? super A,? super javafx.collections.ObservableList<B>,? extends C> assemble)
        +

        data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

        +
        • +
      + + + +
        +
      • +

        leftOuterJoin

        +
        public static <A,B,K> javafx.collections.ObservableMap<K,kotlin.Pair> leftOuterJoin(javafx.collections.ObservableList<A> $receiver,
+                                                                                    javafx.collections.ObservableList<B> rightTable,
+                                                                                    kotlin.jvm.functions.Function1<? super A,? extends K> leftToJoinKey,
+                                                                                    kotlin.jvm.functions.Function1<? super B,? extends K> rightToJoinKey)
        +

        data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

        This is the most general left join, given a joining key it returns for each key a pair of relevant elements from the +left and right tables. It is "left outer" in the sense that all members of the left table are guaranteed to be in +the result, but this may not be the case for the right table.

        +
        • +
      + + + +
        +
      • +

        getValueAt

        +
        public static <A> javafx.beans.value.ObservableValue<A> getValueAt(javafx.collections.ObservableList<A> $receiver,
+                                                                   int index)
        +
        • +
      + + + +
        +
      • +

        first

        +
        public static <A> javafx.beans.value.ObservableValue<A> first(javafx.collections.ObservableList<A> $receiver)
        +
        • +
      + + + +
        +
      • +

        last

        +
        public static <A> javafx.beans.value.ObservableValue<A> last(javafx.collections.ObservableList<A> $receiver)
        +
        • +
      + + + +
        +
      • +

        unique

        +
        public static <T> javafx.collections.ObservableList<T> unique(javafx.collections.ObservableList<T> $receiver)
        +
        • +
      + + + +
        +
      • +

        isNotNull

        +
        public static javafx.beans.binding.BooleanBinding isNotNull(javafx.beans.value.ObservableValue<?> $receiver)
        +
        • +
      + + + +
        +
      • +

        firstOrDefault

        +
        public static <A> javafx.beans.value.ObservableValue<A> firstOrDefault(javafx.collections.ObservableList<A> $receiver,
+                                                                       javafx.beans.value.ObservableValue<A> p,
+                                                                       kotlin.jvm.functions.Function1<? super A,java.lang.Boolean> predicate)
        +

        Return first element of the observable list as observable value. +Return provided default value if the list is empty.

        +
        • +
      + + + +
        +
      • +

        firstOrNullObservable

        +
        public static <A> javafx.beans.value.ObservableValue<A> firstOrNullObservable(javafx.collections.ObservableList<A> $receiver,
+                                                                              kotlin.jvm.functions.Function1<? super A,java.lang.Boolean> predicate)
        +

        Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBase.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBase.html new file mode 100644 index 0000000000..177b68fbda --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBase.html @@ -0,0 +1,578 @@ + + + + + + +ReadOnlyBackedObservableMapBase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ReadOnlyBackedObservableMapBase<K,A,B>

+
+
+
    +
  • net.corda.client.jfx.utils.ReadOnlyBackedObservableMapBase<K,A,B>
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - The key type.
    +
    A - The exposed map element type.
    +
    B - Auxiliary data subclasses may wish to store in the backing map.
    +
    +
    +
    Direct Known Subclasses:
    +
    AssociatedList, LeftOuterJoinedMap
    +
    +
    +
    +
    public class ReadOnlyBackedObservableMapBase<K,A,B>
    +

    class ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.

    Non-read-only API calls throw.

    +
    +
    See Also:
    +
    class ReadOnlyBackedObservableMapBase
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddListener(javafx.beans.InvalidationListener listener) 
      voidaddListener(javafx.collections.MapChangeListener<? super K,? super A> listener) 
      voidclear() 
      booleancontainsKey(java.lang.Object key) 
      booleancontainsValue(java.lang.Object value) 
      java.util.SetentrySet() 
      voidfireChange(javafx.collections.MapChangeListener.Change<? extends K,? extends A> change) 
      Aget(java.lang.Object key) 
      java.util.HashMap<K,kotlin.Pair>getBackingMap() 
      java.util.Set<java.util.Map.Entry>getEntries() 
      java.util.Set<K>getKeys() 
      intgetSize() 
      java.util.Collection<A>getValues() 
      booleanisEmpty() 
      java.util.SetkeySet() 
      Aput(K key, + A value) 
      voidputAll(java.util.Map<? extends K,? extends A> from) 
      Aremove(java.lang.Object key) 
      voidremoveListener(javafx.beans.InvalidationListener listener) 
      voidremoveListener(javafx.collections.MapChangeListener<? super K,? super A> listener) 
      intsize() 
      java.util.Collectionvalues() 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getBackingMap

        +
        public java.util.HashMap<K,kotlin.Pair> getBackingMap()
        +
        • +
      + + + +
        +
      • +

        fireChange

        +
        public void fireChange(javafx.collections.MapChangeListener.Change<? extends K,? extends A> change)
        +
        • +
      + + + +
        +
      • +

        addListener

        +
        public void addListener(javafx.beans.InvalidationListener listener)
        +
        • +
      + + + +
        +
      • +

        addListener

        +
        public void addListener(javafx.collections.MapChangeListener<? super K,? super A> listener)
        +
        • +
      + + + +
        +
      • +

        removeListener

        +
        public void removeListener(javafx.beans.InvalidationListener listener)
        +
        • +
      + + + +
        +
      • +

        removeListener

        +
        public void removeListener(javafx.collections.MapChangeListener<? super K,? super A> listener)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey(java.lang.Object key)
        +
        • +
      + + + +
        +
      • +

        containsValue

        +
        public boolean containsValue(java.lang.Object value)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(java.lang.Object key)
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        getEntries

        +
        public java.util.Set<java.util.Map.Entry> getEntries()
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set entrySet()
        +
        • +
      + + + +
        +
      • +

        getKeys

        +
        public java.util.Set<K> getKeys()
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set keySet()
        +
        • +
      + + + +
        +
      • +

        getValues

        +
        public java.util.Collection<A> getValues()
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection values()
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        • +
      + + + +
        +
      • +

        put

        +
        public A put(K key,
+             A value)
        +
        • +
      + + + +
        +
      • +

        putAll

        +
        public void putAll(java.util.Map<? extends K,? extends A> from)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public A remove(java.lang.Object key)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBaseKt.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBaseKt.html new file mode 100644 index 0000000000..c9adf8b0fb --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReadOnlyBackedObservableMapBaseKt.html @@ -0,0 +1,231 @@ + + + + + + +ReadOnlyBackedObservableMapBaseKt + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ReadOnlyBackedObservableMapBaseKt

+
+
+
    +
  • net.corda.client.jfx.utils.ReadOnlyBackedObservableMapBaseKt
    • +
+
+
    +
  • +
    +
    +
    public class ReadOnlyBackedObservableMapBaseKt
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <A,K> javafx.collections.MapChangeListener.Change<K,A>createMapChange(javafx.collections.ObservableMap<K,A> $receiver, + K key, + A removedValue, + A addedValue) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createMapChange

        +
        public static <A,K> javafx.collections.MapChangeListener.Change<K,A> createMapChange(javafx.collections.ObservableMap<K,A> $receiver,
+                                                                                     K key,
+                                                                                     A removedValue,
+                                                                                     A addedValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReplayedList.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReplayedList.html new file mode 100644 index 0000000000..ab2e81a706 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/ReplayedList.html @@ -0,0 +1,364 @@ + + + + + + +ReplayedList + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.jfx.utils
+

Class ReplayedList<A>

+
+
+
    +
  • net.corda.client.jfx.utils.ReplayedList<A>
    • +
+
+
    +
  • +
    +
    +
    public class ReplayedList<A>
    +

    This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ReplayedList(javafx.collections.ObservableList<A> sourceList) +
      This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReplayedList

        +
        public ReplayedList(javafx.collections.ObservableList<A> sourceList)
        +

        This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReplayedList

        +
        public java.util.ArrayList<A> getReplayedList()
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        • +
      + + + +
        +
      • +

        sourceChanged

        +
        public void sourceChanged(javafx.collections.ListChangeListener.Change<? extends A> c)
        +
        • +
      + + + +
        +
      • +

        getSourceIndex

        +
        public int getSourceIndex(int index)
        +
        • +
      + + + +
        +
      • +

        get

        +
        public A get(int index)
        +
        • +
      + + + +
        +
      • +

        removeAt

        +
        public java.lang.Object removeAt(int p)
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public java.lang.Object remove(int p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-frame.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-frame.html new file mode 100644 index 0000000000..bd07d72353 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-frame.html @@ -0,0 +1,35 @@ + + + + + + +net.corda.client.jfx.utils + + + + + + +

net.corda.client.jfx.utils

+
+

Classes

+ +
+ + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-summary.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-summary.html new file mode 100644 index 0000000000..5cff576351 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-summary.html @@ -0,0 +1,227 @@ + + + + + + +net.corda.client.jfx.utils + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.corda.client.jfx.utils

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AggregatedList<A,E,K> +
    Given an ObservableList and a grouping key K, class AggregatedList groups the elements by the key into a fresh +ObservableList for each group and exposes the groups as an observable list of As by calling assemble on each.
    +
    AmountBindings +
    Utility bindings for the class Amount type, similar in spirit to Bindings
    +
    AssociatedList<K,A,B> +
    class AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!
    +
    ChosenList<E> +
    class ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.
    +
    ConcatenatedList<A> +
    class ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.
    +
    FlattenedList<A> +
    class FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.
    +
    LeftOuterJoinedMap<K,A,B,C> +
    class LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.
    +
    MapValuesList<K,A,C> +
    class MapValuesList takes an ObservableMap and returns its values as an ObservableList. +The order of returned elements is deterministic but unspecified.
    +
    MappedList<A,B> +
    This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.
    +
    ObservableFoldKt 
    ObservableUtilitiesKt 
    ReadOnlyBackedObservableMapBase<K,A,B> +
    class ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.
    +
    ReadOnlyBackedObservableMapBaseKt 
    ReplayedList<A> +
    This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-tree.html b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-tree.html new file mode 100644 index 0000000000..31d0dfb66b --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/jfx/utils/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +net.corda.client.jfx.utils Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.corda.client.jfx.utils

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClient.html b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClient.html new file mode 100644 index 0000000000..1f42e808d8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClient.html @@ -0,0 +1,555 @@ + + + + + + +CordaRPCClient + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.rpc
+

Class CordaRPCClient

+
+
+
    +
  • net.corda.client.rpc.CordaRPCClient
    • +
+
+
    +
  • +
    +
    +
    public class CordaRPCClient
    +

    An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static net.corda.client.rpc.CordaRPCClient.CompanionCompanion 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CordaRPCClient(com.google.common.net.HostAndPort host, + net.corda.nodeapi.config.SSLConfiguration config, + kotlin.jvm.functions.Function1<? super org.apache.activemq.artemis.api.core.client.ServerLocator,kotlin.Unit> serviceConfigurationOverride) +
      An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Shuts down the client and lets the server know it can free the used resources (in a nice way).
      +
      net.corda.nodeapi.config.SSLConfigurationgetConfig() 
      com.google.common.net.HostAndPortgetHost() 
      kotlin.jvm.functions.Function1<org.apache.activemq.artemis.api.core.client.ServerLocator,kotlin.Unit>getServiceConfigurationOverride() 
      CordaRPCOpsproxy(java.time.Duration timeout, + int minVersion) +
      Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.
      +
      CordaRPCOpsproxy(java.time.Duration timeout) +
      Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.
      +
      CordaRPCOpsproxy() +
      Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.
      +
      CordaRPCClientstart(java.lang.String username, + java.lang.String password) +
      Opens the connection to the server with the given username and password, then returns itself. +Registers a JVM shutdown hook to cleanly disconnect.
      +
      <T> Tuse(java.lang.String username, + java.lang.String password, + kotlin.jvm.functions.Function1<? super net.corda.core.messaging.CordaRPCOps,? extends T> block) +
      A convenience function that opens a connection with the given credentials, executes the given code block with all +available RPCs in scope and shuts down the RPC connection again. It's meant for quick prototyping and demos. For +more control you probably want to control the lifecycle of the client and proxies independently, as well as +configuring a timeout and other such features via the proxy method.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        Companion

        +
        public static net.corda.client.rpc.CordaRPCClient.Companion Companion
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CordaRPCClient

        +
        public CordaRPCClient(com.google.common.net.HostAndPort host,
+                      net.corda.nodeapi.config.SSLConfiguration config,
+                      kotlin.jvm.functions.Function1<? super org.apache.activemq.artemis.api.core.client.ServerLocator,kotlin.Unit> serviceConfigurationOverride)
        +

        An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

        +
        +
        Parameters:
        +
        host - The hostname and messaging port of the node.
        +
        config - If specified, the SSL configuration to use. If not specified, SSL will be disabled and the node will only be authenticated on non-SSL RPC port, the RPC traffic with not be encrypted when SSL is disabled.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        start

        +
        public CordaRPCClient start(java.lang.String username,
+                            java.lang.String password)
        +

        Opens the connection to the server with the given username and password, then returns itself. +Registers a JVM shutdown hook to cleanly disconnect.

        +
        • +
      + + + +
        +
      • +

        use

        +
        public <T> T use(java.lang.String username,
+                 java.lang.String password,
+                 kotlin.jvm.functions.Function1<? super net.corda.core.messaging.CordaRPCOps,? extends T> block)
        +

        A convenience function that opens a connection with the given credentials, executes the given code block with all +available RPCs in scope and shuts down the RPC connection again. It's meant for quick prototyping and demos. For +more control you probably want to control the lifecycle of the client and proxies independently, as well as +configuring a timeout and other such features via the proxy method.

        After this method returns the client is closed and can't be restarted.

        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +

        Shuts down the client and lets the server know it can free the used resources (in a nice way).

        +
        • +
      + + + +
        +
      • +

        proxy

        +
        public CordaRPCOps proxy(java.time.Duration timeout,
+                         int minVersion)
        +

        Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.

        Creation of a proxy is a somewhat expensive operation that involves calls to the server, so if you want to do +calls from many threads at once you should cache one proxy per thread and reuse them. This function itself is +thread safe though so requires no extra synchronisation.

        RPC sends and receives are logged on the net.corda.rpc logger.

        By default there are no timeouts on calls. This is deliberate, RPCs without timeouts can survive restarts, +maintenance downtime and moves of the server. RPCs can survive temporary losses or changes in client connectivity, +like switching between wifi networks. You can specify a timeout on the level of a proxy. If a call times +out it will throw RPCException.Deadline.

        The interface CordaRPCOps defines what client RPCs are available. If an RPC returns an Observable anywhere in the +object graph returned then the server-side observable is transparently linked to a messaging queue, and that +queue linked to another observable on the client side here. You are expected to use it. The server will begin +buffering messages immediately that it will expect you to drain by subscribing to the returned observer. You can +opt-out of this by simply casting the Observable to Closeable or AutoCloseable and then calling the close +method on it. You don't have to explicitly close the observable if you actually subscribe to it: it will close +itself and free up the server-side resources either when the client or JVM itself is shutdown, or when there are +no more subscribers to it. Once all the subscribers to a returned observable are unsubscribed, the observable is +closed and you can't then re-subscribe again: you'll have to re-request a fresh observable with another RPC.

        The proxy and linked observables consume some small amount of resources on the server. It's OK to just exit your +process and let the server clean up, but in a long running process where you only need something for a short +amount of time it is polite to cast the objects to Closeable or AutoCloseable and close it when you are done. +Finalizers are in place to warn you if you lose a reference to an unclosed proxy or observable.

        +
        +
        Throws:
        +
        - if the server version is too low or if the server isn't reachable within the given time.
        +
        See Also:
        +
        RPCException.Deadline, +interface CordaRPCOps, +Closeable, +AutoCloseable, +Closeable, +AutoCloseable
        +
        +
        • +
      + + + +
        +
      • +

        proxy

        +
        public CordaRPCOps proxy(java.time.Duration timeout)
        +

        Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.

        Creation of a proxy is a somewhat expensive operation that involves calls to the server, so if you want to do +calls from many threads at once you should cache one proxy per thread and reuse them. This function itself is +thread safe though so requires no extra synchronisation.

        RPC sends and receives are logged on the net.corda.rpc logger.

        By default there are no timeouts on calls. This is deliberate, RPCs without timeouts can survive restarts, +maintenance downtime and moves of the server. RPCs can survive temporary losses or changes in client connectivity, +like switching between wifi networks. You can specify a timeout on the level of a proxy. If a call times +out it will throw RPCException.Deadline.

        The interface CordaRPCOps defines what client RPCs are available. If an RPC returns an Observable anywhere in the +object graph returned then the server-side observable is transparently linked to a messaging queue, and that +queue linked to another observable on the client side here. You are expected to use it. The server will begin +buffering messages immediately that it will expect you to drain by subscribing to the returned observer. You can +opt-out of this by simply casting the Observable to Closeable or AutoCloseable and then calling the close +method on it. You don't have to explicitly close the observable if you actually subscribe to it: it will close +itself and free up the server-side resources either when the client or JVM itself is shutdown, or when there are +no more subscribers to it. Once all the subscribers to a returned observable are unsubscribed, the observable is +closed and you can't then re-subscribe again: you'll have to re-request a fresh observable with another RPC.

        The proxy and linked observables consume some small amount of resources on the server. It's OK to just exit your +process and let the server clean up, but in a long running process where you only need something for a short +amount of time it is polite to cast the objects to Closeable or AutoCloseable and close it when you are done. +Finalizers are in place to warn you if you lose a reference to an unclosed proxy or observable.

        +
        +
        Throws:
        +
        - if the server version is too low or if the server isn't reachable within the given time.
        +
        See Also:
        +
        RPCException.Deadline, +interface CordaRPCOps, +Closeable, +AutoCloseable, +Closeable, +AutoCloseable
        +
        +
        • +
      + + + +
        +
      • +

        proxy

        +
        public CordaRPCOps proxy()
        +

        Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.

        Creation of a proxy is a somewhat expensive operation that involves calls to the server, so if you want to do +calls from many threads at once you should cache one proxy per thread and reuse them. This function itself is +thread safe though so requires no extra synchronisation.

        RPC sends and receives are logged on the net.corda.rpc logger.

        By default there are no timeouts on calls. This is deliberate, RPCs without timeouts can survive restarts, +maintenance downtime and moves of the server. RPCs can survive temporary losses or changes in client connectivity, +like switching between wifi networks. You can specify a timeout on the level of a proxy. If a call times +out it will throw RPCException.Deadline.

        The interface CordaRPCOps defines what client RPCs are available. If an RPC returns an Observable anywhere in the +object graph returned then the server-side observable is transparently linked to a messaging queue, and that +queue linked to another observable on the client side here. You are expected to use it. The server will begin +buffering messages immediately that it will expect you to drain by subscribing to the returned observer. You can +opt-out of this by simply casting the Observable to Closeable or AutoCloseable and then calling the close +method on it. You don't have to explicitly close the observable if you actually subscribe to it: it will close +itself and free up the server-side resources either when the client or JVM itself is shutdown, or when there are +no more subscribers to it. Once all the subscribers to a returned observable are unsubscribed, the observable is +closed and you can't then re-subscribe again: you'll have to re-request a fresh observable with another RPC.

        The proxy and linked observables consume some small amount of resources on the server. It's OK to just exit your +process and let the server clean up, but in a long running process where you only need something for a short +amount of time it is polite to cast the objects to Closeable or AutoCloseable and close it when you are done. +Finalizers are in place to warn you if you lose a reference to an unclosed proxy or observable.

        +
        +
        Throws:
        +
        - if the server version is too low or if the server isn't reachable within the given time.
        +
        See Also:
        +
        RPCException.Deadline, +interface CordaRPCOps, +Closeable, +AutoCloseable, +Closeable, +AutoCloseable
        +
        +
        • +
      + + + +
        +
      • +

        getHost

        +
        public com.google.common.net.HostAndPort getHost()
        +
        • +
      + + + +
        +
      • +

        getConfig

        +
        public net.corda.nodeapi.config.SSLConfiguration getConfig()
        +
        • +
      + + + +
        +
      • +

        getServiceConfigurationOverride

        +
        public kotlin.jvm.functions.Function1<org.apache.activemq.artemis.api.core.client.ServerLocator,kotlin.Unit> getServiceConfigurationOverride()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.Companion.html b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.Companion.html new file mode 100644 index 0000000000..613b66ab09 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.Companion.html @@ -0,0 +1,174 @@ + + + + + + +CordaRPCClientImpl.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.rpc
+

Class CordaRPCClientImpl.Companion

+
+
+
    +
  • net.corda.client.rpc.CordaRPCClientImpl.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    CordaRPCClientImpl
    +
    +
    +
    +
    public static class CordaRPCClientImpl.Companion
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.ObservableDeserializer.html b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.ObservableDeserializer.html new file mode 100644 index 0000000000..fc61075246 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.ObservableDeserializer.html @@ -0,0 +1,285 @@ + + + + + + +CordaRPCClientImpl.ObservableDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.client.rpc
+

Class CordaRPCClientImpl.ObservableDeserializer

+
+
+
    +
  • net.corda.client.rpc.CordaRPCClientImpl.ObservableDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    CordaRPCClientImpl
    +
    +
    +
    +
    public static class CordaRPCClientImpl.ObservableDeserializer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      rx.Observable<java.lang.Object>read(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Input input, + java.lang.Class<rx.Observable> type) 
      voidwrite(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Output output, + rx.Observable<java.lang.Object> object) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableDeserializer

        +
        public ObservableDeserializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public rx.Observable<java.lang.Object> read(com.esotericsoftware.kryo.Kryo kryo,
+                                            com.esotericsoftware.kryo.io.Input input,
+                                            java.lang.Class<rx.Observable> type)
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(com.esotericsoftware.kryo.Kryo kryo,
+                  com.esotericsoftware.kryo.io.Output output,
+                  rx.Observable<java.lang.Object> object)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.html b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.html new file mode 100644 index 0000000000..f80b9d8e37 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImpl.html @@ -0,0 +1,384 @@ + + + + + + +CordaRPCClientImpl + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.client.rpc
+

Class CordaRPCClientImpl

+
+
+
    +
  • net.corda.client.rpc.CordaRPCClientImpl
    • +
+
+
    +
  • +
    +
    +
    public class CordaRPCClientImpl
    +

    Core RPC engine implementation, to learn how to use RPC you should be looking at class CordaRPCClient.

    Design notes

    The way RPCs are handled is fairly standard except for the handling of observables. When an RPC might return +an Observable it is specially tagged. This causes the client to create a new transient queue for the +receiving of observables and their observations with a random ID in the name. This ID is sent to the server in +a message header. All observations are sent via this single queue.

    The reason for doing it this way and not the more obvious approach of one-queue-per-observable is that we want +the queues to be transient, meaning their lifetime in the broker is tied to the session that created them. +A server side observable and its associated queue is not a cost-free thing, let alone the memory and resources +needed to actually generate the observations themselves, therefore we want to ensure these cannot leak. A +transient queue will be deleted automatically if the client session terminates, which by default happens on +disconnect but can also be configured to happen after a short delay (this allows clients to e.g. switch IP +address). On the server the deletion of the observations queue triggers unsubscription from the associated +observables, which in turn may then be garbage collected.

    Creating a transient queue requires a roundtrip to the broker and thus doing an RPC that could return +observables takes two server roundtrips instead of one. That's why we require RPCs to be marked with +interface RPCReturnsObservables as needing this special treatment instead of always doing it.

    If the Artemis/JMS APIs allowed us to create transient queues assigned to someone else then we could +potentially use a different design in which the node creates new transient queues (one per observable) on the +fly. The client would then have to watch out for this and start consuming those queues as they were created.

    We use one queue per RPC because we don't know ahead of time how many observables the server might return and +often the server doesn't know either, which pushes towards a single queue design, but at the same time the +processing of observations returned by an RPC might be striped across multiple threads and we'd like +backpressure management to not be scoped per client process but with more granularity. So we end up with +a compromise where the unit of backpressure management is the response to a single RPC.

    TODO: Backpressure isn't propagated all the way through the MQ broker at the moment.

    +
    +
    See Also:
    +
    class CordaRPCClient, +interface RPCReturnsObservables
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CordaRPCClientImpl

        +
        public CordaRPCClientImpl(org.apache.activemq.artemis.api.core.client.ClientSession session,
+                          java.util.concurrent.locks.ReentrantLock sessionLock,
+                          java.lang.String username)
        +

        Core RPC engine implementation, to learn how to use RPC you should be looking at class CordaRPCClient.

        Design notes

        The way RPCs are handled is fairly standard except for the handling of observables. When an RPC might return +an Observable it is specially tagged. This causes the client to create a new transient queue for the +receiving of observables and their observations with a random ID in the name. This ID is sent to the server in +a message header. All observations are sent via this single queue.

        The reason for doing it this way and not the more obvious approach of one-queue-per-observable is that we want +the queues to be transient, meaning their lifetime in the broker is tied to the session that created them. +A server side observable and its associated queue is not a cost-free thing, let alone the memory and resources +needed to actually generate the observations themselves, therefore we want to ensure these cannot leak. A +transient queue will be deleted automatically if the client session terminates, which by default happens on +disconnect but can also be configured to happen after a short delay (this allows clients to e.g. switch IP +address). On the server the deletion of the observations queue triggers unsubscription from the associated +observables, which in turn may then be garbage collected.

        Creating a transient queue requires a roundtrip to the broker and thus doing an RPC that could return +observables takes two server roundtrips instead of one. That's why we require RPCs to be marked with +interface RPCReturnsObservables as needing this special treatment instead of always doing it.

        If the Artemis/JMS APIs allowed us to create transient queues assigned to someone else then we could +potentially use a different design in which the node creates new transient queues (one per observable) on the +fly. The client would then have to watch out for this and start consuming those queues as they were created.

        We use one queue per RPC because we don't know ahead of time how many observables the server might return and +often the server doesn't know either, which pushes towards a single queue design, but at the same time the +processing of observations returned by an RPC might be striped across multiple threads and we'd like +backpressure management to not be scoped per client process but with more granularity. So we end up with +a compromise where the unit of backpressure management is the response to a single RPC.

        TODO: Backpressure isn't propagated all the way through the MQ broker at the moment.

        +
        +
        See Also:
        +
        class CordaRPCClient, +interface RPCReturnsObservables
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        proxyFor

        +
        public <T extends RPCOps> T proxyFor(java.lang.Class<T> rpcInterface,
+                                     java.time.Duration timeout,
+                                     int minVersion)
        +

        Builds a proxy for the given type, which must descend from interface RPCOps.

        +
        +
        See Also:
        +
        interface RPCOps
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImplKt.html b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImplKt.html new file mode 100644 index 0000000000..a30ac76d9f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/CordaRPCClientImplKt.html @@ -0,0 +1,245 @@ + + + + + + +CordaRPCClientImplKt + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.client.rpc
+

Class CordaRPCClientImplKt

+
+
+
    +
  • net.corda.client.rpc.CordaRPCClientImplKt
    • +
+
+
    +
  • +
    +
    +
    public class CordaRPCClientImplKt
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createRPCKryoForDeserialization

        +
        public static com.esotericsoftware.kryo.Kryo createRPCKryoForDeserialization(CordaRPCClientImpl rpcClient,
+                                                                             java.lang.String qName,
+                                                                             java.lang.String rpcName,
+                                                                             java.lang.Throwable rpcLocation)
        +
        • +
      + + + +
        +
      • +

        releaseRPCKryoForDeserialization

        +
        public static void releaseRPCKryoForDeserialization(com.esotericsoftware.kryo.Kryo kryo)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/package-frame.html b/docs/build/html/api/javadoc/net/corda/client/rpc/package-frame.html new file mode 100644 index 0000000000..4e5a5463e0 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +net.corda.client.rpc + + + + + + +

net.corda.client.rpc

+
+

Classes

+ +
+ + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/package-summary.html b/docs/build/html/api/javadoc/net/corda/client/rpc/package-summary.html new file mode 100644 index 0000000000..3a3f0a2468 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/package-summary.html @@ -0,0 +1,155 @@ + + + + + + +net.corda.client.rpc + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.corda.client.rpc

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CordaRPCClient +
    An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.
    +
    CordaRPCClientImpl +
    Core RPC engine implementation, to learn how to use RPC you should be looking at class CordaRPCClient.
    +
    CordaRPCClientImplKt 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/client/rpc/package-tree.html b/docs/build/html/api/javadoc/net/corda/client/rpc/package-tree.html new file mode 100644 index 0000000000..e9c9c0ba70 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/client/rpc/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +net.corda.client.rpc Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.corda.client.rpc

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/Crypto.html b/docs/build/html/api/javadoc/net/corda/core/crypto/Crypto.html new file mode 100644 index 0000000000..5ceb7470e3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/Crypto.html @@ -0,0 +1,740 @@ + + + + + + +Crypto + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.crypto
+

Class Crypto

+
+
+
    +
  • net.corda.core.crypto.Crypto
    • +
+
+
    +
  • +
    +
    +
    public class Crypto
    +

    This object controls and provides the available and supported signature schemes for Corda. +Any implemented class SignatureScheme should be strictly defined here. +However, only the schemes returned by {@link #listSupportedSignatureSchemes()} are supported. +Note that Corda currently supports the following signature schemes by their code names:

    +
    +
    See Also:
    +
    class SignatureScheme
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static CryptoINSTANCE +
      This object controls and provides the available and supported signature schemes for Corda. +Any implemented class SignatureScheme should be strictly defined here. +However, only the schemes returned by {@link #listSupportedSignatureSchemes()} are supported. +Note that Corda currently supports the following signature schemes by their code names:
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.security.PrivateKeydecodePrivateKey(byte[] encodedKey) +
      Decode a PKCS8 encoded key to its PrivateKey object.
      +
      java.security.PrivateKeydecodePrivateKey(byte[] encodedKey, + java.lang.String schemeCodeName) +
      Decode a PKCS8 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.
      +
      java.security.PublicKeydecodePublicKey(byte[] encodedKey) +
      Decode an X509 encoded key to its PublicKey object.
      +
      java.security.PublicKeydecodePublicKey(byte[] encodedKey, + java.lang.String schemeCodeName) +
      Decode an X509 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.
      +
      byte[]doSign(java.security.PrivateKey privateKey, + byte[] clearData) +
      Generic way to sign ByteArray data with a PrivateKey. Strategy on on identifying the actual signing scheme is based +on the PrivateKey type, but if the schemeCodeName is known, then better use doSign(signatureScheme: String, privateKey: PrivateKey, clearData: ByteArray).
      +
      byte[]doSign(java.lang.String schemeCodeName, + java.security.PrivateKey privateKey, + byte[] clearData) +
      Generic way to sign ByteArray data with a PrivateKey and a known schemeCodeName String.
      +
      TransactionSignaturedoSign(java.security.PrivateKey privateKey, + MetaData metaData) +
      Generic way to sign class MetaData objects with a PrivateKey. +class MetaData is a wrapper over the transaction's Merkle root in order to attach extra information, such as a timestamp or partial and blind signature indicators.
      +
      booleandoVerify(java.lang.String schemeCodeName, + java.security.PublicKey publicKey, + byte[] signatureData, + byte[] clearData) +
      Utility to simplify the act of verifying a digital signature. +It returns true if it succeeds, but it always throws an exception if verification fails.
      +
      booleandoVerify(java.security.PublicKey publicKey, + byte[] signatureData, + byte[] clearData) +
      Utility to simplify the act of verifying a digital signature by identifying the signature scheme used from the input public key's type. +It returns true if it succeeds, but it always throws an exception if verification fails. +Strategy on identifying the actual signing scheme is based on the PublicKey type, but if the schemeCodeName is known, +then better use doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray).
      +
      booleandoVerify(java.security.PublicKey publicKey, + TransactionSignature transactionSignature) +
      Utility to simplify the act of verifying a class TransactionSignature. +It returns true if it succeeds, but it always throws an exception if verification fails.
      +
      java.lang.StringfindSignatureSchemeCodeName(java.security.Key key) +
      Retrieve the corresponding signature scheme code name based on the type of the input Key. +See class Crypto for the supported scheme code names.
      +
      java.security.KeyPairgenerateKeyPair(java.lang.String schemeCodeName) +
      Utility to simplify the act of generating keys. +Normally, we don't expect other errors here, assuming that key generation parameters for every supported signature scheme have been unit-tested.
      +
      java.security.KeyPairgenerateKeyPair() +
      Generate a KeyPair using the default signature scheme.
      +
      java.lang.StringgetDefaultSignatureSchemeCodeName() 
      booleanisSupportedSignatureScheme(java.lang.String schemeCodeName) +
      Check if the requested signature scheme is supported by the system.
      +
      java.util.List<java.lang.String>listSupportedSignatureSchemes() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INSTANCE

        +
        public static Crypto INSTANCE
        +

        This object controls and provides the available and supported signature schemes for Corda. +Any implemented class SignatureScheme should be strictly defined here. +However, only the schemes returned by {@link #listSupportedSignatureSchemes()} are supported. +Note that Corda currently supports the following signature schemes by their code names:

        +
        +
        See Also:
        +
        class SignatureScheme
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        findSignatureSchemeCodeName

        +
        public java.lang.String findSignatureSchemeCodeName(java.security.Key key)
        +

        Retrieve the corresponding signature scheme code name based on the type of the input Key. +See class Crypto for the supported scheme code names.

        +
        +
        Parameters:
        +
        key - either private or public.
        +
        Returns:
        +
        signatureSchemeCodeName for a Key.
        +
        Throws:
        +
        - if the requested key type is not supported.
        +
        See Also:
        +
        Key, +class Crypto
        +
        +
        • +
      + + + +
        +
      • +

        decodePrivateKey

        +
        public java.security.PrivateKey decodePrivateKey(byte[] encodedKey)
        +

        Decode a PKCS8 encoded key to its PrivateKey object.

        +
        +
        Parameters:
        +
        encodedKey - a PKCS8 encoded private key.
        +
        Throws:
        +
        - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key.
        +
        See Also:
        +
        PrivateKey
        +
        +
        • +
      + + + +
        +
      • +

        decodePrivateKey

        +
        public java.security.PrivateKey decodePrivateKey(byte[] encodedKey,
+                                                 java.lang.String schemeCodeName)
        +

        Decode a PKCS8 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

        +
        +
        Parameters:
        +
        encodedKey - a PKCS8 encoded private key.
        +
        schemeCodeName - a String that should match a key in supportedSignatureSchemes map (e.g. ECDSA_SECP256K1_SHA256).
        +
        Throws:
        +
        - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key.
        +
        See Also:
        +
        PrivateKey
        +
        +
        • +
      + + + +
        +
      • +

        decodePublicKey

        +
        public java.security.PublicKey decodePublicKey(byte[] encodedKey)
        +

        Decode an X509 encoded key to its PublicKey object.

        +
        +
        Parameters:
        +
        encodedKey - an X509 encoded public key.
        +
        Throws:
        +
        - on not supported scheme.
        +
        - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key.
        +
        See Also:
        +
        PublicKey
        +
        +
        • +
      + + + +
        +
      • +

        decodePublicKey

        +
        public java.security.PublicKey decodePublicKey(byte[] encodedKey,
+                                               java.lang.String schemeCodeName)
        +

        Decode an X509 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

        +
        +
        Parameters:
        +
        encodedKey - an X509 encoded public key.
        +
        schemeCodeName - a String that should match a key in supportedSignatureSchemes map (e.g. ECDSA_SECP256K1_SHA256).
        +
        Throws:
        +
        - if the requested scheme is not supported
        +
        - if the given key specification +is inappropriate for this key factory to produce a public key.
        +
        See Also:
        +
        PrivateKey
        +
        +
        • +
      + + + +
        +
      • +

        generateKeyPair

        +
        public java.security.KeyPair generateKeyPair(java.lang.String schemeCodeName)
        +

        Utility to simplify the act of generating keys. +Normally, we don't expect other errors here, assuming that key generation parameters for every supported signature scheme have been unit-tested.

        +
        +
        Parameters:
        +
        schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256).
        +
        Returns:
        +
        a KeyPair for the requested scheme.
        +
        Throws:
        +
        - if the requested signature scheme is not supported.
        +
        +
        • +
      + + + +
        +
      • +

        generateKeyPair

        +
        public java.security.KeyPair generateKeyPair()
        +

        Generate a KeyPair using the default signature scheme.

        +
        +
        Returns:
        +
        a new KeyPair.
        +
        +
        • +
      + + + +
        +
      • +

        doSign

        +
        public byte[] doSign(java.security.PrivateKey privateKey,
+                     byte[] clearData)
        +

        Generic way to sign ByteArray data with a PrivateKey. Strategy on on identifying the actual signing scheme is based +on the PrivateKey type, but if the schemeCodeName is known, then better use doSign(signatureScheme: String, privateKey: PrivateKey, clearData: ByteArray).

        +
        +
        Parameters:
        +
        privateKey - the signer's PrivateKey.
        +
        clearData - the data/message to be signed in ByteArray form (usually the Merkle root).
        +
        Returns:
        +
        the digital signature (in ByteArray) on the input message.
        +
        Throws:
        +
        - if the signature scheme is not supported for this private key.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        See Also:
        +
        PrivateKey, +PrivateKey
        +
        +
        • +
      + + + +
        +
      • +

        doSign

        +
        public byte[] doSign(java.lang.String schemeCodeName,
+                     java.security.PrivateKey privateKey,
+                     byte[] clearData)
        +

        Generic way to sign ByteArray data with a PrivateKey and a known schemeCodeName String.

        +
        +
        Parameters:
        +
        schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256).
        +
        privateKey - the signer's PrivateKey.
        +
        clearData - the data/message to be signed in ByteArray form (usually the Merkle root).
        +
        Returns:
        +
        the digital signature (in ByteArray) on the input message.
        +
        Throws:
        +
        - if the signature scheme is not supported.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        See Also:
        +
        PrivateKey
        +
        +
        • +
      + + + +
        +
      • +

        doSign

        +
        public TransactionSignature doSign(java.security.PrivateKey privateKey,
+                                   MetaData metaData)
        +

        Generic way to sign class MetaData objects with a PrivateKey. +class MetaData is a wrapper over the transaction's Merkle root in order to attach extra information, such as a timestamp or partial and blind signature indicators.

        +
        +
        Parameters:
        +
        privateKey - the signer's PrivateKey.
        +
        metaData - a class MetaData object that adds extra information to a transaction.
        +
        Returns:
        +
        a class TransactionSignature object than contains the output of a successful signing and the metaData.
        +
        Throws:
        +
        - if the signature scheme is not supported for this private key or +if metaData.schemeCodeName is not aligned with key type.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        See Also:
        +
        class MetaData, +PrivateKey, +class MetaData
        +
        +
        • +
      + + + +
        +
      • +

        doVerify

        +
        public boolean doVerify(java.lang.String schemeCodeName,
+                        java.security.PublicKey publicKey,
+                        byte[] signatureData,
+                        byte[] clearData)
        +

        Utility to simplify the act of verifying a digital signature. +It returns true if it succeeds, but it always throws an exception if verification fails.

        +
        +
        Parameters:
        +
        publicKey - the signer's PublicKey.
        +
        signatureData - the signatureData on a message.
        +
        clearData - the clear data/message that was signed (usually the Merkle root).
        +
        Returns:
        +
        true if verification passes or throws an exception if verification fails.
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible.
        +
        - if the signature scheme is not supported or if any of the clear or signature data is empty.
        +
        +
        • +
      + + + +
        +
      • +

        doVerify

        +
        public boolean doVerify(java.security.PublicKey publicKey,
+                        byte[] signatureData,
+                        byte[] clearData)
        +

        Utility to simplify the act of verifying a digital signature by identifying the signature scheme used from the input public key's type. +It returns true if it succeeds, but it always throws an exception if verification fails. +Strategy on identifying the actual signing scheme is based on the PublicKey type, but if the schemeCodeName is known, +then better use doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray).

        +
        +
        Parameters:
        +
        publicKey - the signer's PublicKey.
        +
        signatureData - the signatureData on a message.
        +
        clearData - the clear data/message that was signed (usually the Merkle root).
        +
        Returns:
        +
        true if verification passes or throws an exception if verification fails.
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible.
        +
        - if the signature scheme is not supported or if any of the clear or signature data is empty.
        +
        See Also:
        +
        PublicKey
        +
        +
        • +
      + + + +
        +
      • +

        doVerify

        +
        public boolean doVerify(java.security.PublicKey publicKey,
+                        TransactionSignature transactionSignature)
        +

        Utility to simplify the act of verifying a class TransactionSignature. +It returns true if it succeeds, but it always throws an exception if verification fails.

        +
        +
        Parameters:
        +
        publicKey - the signer's PublicKey.
        +
        transactionSignature - the signatureData on a message.
        +
        Returns:
        +
        true if verification passes or throws an exception if verification fails.
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible.
        +
        - if the signature scheme is not supported or if any of the clear or signature data is empty.
        +
        See Also:
        +
        class TransactionSignature
        +
        +
        • +
      + + + +
        +
      • +

        isSupportedSignatureScheme

        +
        public boolean isSupportedSignatureScheme(java.lang.String schemeCodeName)
        +

        Check if the requested signature scheme is supported by the system.

        +
        +
        Parameters:
        +
        schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256).
        +
        Returns:
        +
        true if the signature scheme is supported.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultSignatureSchemeCodeName

        +
        public java.lang.String getDefaultSignatureSchemeCodeName()
        +
        +
        Returns:
        +
        the default signature scheme's code name.
        +
        +
        • +
      + + + +
        +
      • +

        listSupportedSignatureSchemes

        +
        public java.util.List<java.lang.String> listSupportedSignatureSchemes()
        +
        +
        Returns:
        +
        a List of Strings with the scheme code names defined in class SignatureScheme for all of our supported signature schemes, see class Crypto.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/CryptoUtilsKt.html b/docs/build/html/api/javadoc/net/corda/core/crypto/CryptoUtilsKt.html new file mode 100644 index 0000000000..0089ccb261 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/CryptoUtilsKt.html @@ -0,0 +1,447 @@ + + + + + + +CryptoUtilsKt + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.core.crypto
+

Class CryptoUtilsKt

+
+
+
    +
  • net.corda.core.crypto.CryptoUtilsKt
    • +
+
+
    +
  • +
    +
    +
    public class CryptoUtilsKt
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.security.SecureRandomnewSecureRandom() +
      Get an instance of SecureRandom to avoid blocking, due to waiting for additional entropy, when possible. +In this version, the NativePRNGNonBlocking is exclusively used on Linux OS to utilize dev/urandom because in high traffic +/dev/random may wait for a certain amount of "noise" to be generated on the host machine before returning a result.
      +
      static byte[]safeRandomBytes(int numOfBytes) +
      Generate a securely random ByteArray of requested number of bytes. Usually used for seeds, nonces and keys.
      +
      static byte[]sign(java.security.PrivateKey $receiver, + byte[] clearData) +
      Helper function for signing.
      +
      static TransactionSignaturesign(java.security.PrivateKey $receiver, + MetaData metaData) +
      Helper function for signing.
      +
      static byte[]sign(java.security.KeyPair $receiver, + byte[] clearData) +
      Helper function to sign with a key pair.
      +
      static booleanverify(java.security.PublicKey $receiver, + byte[] signatureData, + byte[] clearData) +
      Helper function to verify a signature.
      +
      static booleanverify(java.security.PublicKey $receiver, + TransactionSignature transactionSignature) +
      Helper function to verify a metadata attached signature. It is noted that the transactionSignature contains +signatureData and a class MetaData object that contains the signer's public key and the transaction's Merkle root.
      +
      static booleanverify(java.security.KeyPair $receiver, + byte[] signatureData, + byte[] clearData) +
      Helper function for the signers to verify their own signature.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        sign

        +
        public static byte[] sign(java.security.PrivateKey $receiver,
+                          byte[] clearData)
        +

        Helper function for signing.

        +
        +
        Parameters:
        +
        clearData - the data/message to be signed in ByteArray form (usually the Merkle root).
        +
        Returns:
        +
        the digital signature (in ByteArray) on the input message.
        +
        Throws:
        +
        - if the signature scheme is not supported for this private key.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        +
        • +
      + + + +
        +
      • +

        sign

        +
        public static TransactionSignature sign(java.security.PrivateKey $receiver,
+                                        MetaData metaData)
        +

        Helper function for signing.

        +
        +
        Returns:
        +
        a DSWithMetaDataFull object.
        +
        Throws:
        +
        - if the signature scheme is not supported for this private key.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        +
        • +
      + + + +
        +
      • +

        sign

        +
        public static byte[] sign(java.security.KeyPair $receiver,
+                          byte[] clearData)
        +

        Helper function to sign with a key pair.

        +
        +
        Parameters:
        +
        clearData - the data/message to be signed in ByteArray form (usually the Merkle root).
        +
        Returns:
        +
        the digital signature (in ByteArray) on the input message.
        +
        Throws:
        +
        - if the signature scheme is not supported for this private key.
        +
        - if the private key is invalid.
        +
        - if signing is not possible due to malformed data or private key.
        +
        +
        • +
      + + + +
        +
      • +

        verify

        +
        public static boolean verify(java.security.PublicKey $receiver,
+                             byte[] signatureData,
+                             byte[] clearData)
        +

        Helper function to verify a signature.

        +
        +
        Parameters:
        +
        signatureData - the signature on a message.
        +
        clearData - the clear data/message that was signed (usually the Merkle root).
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc.
        +
        - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty.
        +
        +
        • +
      + + + +
        +
      • +

        verify

        +
        public static boolean verify(java.security.PublicKey $receiver,
+                             TransactionSignature transactionSignature)
        +

        Helper function to verify a metadata attached signature. It is noted that the transactionSignature contains +signatureData and a class MetaData object that contains the signer's public key and the transaction's Merkle root.

        +
        +
        Parameters:
        +
        transactionSignature - a class TransactionSignature object that .
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc.
        +
        - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty.
        +
        See Also:
        +
        class MetaData
        +
        +
        • +
      + + + +
        +
      • +

        verify

        +
        public static boolean verify(java.security.KeyPair $receiver,
+                             byte[] signatureData,
+                             byte[] clearData)
        +

        Helper function for the signers to verify their own signature.

        +
        +
        Parameters:
        +
        clearData - the clear data/message that was signed (usually the Merkle root).
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc.
        +
        - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty.
        +
        +
        • +
      + + + +
        +
      • +

        safeRandomBytes

        +
        public static byte[] safeRandomBytes(int numOfBytes)
        +

        Generate a securely random ByteArray of requested number of bytes. Usually used for seeds, nonces and keys.

        +
        +
        Parameters:
        +
        numOfBytes - how many random bytes to output.
        +
        Returns:
        +
        a random ByteArray.
        +
        Throws:
        +
        - thrown if "NativePRNGNonBlocking" is not supported on the JVM +or if no strong SecureRandom implementations are available or if Security.getProperty("securerandom.strongAlgorithms") is null or empty, +which should never happen and suggests an unusual JVM or non-standard Java library.
        +
        +
        • +
      + + + +
        +
      • +

        newSecureRandom

        +
        public static java.security.SecureRandom newSecureRandom()
        +

        Get an instance of SecureRandom to avoid blocking, due to waiting for additional entropy, when possible. +In this version, the NativePRNGNonBlocking is exclusively used on Linux OS to utilize dev/urandom because in high traffic +/dev/random may wait for a certain amount of "noise" to be generated on the host machine before returning a result.

        On Solaris, Linux, and OS X, if the entropy gathering device in java.security is set to file:/dev/urandom +or file:/dev/random, then NativePRNG is preferred to SHA1PRNG. Otherwise, SHA1PRNG is preferred.

        +
        +
        Returns:
        +
        a SecureRandom object.
        +
        Throws:
        +
        - thrown if "NativePRNGNonBlocking" is not supported on the JVM +or if no strong SecureRandom implementations are available or if Security.getProperty("securerandom.strongAlgorithms") is null or empty, +which should never happen and suggests an unusual JVM or non-standard Java library.
        +
        See Also:
        +
        SecureRandom
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/EdDSAKeyFactory.html b/docs/build/html/api/javadoc/net/corda/core/crypto/EdDSAKeyFactory.html new file mode 100644 index 0000000000..5009967489 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/EdDSAKeyFactory.html @@ -0,0 +1,226 @@ + + + + + + +EdDSAKeyFactory + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.core.crypto
+

Class EdDSAKeyFactory

+
+
+
    +
  • net.corda.core.crypto.EdDSAKeyFactory
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      EdDSAKeyFactory() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EdDSAKeyFactory

        +
        public EdDSAKeyFactory()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/MetaData.html b/docs/build/html/api/javadoc/net/corda/core/crypto/MetaData.html new file mode 100644 index 0000000000..6b512d971e --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/MetaData.html @@ -0,0 +1,451 @@ + + + + + + +MetaData + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.crypto
+

Class MetaData

+
+
+
    +
  • net.corda.core.crypto.MetaData
    • +
+
+
    +
  • +
    +
    +
    public class MetaData
    +

    A class MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.

    +
    +
    See Also:
    +
    class MetaData
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MetaData(java.lang.String schemeCodeName, + java.lang.String versionID, + SignatureType signatureType, + java.time.Instant timestamp, + java.util.BitSet visibleInputs, + java.util.BitSet signedInputs, + byte[] merkleRoot, + java.security.PublicKey publicKey) +
      A class MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MetaData

        +
        public MetaData(java.lang.String schemeCodeName,
+                java.lang.String versionID,
+                SignatureType signatureType,
+                java.time.Instant timestamp,
+                java.util.BitSet visibleInputs,
+                java.util.BitSet signedInputs,
+                byte[] merkleRoot,
+                java.security.PublicKey publicKey)
        +

        A class MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.

        +
        +
        Parameters:
        +
        schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256).
        +
        versionID - DLT's version.
        +
        signatureType - type of the signature, see enum SignatureType (e.g. FULL, PARTIAL, BLIND, PARTIAL_AND_BLIND).
        +
        timestamp - the signature's timestamp as provided by the signer.
        +
        visibleInputs - for partially/fully blind signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the transaction were visible when the signature was calculated.
        +
        signedInputs - for partial signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the Merkle tree are actually signed.
        +
        merkleRoot - the Merkle root of the transaction.
        +
        publicKey - the signer's public key.
        +
        See Also:
        +
        class MetaData
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        bytes

        +
        public byte[] bytes()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object other)
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        getSchemeCodeName

        +
        public java.lang.String getSchemeCodeName()
        +
        • +
      + + + +
        +
      • +

        getVersionID

        +
        public java.lang.String getVersionID()
        +
        • +
      + + + +
        +
      • +

        getSignatureType

        +
        public SignatureType getSignatureType()
        +
        • +
      + + + +
        +
      • +

        getTimestamp

        +
        public java.time.Instant getTimestamp()
        +
        • +
      + + + +
        +
      • +

        getVisibleInputs

        +
        public java.util.BitSet getVisibleInputs()
        +
        • +
      + + + +
        +
      • +

        getSignedInputs

        +
        public java.util.BitSet getSignedInputs()
        +
        • +
      + + + +
        +
      • +

        getMerkleRoot

        +
        public byte[] getMerkleRoot()
        +
        • +
      + + + +
        +
      • +

        getPublicKey

        +
        public java.security.PublicKey getPublicKey()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureScheme.html b/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureScheme.html new file mode 100644 index 0000000000..3fb46ac17e --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureScheme.html @@ -0,0 +1,622 @@ + + + + + + +SignatureScheme + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.crypto
+

Class SignatureScheme

+
+
+
    +
  • net.corda.core.crypto.SignatureScheme
    • +
+
+
    +
  • +
    +
    +
    public class SignatureScheme
    +

    This class is used to define a digital signature scheme.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SignatureScheme(int schemeNumberID, + java.lang.String schemeCodeName, + java.lang.String algorithmName, + java.security.Signature sig, + java.security.KeyFactory keyFactory, + java.security.KeyPairGeneratorSpi keyPairGenerator, + java.security.spec.AlgorithmParameterSpec algSpec, + int keySize, + java.lang.String desc) +
      This class is used to define a digital signature scheme.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SignatureScheme

        +
        public SignatureScheme(int schemeNumberID,
+                       java.lang.String schemeCodeName,
+                       java.lang.String algorithmName,
+                       java.security.Signature sig,
+                       java.security.KeyFactory keyFactory,
+                       java.security.KeyPairGeneratorSpi keyPairGenerator,
+                       java.security.spec.AlgorithmParameterSpec algSpec,
+                       int keySize,
+                       java.lang.String desc)
        +

        This class is used to define a digital signature scheme.

        +
        +
        Parameters:
        +
        schemeNumberID - we assign a number ID for more efficient on-wire serialisation. Please ensure uniqueness between schemes.
        +
        schemeCodeName - code name for this signature scheme (e.g. RSA_SHA256, ECDSA_SECP256K1_SHA256, ECDSA_SECP256R1_SHA256, EDDSA_ED25519_SHA512, SPHINCS-256_SHA512).
        +
        algorithmName - which signature algorithm is used (e.g. RSA, ECDSA. EdDSA, SPHINCS-256).
        +
        sig - the Signature class that provides the functionality of a digital signature scheme. +eg. Signature.getInstance("SHA256withECDSA", "BC").
        +
        keyFactory - the KeyFactory for this scheme (e.g. KeyFactory.getInstance("RSA", "BC")).
        +
        keyPairGenerator - defines the Service Provider Interface (SPI) for the {@code KeyPairGenerator} class. +e.g. KeyPairGenerator.getInstance("ECDSA", "BC").
        +
        algSpec - parameter specs for the underlying algorithm. Note that RSA is defined by the key size rather than algSpec. +eg. ECGenParameterSpec("secp256k1").
        +
        keySize - the private key size (currently used for RSA only).
        +
        desc - a human-readable description for this scheme.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSchemeNumberID

        +
        public int getSchemeNumberID()
        +
        • +
      + + + +
        +
      • +

        getSchemeCodeName

        +
        public java.lang.String getSchemeCodeName()
        +
        • +
      + + + +
        +
      • +

        getAlgorithmName

        +
        public java.lang.String getAlgorithmName()
        +
        • +
      + + + +
        +
      • +

        getSig

        +
        public java.security.Signature getSig()
        +
        • +
      + + + +
        +
      • +

        getKeyFactory

        +
        public java.security.KeyFactory getKeyFactory()
        +
        • +
      + + + +
        +
      • +

        getKeyPairGenerator

        +
        public java.security.KeyPairGeneratorSpi getKeyPairGenerator()
        +
        • +
      + + + +
        +
      • +

        getAlgSpec

        +
        public java.security.spec.AlgorithmParameterSpec getAlgSpec()
        +
        • +
      + + + +
        +
      • +

        getKeySize

        +
        public int getKeySize()
        +
        • +
      + + + +
        +
      • +

        getDesc

        +
        public java.lang.String getDesc()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public int component1()
        +
        • +
      + + + +
        +
      • +

        component2

        +
        public java.lang.String component2()
        +
        • +
      + + + +
        +
      • +

        component3

        +
        public java.lang.String component3()
        +
        • +
      + + + +
        +
      • +

        component4

        +
        public java.security.Signature component4()
        +
        • +
      + + + +
        +
      • +

        component5

        +
        public java.security.KeyFactory component5()
        +
        • +
      + + + +
        +
      • +

        component6

        +
        public java.security.KeyPairGeneratorSpi component6()
        +
        • +
      + + + +
        +
      • +

        component7

        +
        public java.security.spec.AlgorithmParameterSpec component7()
        +
        • +
      + + + +
        +
      • +

        component8

        +
        public int component8()
        +
        • +
      + + + +
        +
      • +

        component9

        +
        public java.lang.String component9()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public SignatureScheme copy(int schemeNumberID,
+                            java.lang.String schemeCodeName,
+                            java.lang.String algorithmName,
+                            java.security.Signature sig,
+                            java.security.KeyFactory keyFactory,
+                            java.security.KeyPairGeneratorSpi keyPairGenerator,
+                            java.security.spec.AlgorithmParameterSpec algSpec,
+                            int keySize,
+                            java.lang.String desc)
        +

        This class is used to define a digital signature scheme.

        +
        +
        Parameters:
        +
        schemeNumberID - we assign a number ID for more efficient on-wire serialisation. Please ensure uniqueness between schemes.
        +
        schemeCodeName - code name for this signature scheme (e.g. RSA_SHA256, ECDSA_SECP256K1_SHA256, ECDSA_SECP256R1_SHA256, EDDSA_ED25519_SHA512, SPHINCS-256_SHA512).
        +
        algorithmName - which signature algorithm is used (e.g. RSA, ECDSA. EdDSA, SPHINCS-256).
        +
        sig - the Signature class that provides the functionality of a digital signature scheme. +eg. Signature.getInstance("SHA256withECDSA", "BC").
        +
        keyFactory - the KeyFactory for this scheme (e.g. KeyFactory.getInstance("RSA", "BC")).
        +
        keyPairGenerator - defines the Service Provider Interface (SPI) for the {@code KeyPairGenerator} class. +e.g. KeyPairGenerator.getInstance("ECDSA", "BC").
        +
        algSpec - parameter specs for the underlying algorithm. Note that RSA is defined by the key size rather than algSpec. +eg. ECGenParameterSpec("secp256k1").
        +
        keySize - the private key size (currently used for RSA only).
        +
        desc - a human-readable description for this scheme.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureType.html b/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureType.html new file mode 100644 index 0000000000..340acb6d2c --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/SignatureType.html @@ -0,0 +1,250 @@ + + + + + + +SignatureType + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.core.crypto
+

Enum SignatureType

+
+
+
+
    +
  • +
    +
    +
    public enum SignatureType
    +

    Supported Signature types:

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/crypto/TransactionSignature.html b/docs/build/html/api/javadoc/net/corda/core/crypto/TransactionSignature.html new file mode 100644 index 0000000000..2178fdbf25 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/crypto/TransactionSignature.html @@ -0,0 +1,377 @@ + + + + + + +TransactionSignature + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.core.crypto
+

Class TransactionSignature

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        verify

        +
        public boolean verify()
        +

        Function to auto-verify a class MetaData object's signature. +Note that class MetaData contains both public key and merkle root of the transaction.

        +
        +
        Throws:
        +
        - if the key is invalid.
        +
        - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc.
        +
        - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty.
        +
        See Also:
        +
        class MetaData, +class MetaData
        +
        +
        • +
      + + + +
        +
      • +

        getSignatureData

        +
        public byte[] getSignatureData()
        +
        • +
      + + + +
        +
      • +

        getMetaData

        +
        public MetaData getMetaData()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/node/NodeVersionInfo.html b/docs/build/html/api/javadoc/net/corda/core/node/NodeVersionInfo.html new file mode 100644 index 0000000000..93f78f06f8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/node/NodeVersionInfo.html @@ -0,0 +1,393 @@ + + + + + + +NodeVersionInfo + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.node
+

Class NodeVersionInfo

+
+
+
    +
  • net.corda.core.node.NodeVersionInfo
    • +
+
+
    +
  • +
    +
    +
    public class NodeVersionInfo
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NodeVersionInfo

        +
        public NodeVersionInfo(Version version,
+                       java.lang.String revision,
+                       java.lang.String vendor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getVersion

        +
        public Version getVersion()
        +
        • +
      + + + +
        +
      • +

        getRevision

        +
        public java.lang.String getRevision()
        +
        • +
      + + + +
        +
      • +

        getVendor

        +
        public java.lang.String getVendor()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public Version component1()
        +
        • +
      + + + +
        +
      • +

        component2

        +
        public java.lang.String component2()
        +
        • +
      + + + +
        +
      • +

        component3

        +
        public java.lang.String component3()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public NodeVersionInfo copy(Version version,
+                            java.lang.String revision,
+                            java.lang.String vendor)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/node/PluginServiceHub.DefaultImpls.html b/docs/build/html/api/javadoc/net/corda/core/node/PluginServiceHub.DefaultImpls.html new file mode 100644 index 0000000000..03867eaa13 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/node/PluginServiceHub.DefaultImpls.html @@ -0,0 +1,317 @@ + + + + + + +PluginServiceHub.DefaultImpls + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.core.node
+

Class PluginServiceHub.DefaultImpls

+
+
+
    +
  • net.corda.core.node.PluginServiceHub.DefaultImpls
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerFlowInitiator

        +
        public static void registerFlowInitiator(PluginServiceHub $this,
+                                         kotlin.reflect.KClass<?> markerClass,
+                                         kotlin.jvm.functions.Function1<? super net.corda.core.crypto.Party,? extends net.corda.core.flows.FlowLogic<?>> flowFactory)
        +
        Deprecated. 
        +
        • +
      + + + +
        +
      • +

        recordTransactions

        +
        public static void recordTransactions(PluginServiceHub $this,
+                                      net.corda.core.transactions.SignedTransaction txs)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getLegalIdentityKey

        +
        public static java.security.KeyPair getLegalIdentityKey(PluginServiceHub $this)
        +
        • +
      + + + +
        +
      • +

        getNotaryIdentityKey

        +
        public static java.security.KeyPair getNotaryIdentityKey(PluginServiceHub $this)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/node/Version.Companion.html b/docs/build/html/api/javadoc/net/corda/core/node/Version.Companion.html new file mode 100644 index 0000000000..a2d798bb87 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/node/Version.Companion.html @@ -0,0 +1,229 @@ + + + + + + +Version.Companion + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.core.node
+

Class Version.Companion

+
+
+
    +
  • net.corda.core.node.Version.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Version
    +
    +
    +
    +
    public static class Version.Companion
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public Version parse(java.lang.String string)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/node/Version.html b/docs/build/html/api/javadoc/net/corda/core/node/Version.html new file mode 100644 index 0000000000..54654a0d58 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/node/Version.html @@ -0,0 +1,476 @@ + + + + + + +Version + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.core.node
+

Class Version

+
+
+
    +
  • net.corda.core.node.Version
    • +
+
+
    +
  • +
    +
    +
    public class Version
    +

    Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

    If two class Versions are equal (i.e. equals returns true) but they are both snapshot then they may refer to different +builds of the node. NodeVersionInfo.revision would be required to differentiate the two.

    +
    +
    See Also:
    +
    class Version
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class Version.Companion 
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Version(int major, + int minor, + boolean snapshot) +
      Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcomponent1() 
      intcomponent2() 
      booleancomponent3() 
      Versioncopy(int major, + int minor, + boolean snapshot) +
      Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.
      +
      booleanequals(java.lang.Object p) 
      intgetMajor() 
      intgetMinor() 
      booleangetSnapshot() 
      inthashCode() 
      java.lang.StringtoString() 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Version

        +
        public Version(int major,
+               int minor,
+               boolean snapshot)
        +

        Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

        If two class Versions are equal (i.e. equals returns true) but they are both snapshot then they may refer to different +builds of the node. NodeVersionInfo.revision would be required to differentiate the two.

        +
        +
        See Also:
        +
        class Version
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        getMajor

        +
        public int getMajor()
        +
        • +
      + + + +
        +
      • +

        getMinor

        +
        public int getMinor()
        +
        • +
      + + + +
        +
      • +

        getSnapshot

        +
        public boolean getSnapshot()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public int component1()
        +
        • +
      + + + +
        +
      • +

        component2

        +
        public int component2()
        +
        • +
      + + + +
        +
      • +

        component3

        +
        public boolean component3()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public Version copy(int major,
+                    int minor,
+                    boolean snapshot)
        +

        Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

        If two class Versions are equal (i.e. equals returns true) but they are both snapshot then they may refer to different +builds of the node. NodeVersionInfo.revision would be required to differentiate the two.

        +
        +
        See Also:
        +
        class Version
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/BlobConverter.html b/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/BlobConverter.html new file mode 100644 index 0000000000..2a2fa4f613 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/BlobConverter.html @@ -0,0 +1,332 @@ + + + + + + +BlobConverter + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.schemas.requery.converters
+

Class BlobConverter

+
+
+
    +
  • net.corda.core.schemas.requery.converters.BlobConverter
    • +
+
+
    +
  • +
    +
    +
    public class BlobConverter
    +

    Converts from a ByteArray to a Blob.

    +
    +
    See Also:
    +
    Blob
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlobConverter

        +
        public BlobConverter()
        +

        Converts from a ByteArray to a Blob.

        +
        +
        See Also:
        +
        Blob
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMappedType

        +
        public java.lang.Class<kotlin.Array[]> getMappedType()
        +
        • +
      + + + +
        +
      • +

        getPersistedType

        +
        public java.lang.Class<java.sql.Blob> getPersistedType()
        +
        • +
      + + + +
        +
      • +

        getPersistedSize

        +
        public java.lang.Integer getPersistedSize()
        +

        creates BLOB(INT.MAX) = 2 GB

        +
        • +
      + + + +
        +
      • +

        convertToPersisted

        +
        public java.sql.Blob convertToPersisted(byte[] value)
        +
        • +
      + + + +
        +
      • +

        convertToMapped

        +
        public byte[] convertToMapped(java.lang.Class<? extends byte[]> type,
+                              java.sql.Blob value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/SecureHashConverter.html b/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/SecureHashConverter.html new file mode 100644 index 0000000000..43ca8ad2a3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/schemas/requery/converters/SecureHashConverter.html @@ -0,0 +1,334 @@ + + + + + + +SecureHashConverter + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.schemas.requery.converters
+

Class SecureHashConverter

+
+
+
    +
  • net.corda.core.schemas.requery.converters.SecureHashConverter
    • +
+
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMappedType

        +
        public java.lang.Class<net.corda.core.crypto.SecureHash> getMappedType()
        +
        • +
      + + + +
        +
      • +

        getPersistedType

        +
        public java.lang.Class<java.lang.String> getPersistedType()
        +
        • +
      + + + +
        +
      • +

        getPersistedSize

        +
        public java.lang.Integer getPersistedSize()
        +

        SecureHash consists of 32 bytes which need VARCHAR(64) in hex +TODO: think about other hash widths

        +
        • +
      + + + +
        +
      • +

        convertToPersisted

        +
        public java.lang.String convertToPersisted(SecureHash value)
        +
        • +
      + + + +
        +
      • +

        convertToMapped

        +
        public SecureHash convertToMapped(java.lang.Class<? extends net.corda.core.crypto.SecureHash> type,
+                                  java.lang.String value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/serialization/LoggerSerializer.html b/docs/build/html/api/javadoc/net/corda/core/serialization/LoggerSerializer.html new file mode 100644 index 0000000000..db88b7aa7f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/serialization/LoggerSerializer.html @@ -0,0 +1,288 @@ + + + + + + +LoggerSerializer + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.serialization
+

Class LoggerSerializer

+
+
+
    +
  • net.corda.core.serialization.LoggerSerializer
    • +
+
+
    +
  • +
    +
    +
    public class LoggerSerializer
    +

    For serialising a Logger.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static LoggerSerializerINSTANCE +
      For serialising a Logger.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      org.slf4j.Loggerread(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Input input, + java.lang.Class<org.slf4j.Logger> type) 
      voidwrite(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Output output, + org.slf4j.Logger obj) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(com.esotericsoftware.kryo.Kryo kryo,
+                  com.esotericsoftware.kryo.io.Output output,
+                  org.slf4j.Logger obj)
        +
        • +
      + + + +
        +
      • +

        read

        +
        public org.slf4j.Logger read(com.esotericsoftware.kryo.Kryo kryo,
+                             com.esotericsoftware.kryo.io.Input input,
+                             java.lang.Class<org.slf4j.Logger> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/core/serialization/MetaDataSerializer.html b/docs/build/html/api/javadoc/net/corda/core/serialization/MetaDataSerializer.html new file mode 100644 index 0000000000..625490edac --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/core/serialization/MetaDataSerializer.html @@ -0,0 +1,288 @@ + + + + + + +MetaDataSerializer + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.core.serialization
+

Class MetaDataSerializer

+
+
+
    +
  • net.corda.core.serialization.MetaDataSerializer
    • +
+
+
    +
  • +
    +
    +
    public class MetaDataSerializer
    +

    For serialising a MetaData object.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static MetaDataSerializerINSTANCE +
      For serialising a MetaData object.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      MetaDataread(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Input input, + java.lang.Class<net.corda.core.crypto.MetaData> type) 
      voidwrite(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Output output, + MetaData obj) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(com.esotericsoftware.kryo.Kryo kryo,
+                  com.esotericsoftware.kryo.io.Output output,
+                  MetaData obj)
        +
        • +
      + + + +
        +
      • +

        read

        +
        public MetaData read(com.esotericsoftware.kryo.Kryo kryo,
+                     com.esotericsoftware.kryo.io.Input input,
+                     java.lang.Class<net.corda.core.crypto.MetaData> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/flows/TransactionParts.html b/docs/build/html/api/javadoc/net/corda/flows/TransactionParts.html new file mode 100644 index 0000000000..d2aaa46c51 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/flows/TransactionParts.html @@ -0,0 +1,405 @@ + + + + + + +TransactionParts + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.flows
+

Class TransactionParts

+
+
+
    +
  • net.corda.flows.TransactionParts
    • +
+
+
    +
  • +
    +
    +
    public class TransactionParts
    +

    The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransactionParts

        +
        public TransactionParts(SecureHash id,
+                        java.util.List<net.corda.core.contracts.StateRef> inputs,
+                        Timestamp timestamp)
        +

        The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getInputs

        +
        public java.util.List<net.corda.core.contracts.StateRef> getInputs()
        +
        • +
      + + + +
        +
      • +

        getTimestamp

        +
        public Timestamp getTimestamp()
        +
        • +
      + + + +
        +
      • +

        component1

        +
        public SecureHash component1()
        +
        • +
      + + + +
        +
      • +

        component2

        +
        public java.util.List<net.corda.core.contracts.StateRef> component2()
        +
        • +
      + + + +
        +
      • +

        component3

        +
        public Timestamp component3()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public TransactionParts copy(SecureHash id,
+                             java.util.List<net.corda.core.contracts.StateRef> inputs,
+                             Timestamp timestamp)
        +

        The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object p)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountDeserializer.html new file mode 100644 index 0000000000..6ef5bf9bcc --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.AmountDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.AmountDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.AmountDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.AmountDeserializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public Amount<?> deserialize(com.fasterxml.jackson.core.JsonParser parser,
+                             com.fasterxml.jackson.databind.DeserializationContext context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountSerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountSerializer.html new file mode 100644 index 0000000000..b747571572 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AmountSerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.AmountSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.AmountSerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.AmountSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.AmountSerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(Amount<?> value,
+                      com.fasterxml.jackson.core.JsonGenerator gen,
+                      com.fasterxml.jackson.databind.SerializerProvider serializers)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartyDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartyDeserializer.html new file mode 100644 index 0000000000..8ef3e96956 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartyDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.AnonymousPartyDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.AnonymousPartyDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.AnonymousPartyDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.AnonymousPartyDeserializer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartySerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartySerializer.html new file mode 100644 index 0000000000..e200a176e4 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.AnonymousPartySerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.AnonymousPartySerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.AnonymousPartySerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.AnonymousPartySerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.AnonymousPartySerializer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CalendarDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CalendarDeserializer.html new file mode 100644 index 0000000000..3b6776d7b6 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CalendarDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.CalendarDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.CalendarDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.CalendarDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.CalendarDeserializer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeyDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeyDeserializer.html new file mode 100644 index 0000000000..4ed27ec85d --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeyDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.CompositeKeyDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.CompositeKeyDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.CompositeKeyDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.CompositeKeyDeserializer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeySerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeySerializer.html new file mode 100644 index 0000000000..a2caf977eb --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.CompositeKeySerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.CompositeKeySerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.CompositeKeySerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.CompositeKeySerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.CompositeKeySerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(CompositeKey obj,
+                      com.fasterxml.jackson.core.JsonGenerator generator,
+                      com.fasterxml.jackson.databind.SerializerProvider provider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.IdentityObjectMapper.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.IdentityObjectMapper.html new file mode 100644 index 0000000000..4d47aa831a --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.IdentityObjectMapper.html @@ -0,0 +1,305 @@ + + + + + + +JacksonSupport.IdentityObjectMapper + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.IdentityObjectMapper

+
+
+
    +
  • net.corda.jackson.JacksonSupport.IdentityObjectMapper
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IdentityObjectMapper

        +
        public IdentityObjectMapper(IdentityService identityService,
+                            com.fasterxml.jackson.core.JsonFactory factory)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        partyFromName

        +
        public Party partyFromName(java.lang.String partyName)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NoPartyObjectMapper.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NoPartyObjectMapper.html new file mode 100644 index 0000000000..b3e065834c --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NoPartyObjectMapper.html @@ -0,0 +1,289 @@ + + + + + + +JacksonSupport.NoPartyObjectMapper + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.NoPartyObjectMapper

+
+
+
    +
  • net.corda.jackson.JacksonSupport.NoPartyObjectMapper
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoPartyObjectMapper

        +
        public NoPartyObjectMapper(com.fasterxml.jackson.core.JsonFactory factory)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        partyFromName

        +
        public Party partyFromName(java.lang.String partyName)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoDeserializer.html new file mode 100644 index 0000000000..3509ff02d8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.NodeInfoDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.NodeInfoDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.NodeInfoDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.NodeInfoDeserializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public NodeInfo deserialize(com.fasterxml.jackson.core.JsonParser parser,
+                            com.fasterxml.jackson.databind.DeserializationContext context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoSerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoSerializer.html new file mode 100644 index 0000000000..1d8b9679e3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.NodeInfoSerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.NodeInfoSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.NodeInfoSerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.NodeInfoSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.NodeInfoSerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(NodeInfo value,
+                      com.fasterxml.jackson.core.JsonGenerator gen,
+                      com.fasterxml.jackson.databind.SerializerProvider serializers)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesDeserializer.html new file mode 100644 index 0000000000..a2057e5edf --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.OpaqueBytesDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.OpaqueBytesDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.OpaqueBytesDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.OpaqueBytesDeserializer
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesSerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesSerializer.html new file mode 100644 index 0000000000..011ee0ad61 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.OpaqueBytesSerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.OpaqueBytesSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.OpaqueBytesSerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.OpaqueBytesSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.OpaqueBytesSerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(OpaqueBytes value,
+                      com.fasterxml.jackson.core.JsonGenerator gen,
+                      com.fasterxml.jackson.databind.SerializerProvider serializers)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyDeserializer.html new file mode 100644 index 0000000000..bb380ef49c --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.PartyDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.PartyDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.PartyDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.PartyDeserializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public Party deserialize(com.fasterxml.jackson.core.JsonParser parser,
+                         com.fasterxml.jackson.databind.DeserializationContext context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyObjectMapper.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyObjectMapper.html new file mode 100644 index 0000000000..a6cfc72b93 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartyObjectMapper.html @@ -0,0 +1,244 @@ + + + + + + +JacksonSupport.PartyObjectMapper + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.jackson
+

Interface JacksonSupport.PartyObjectMapper

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        partyFromName

        +
        Party partyFromName(java.lang.String partyName)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartySerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartySerializer.html new file mode 100644 index 0000000000..1b9e3da5e3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PartySerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.PartySerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.PartySerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.PartySerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.PartySerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(Party obj,
+                      com.fasterxml.jackson.core.JsonGenerator generator,
+                      com.fasterxml.jackson.databind.SerializerProvider provider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeyDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeyDeserializer.html new file mode 100644 index 0000000000..159f36bffb --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeyDeserializer.html @@ -0,0 +1,268 @@ + + + + + + +JacksonSupport.PublicKeyDeserializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.PublicKeyDeserializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.PublicKeyDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.PublicKeyDeserializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public net.i2p.crypto.eddsa.EdDSAPublicKey deserialize(com.fasterxml.jackson.core.JsonParser parser,
+                                                       com.fasterxml.jackson.databind.DeserializationContext context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeySerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeySerializer.html new file mode 100644 index 0000000000..39312d9456 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.PublicKeySerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.PublicKeySerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.PublicKeySerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.PublicKeySerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.PublicKeySerializer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidserialize(net.i2p.crypto.eddsa.EdDSAPublicKey obj, + com.fasterxml.jackson.core.JsonGenerator generator, + com.fasterxml.jackson.databind.SerializerProvider provider) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(net.i2p.crypto.eddsa.EdDSAPublicKey obj,
+                      com.fasterxml.jackson.core.JsonGenerator generator,
+                      com.fasterxml.jackson.databind.SerializerProvider provider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.RpcObjectMapper.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.RpcObjectMapper.html new file mode 100644 index 0000000000..e5d2dd49b9 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.RpcObjectMapper.html @@ -0,0 +1,305 @@ + + + + + + +JacksonSupport.RpcObjectMapper + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.RpcObjectMapper

+
+
+
    +
  • net.corda.jackson.JacksonSupport.RpcObjectMapper
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RpcObjectMapper

        +
        public RpcObjectMapper(CordaRPCOps rpc,
+                       com.fasterxml.jackson.core.JsonFactory factory)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        partyFromName

        +
        public Party partyFromName(java.lang.String partyName)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashDeserializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashDeserializer.html new file mode 100644 index 0000000000..f27ad5ed42 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashDeserializer.html @@ -0,0 +1,269 @@ + + + + + + +JacksonSupport.SecureHashDeserializer + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.SecureHashDeserializer<T extends SecureHash>

+
+
+
    +
  • net.corda.jackson.JacksonSupport.SecureHashDeserializer<T>
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.SecureHashDeserializer<T extends SecureHash>
    +

    Implemented as a class so that we can instantiate for T.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SecureHashDeserializer() +
      Implemented as a class so that we can instantiate for T.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Tdeserialize(com.fasterxml.jackson.core.JsonParser parser, + com.fasterxml.jackson.databind.DeserializationContext context) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SecureHashDeserializer

        +
        public SecureHashDeserializer()
        +

        Implemented as a class so that we can instantiate for T.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public T deserialize(com.fasterxml.jackson.core.JsonParser parser,
+                     com.fasterxml.jackson.databind.DeserializationContext context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashSerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashSerializer.html new file mode 100644 index 0000000000..1af82013fd --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.SecureHashSerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.SecureHashSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.SecureHashSerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.SecureHashSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.SecureHashSerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(SecureHash obj,
+                      com.fasterxml.jackson.core.JsonGenerator generator,
+                      com.fasterxml.jackson.databind.SerializerProvider provider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.ToStringSerializer.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.ToStringSerializer.html new file mode 100644 index 0000000000..461ad15d5e --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.ToStringSerializer.html @@ -0,0 +1,270 @@ + + + + + + +JacksonSupport.ToStringSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport.ToStringSerializer

+
+
+
    +
  • net.corda.jackson.JacksonSupport.ToStringSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    JacksonSupport
    +
    +
    +
    +
    public static class JacksonSupport.ToStringSerializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        serialize

        +
        public void serialize(java.lang.Object obj,
+                      com.fasterxml.jackson.core.JsonGenerator generator,
+                      com.fasterxml.jackson.databind.SerializerProvider provider)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.html b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.html new file mode 100644 index 0000000000..f65215b1b1 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/JacksonSupport.html @@ -0,0 +1,473 @@ + + + + + + +JacksonSupport + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.jackson
+

Class JacksonSupport

+
+
+
    +
  • net.corda.jackson.JacksonSupport
    • +
+
+
    +
  • +
    +
    +
    public class JacksonSupport
    +

    Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for +the java.time API, some core types, and Kotlin data classes.

    Note that Jackson can also be used to serialise/deserialise other formats such as Yaml and XML.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INSTANCE

        +
        public static JacksonSupport INSTANCE
        +

        Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for +the java.time API, some core types, and Kotlin data classes.

        Note that Jackson can also be used to serialise/deserialise other formats such as Yaml and XML.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCordaModule

        +
        public com.fasterxml.jackson.databind.Module getCordaModule()
        +
        • +
      + + + +
        +
      • +

        createDefaultMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc,
+                                                                              com.fasterxml.jackson.core.JsonFactory factory)
        +

        Mapper requiring RPC support to deserialise parties from names

        +
        • +
      + + + +
        +
      • +

        createDefaultMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createDefaultMapper(CordaRPCOps rpc)
        +

        Mapper requiring RPC support to deserialise parties from names

        +
        • +
      + + + +
        +
      • +

        createNonRpcMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createNonRpcMapper(com.fasterxml.jackson.core.JsonFactory factory)
        +

        For testing or situations where deserialising parties is not required

        +
        • +
      + + + +
        +
      • +

        createNonRpcMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createNonRpcMapper()
        +

        For testing or situations where deserialising parties is not required

        +
        • +
      + + + +
        +
      • +

        createInMemoryMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService,
+                                                                               com.fasterxml.jackson.core.JsonFactory factory)
        +

        For testing with an in memory identity service

        +
        • +
      + + + +
        +
      • +

        createInMemoryMapper

        +
        public static com.fasterxml.jackson.databind.ObjectMapper createInMemoryMapper(IdentityService identityService)
        +

        For testing with an in memory identity service

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.Companion.html b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.Companion.html new file mode 100644 index 0000000000..d207a03070 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.Companion.html @@ -0,0 +1,174 @@ + + + + + + +StringToMethodCallParser.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.jackson
+

Class StringToMethodCallParser.Companion

+
+
+
    +
  • net.corda.jackson.StringToMethodCallParser.Companion
    • +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.ParsedMethodCall.html b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.ParsedMethodCall.html new file mode 100644 index 0000000000..77ea4cb816 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.ParsedMethodCall.html @@ -0,0 +1,309 @@ + + + + + + +StringToMethodCallParser.ParsedMethodCall + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class StringToMethodCallParser.ParsedMethodCall

+
+
+
    +
  • net.corda.jackson.StringToMethodCallParser.ParsedMethodCall
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ParsedMethodCall(T $outer, + java.lang.reflect.Method target, + java.lang.Object[] method) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ParsedMethodCall

        +
        public ParsedMethodCall(T $outer,
+                        java.lang.reflect.Method target,
+                        java.lang.Object[] method)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        invoke

        +
        public java.lang.Object invoke()
        +
        • +
      + + + +
        +
      • +

        call

        +
        public java.lang.Object call()
        +
        • +
      + + + +
        +
      • +

        getMethod

        +
        public java.lang.reflect.Method getMethod()
        +
        • +
      + + + +
        +
      • +

        getArgs

        +
        public java.lang.Object[] getArgs()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.UnparseableCallException.html b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.UnparseableCallException.html new file mode 100644 index 0000000000..01b43568e6 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.UnparseableCallException.html @@ -0,0 +1,217 @@ + + + + + + +StringToMethodCallParser.UnparseableCallException + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.jackson
+

Class StringToMethodCallParser.UnparseableCallException

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    StringToMethodCallParser<T>
    +
    +
    +
    +
    public static class StringToMethodCallParser.UnparseableCallException
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      UnparseableCallException(java.lang.String command) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnparseableCallException

        +
        public UnparseableCallException(java.lang.String command)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.html b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.html new file mode 100644 index 0000000000..9c0d8b58e2 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/StringToMethodCallParser.html @@ -0,0 +1,552 @@ + + + + + + +StringToMethodCallParser + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.jackson
+

Class StringToMethodCallParser<T>

+
+
+
    +
  • net.corda.jackson.StringToMethodCallParser<T>
    • +
+
+
    +
  • +
    +
    +
    public class StringToMethodCallParser<T>
    +

    This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

    Syntax

    The format of the string is as follows. The first word is the name of the method and must always be present. The rest, +which is optional, is wrapped in curly braces and parsed as if it were a Yaml object. The keys of this object are then +mapped to the parameters of the method via the usual Jackson mechanisms. The standard java.lang.Object methods are +excluded.

    One convenient feature of Yaml is that barewords collapse into strings, thus you can write a call like the following:

        fun someCall(note: String, option: Boolean)
        someCall note: This is a really helpful feature, option: true

    ... and it will be parsed in the intuitive way. Quotes are only needed if you want to put a comma into the string.

    There is an online Yaml parser which can be used to explore +the allowed syntax.

    Usage

    This class is thread safe. Multiple strings may be parsed in parallel, and the resulting class StringToMethodCallParser.ParsedMethodCall +objects may be reused multiple times and also invoked in parallel, as long as the underling target object is +thread safe itself.

    You may pass in an alternative ObjectMapper to control what types can be parsed, but it must be configured +with the YAMLFactory for the class to work.

    Limitations

    • The target class must be either a Kotlin class, or a Java class compiled with the -parameters command line +switch, as the class relies on knowing the names of parameters which isn't data provided by default by the +Java compiler.

    • Vararg methods are not supported, as the type information that'd be required is missing.

    • Method overloads that have identical parameter names but different types can't be handled, because often +a string could map to multiple types, so which one to use is ambiguous. If you want your interface to be +usable with this utility make sure the parameter and method names don't rely on type overloading.

    Examples

        fun simple() = ...
        "simple"   -> runs the no-args function 'simple'
        fun attachmentExists(id: SecureHash): Boolean
        "attachmentExists id: b6d7e826e87"  -> parses the given ID as a SecureHash
        fun addNote(id: SecureHash, note: String)
        "addNote id: b6d7e826e8739ab2eb6e077fc4fba9b04fb880bb4cbd09bc618d30234a8827a4, note: Some note"

    +
    +
    See Also:
    +
    class StringToMethodCallParser.ParsedMethodCall, +Yaml, +java.lang.Object, +online Yaml parser, +class StringToMethodCallParser.ParsedMethodCall
    +
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      StringToMethodCallParser(java.lang.Class<? extends T> targetType, + com.fasterxml.jackson.databind.ObjectMapper om) +
      This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.
      +
      StringToMethodCallParser(java.lang.Class<? extends T> targetType) +
      This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.
      +
      StringToMethodCallParser(kotlin.reflect.KClass<? extends T> targetType) +
      Same as the regular constructor but takes a Kotlin reflection KClass instead of a Java Class.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.Map<java.lang.String,java.lang.String>getAvailableCommands() +
      Returns a string-to-string map of commands to a string describing available parameter types.
      +
      com.google.common.collect.Multimap<java.lang.String,java.lang.reflect.Method>getMethodMap() +
      The methods that can be invoked via this parser.
      +
      java.util.Map<java.lang.String,java.util.List>getMethodParamNames() +
      A map of method name to parameter names for the target type.
      +
      java.util.List<java.lang.String>paramNamesFromConstructor(java.lang.reflect.Constructor<?> ctor) +
      Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a constructor.
      +
      java.util.List<java.lang.String>paramNamesFromMethod(java.lang.reflect.Method method) +
      Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a method.
      +
      StringToMethodCallParser.ParsedMethodCallparse(T target, + java.lang.String command) +
      Parses the given command as a call on the target type. The target should be specified, if it's null then +the resulting class StringToMethodCallParser.ParsedMethodCall can't be invoked, just inspected.
      +
      java.lang.Object[]parseArguments(java.lang.String methodNameHint, + java.util.List<? extends kotlin.Pair<java.lang.String,? extends java.lang.Class<?>>> parameters, + java.lang.String args) +
      Parses only the arguments string given the info about parameter names and types.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringToMethodCallParser

        +
        public StringToMethodCallParser(java.lang.Class<? extends T> targetType,
+                                com.fasterxml.jackson.databind.ObjectMapper om)
        +

        This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

        Syntax

        The format of the string is as follows. The first word is the name of the method and must always be present. The rest, +which is optional, is wrapped in curly braces and parsed as if it were a Yaml object. The keys of this object are then +mapped to the parameters of the method via the usual Jackson mechanisms. The standard java.lang.Object methods are +excluded.

        One convenient feature of Yaml is that barewords collapse into strings, thus you can write a call like the following:

            fun someCall(note: String, option: Boolean)
            someCall note: This is a really helpful feature, option: true

        ... and it will be parsed in the intuitive way. Quotes are only needed if you want to put a comma into the string.

        There is an online Yaml parser which can be used to explore +the allowed syntax.

        Usage

        This class is thread safe. Multiple strings may be parsed in parallel, and the resulting class StringToMethodCallParser.ParsedMethodCall +objects may be reused multiple times and also invoked in parallel, as long as the underling target object is +thread safe itself.

        You may pass in an alternative ObjectMapper to control what types can be parsed, but it must be configured +with the YAMLFactory for the class to work.

        Limitations

        • The target class must be either a Kotlin class, or a Java class compiled with the -parameters command line +switch, as the class relies on knowing the names of parameters which isn't data provided by default by the +Java compiler.

        • Vararg methods are not supported, as the type information that'd be required is missing.

        • Method overloads that have identical parameter names but different types can't be handled, because often +a string could map to multiple types, so which one to use is ambiguous. If you want your interface to be +usable with this utility make sure the parameter and method names don't rely on type overloading.

        Examples

            fun simple() = ...
            "simple"   -> runs the no-args function 'simple'
            fun attachmentExists(id: SecureHash): Boolean
            "attachmentExists id: b6d7e826e87"  -> parses the given ID as a SecureHash
            fun addNote(id: SecureHash, note: String)
            "addNote id: b6d7e826e8739ab2eb6e077fc4fba9b04fb880bb4cbd09bc618d30234a8827a4, note: Some note"

        +
        +
        See Also:
        +
        class StringToMethodCallParser.ParsedMethodCall, +Yaml, +java.lang.Object, +online Yaml parser, +class StringToMethodCallParser.ParsedMethodCall
        +
        +
        • +
      + + + +
        +
      • +

        StringToMethodCallParser

        +
        public StringToMethodCallParser(java.lang.Class<? extends T> targetType)
        +

        This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

        Syntax

        The format of the string is as follows. The first word is the name of the method and must always be present. The rest, +which is optional, is wrapped in curly braces and parsed as if it were a Yaml object. The keys of this object are then +mapped to the parameters of the method via the usual Jackson mechanisms. The standard java.lang.Object methods are +excluded.

        One convenient feature of Yaml is that barewords collapse into strings, thus you can write a call like the following:

            fun someCall(note: String, option: Boolean)
            someCall note: This is a really helpful feature, option: true

        ... and it will be parsed in the intuitive way. Quotes are only needed if you want to put a comma into the string.

        There is an online Yaml parser which can be used to explore +the allowed syntax.

        Usage

        This class is thread safe. Multiple strings may be parsed in parallel, and the resulting class StringToMethodCallParser.ParsedMethodCall +objects may be reused multiple times and also invoked in parallel, as long as the underling target object is +thread safe itself.

        You may pass in an alternative ObjectMapper to control what types can be parsed, but it must be configured +with the YAMLFactory for the class to work.

        Limitations

        • The target class must be either a Kotlin class, or a Java class compiled with the -parameters command line +switch, as the class relies on knowing the names of parameters which isn't data provided by default by the +Java compiler.

        • Vararg methods are not supported, as the type information that'd be required is missing.

        • Method overloads that have identical parameter names but different types can't be handled, because often +a string could map to multiple types, so which one to use is ambiguous. If you want your interface to be +usable with this utility make sure the parameter and method names don't rely on type overloading.

        Examples

            fun simple() = ...
            "simple"   -> runs the no-args function 'simple'
            fun attachmentExists(id: SecureHash): Boolean
            "attachmentExists id: b6d7e826e87"  -> parses the given ID as a SecureHash
            fun addNote(id: SecureHash, note: String)
            "addNote id: b6d7e826e8739ab2eb6e077fc4fba9b04fb880bb4cbd09bc618d30234a8827a4, note: Some note"

        +
        +
        See Also:
        +
        class StringToMethodCallParser.ParsedMethodCall, +Yaml, +java.lang.Object, +online Yaml parser, +class StringToMethodCallParser.ParsedMethodCall
        +
        +
        • +
      + + + +
        +
      • +

        StringToMethodCallParser

        +
        public StringToMethodCallParser(kotlin.reflect.KClass<? extends T> targetType)
        +

        Same as the regular constructor but takes a Kotlin reflection KClass instead of a Java Class.

        +
        +
        See Also:
        +
        Class
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMethodMap

        +
        public com.google.common.collect.Multimap<java.lang.String,java.lang.reflect.Method> getMethodMap()
        +

        The methods that can be invoked via this parser.

        +
        • +
      + + + +
        +
      • +

        getMethodParamNames

        +
        public java.util.Map<java.lang.String,java.util.List> getMethodParamNames()
        +

        A map of method name to parameter names for the target type.

        +
        • +
      + + + +
        +
      • +

        paramNamesFromMethod

        +
        public java.util.List<java.lang.String> paramNamesFromMethod(java.lang.reflect.Method method)
        +

        Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a method.

        +
        • +
      + + + +
        +
      • +

        paramNamesFromConstructor

        +
        public java.util.List<java.lang.String> paramNamesFromConstructor(java.lang.reflect.Constructor<?> ctor)
        +

        Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a constructor.

        +
        • +
      + + + + + + + +
        +
      • +

        parseArguments

        +
        public java.lang.Object[] parseArguments(java.lang.String methodNameHint,
+                                         java.util.List<? extends kotlin.Pair<java.lang.String,? extends java.lang.Class<?>>> parameters,
+                                         java.lang.String args)
        +

        Parses only the arguments string given the info about parameter names and types.

        +
        +
        Parameters:
        +
        methodNameHint - A name that will be used in exceptions if thrown; not used for any other purpose.
        +
        +
        • +
      + + + +
        +
      • +

        getAvailableCommands

        +
        public java.util.Map<java.lang.String,java.lang.String> getAvailableCommands()
        +

        Returns a string-to-string map of commands to a string describing available parameter types.

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.MissingParameter.html b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.MissingParameter.html new file mode 100644 index 0000000000..49c310b6d9 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.MissingParameter.html @@ -0,0 +1,264 @@ + + + + + + +UnparseableCallException.MissingParameter + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class UnparseableCallException.MissingParameter

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MissingParameter(java.lang.String methodName, + java.lang.String paramName, + java.lang.String command) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MissingParameter

        +
        public MissingParameter(java.lang.String methodName,
+                        java.lang.String paramName,
+                        java.lang.String command)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getParamName

        +
        public java.lang.String getParamName()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.ReflectionDataMissing.html b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.ReflectionDataMissing.html new file mode 100644 index 0000000000..0408c02868 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.ReflectionDataMissing.html @@ -0,0 +1,219 @@ + + + + + + +UnparseableCallException.ReflectionDataMissing + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.jackson
+

Class UnparseableCallException.ReflectionDataMissing

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ReflectionDataMissing(java.lang.String methodName, + int argIndex) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ReflectionDataMissing

        +
        public ReflectionDataMissing(java.lang.String methodName,
+                             int argIndex)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.TooManyParameters.html b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.TooManyParameters.html new file mode 100644 index 0000000000..ea5cffee04 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.TooManyParameters.html @@ -0,0 +1,219 @@ + + + + + + +UnparseableCallException.TooManyParameters + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.jackson
+

Class UnparseableCallException.TooManyParameters

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TooManyParameters(java.lang.String methodName, + java.lang.String command) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TooManyParameters

        +
        public TooManyParameters(java.lang.String methodName,
+                         java.lang.String command)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.UnknownMethod.html b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.UnknownMethod.html new file mode 100644 index 0000000000..8958a968b9 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/UnparseableCallException.UnknownMethod.html @@ -0,0 +1,260 @@ + + + + + + +UnparseableCallException.UnknownMethod + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.jackson
+

Class UnparseableCallException.UnknownMethod

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnknownMethod

        +
        public UnknownMethod(java.lang.String methodName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMethodName

        +
        public java.lang.String getMethodName()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/package-frame.html b/docs/build/html/api/javadoc/net/corda/jackson/package-frame.html new file mode 100644 index 0000000000..dcf271b63c --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +net.corda.jackson + + + + + + +

net.corda.jackson

+
+

Classes

+ +
+ + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/package-summary.html b/docs/build/html/api/javadoc/net/corda/jackson/package-summary.html new file mode 100644 index 0000000000..49e569ae88 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/package-summary.html @@ -0,0 +1,154 @@ + + + + + + +net.corda.jackson + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.corda.jackson

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    JacksonSupport +
    Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for +the java.time API, some core types, and Kotlin data classes.
    +
    StringToMethodCallParser<T> +
    This class parses strings in a format designed for human usability into class StringToMethodCallParser.ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/jackson/package-tree.html b/docs/build/html/api/javadoc/net/corda/jackson/package-tree.html new file mode 100644 index 0000000000..a8ec0832ab --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/jackson/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +net.corda.jackson Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.corda.jackson

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.InputStreamDeserializer.html b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.InputStreamDeserializer.html new file mode 100644 index 0000000000..754273850f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.InputStreamDeserializer.html @@ -0,0 +1,282 @@ + + + + + + +InteractiveShell.InputStreamDeserializer + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node
+

Class InteractiveShell.InputStreamDeserializer

+
+
+
    +
  • net.corda.node.InteractiveShell.InputStreamDeserializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    InteractiveShell
    +
    +
    +
    +
    public static class InteractiveShell.InputStreamDeserializer
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        deserialize

        +
        public java.io.InputStream deserialize(com.fasterxml.jackson.core.JsonParser p,
+                                       com.fasterxml.jackson.databind.DeserializationContext ctxt)
        +
        • +
      + + + +
        +
      • +

        closeAll

        +
        public void closeAll()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.NoApplicableConstructor.html b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.NoApplicableConstructor.html new file mode 100644 index 0000000000..38773b93fd --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.NoApplicableConstructor.html @@ -0,0 +1,274 @@ + + + + + + +InteractiveShell.NoApplicableConstructor + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node
+

Class InteractiveShell.NoApplicableConstructor

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    InteractiveShell
    +
    +
    +
    +
    public static class InteractiveShell.NoApplicableConstructor
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoApplicableConstructor

        +
        public NoApplicableConstructor(java.util.List<java.lang.String> errors)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        getErrors

        +
        public java.util.List<java.lang.String> getErrors()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.html b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.html new file mode 100644 index 0000000000..2af4e6de83 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/InteractiveShell.html @@ -0,0 +1,375 @@ + + + + + + +InteractiveShell + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node
+

Class InteractiveShell

+
+
+
    +
  • net.corda.node.InteractiveShell
    • +
+
+
    +
  • +
    +
    +
    public class InteractiveShell
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidrunFlowByNameFragment(java.lang.String nameFragment, + java.lang.String inputData, + org.crsh.text.RenderPrintWriter output) +
      Called from the 'flow' shell command. Takes a name fragment and finds a matching flow, or prints out +the list of options if the request is ambiguous. Then parses inputData as constructor arguments using +the runFlowFromString method and starts the requested flow using the class ANSIProgressRenderer to draw +the progress tracker. Ctrl-C can be used to cancel.
      +
      FlowStateMachine<?>runFlowFromString(kotlin.jvm.functions.Function1<? super net.corda.core.flows.FlowLogic<?>,? extends net.corda.core.flows.FlowStateMachine<?>> invoke, + java.lang.String inputData, + java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> clazz, + com.fasterxml.jackson.databind.ObjectMapper om) +
      Given a class FlowLogic class and a string in one-line Yaml form, finds an applicable constructor and starts +the flow, returning the created flow logic. Useful for lightweight invocation where text is preferable +to statically typed, compiled code.
      +
      static java.lang.ObjectrunRPCFromString(java.util.List<java.lang.String> input, + org.crsh.text.RenderPrintWriter out, + org.crsh.command.InvocationContext<? extends java.lang.Object> context) 
      voidstartShell(java.nio.file.Path dir, + boolean runLocalShell, + boolean runSSHServer, + Node node) +
      Starts an interactive shell connected to the local terminal. This shell gives administrator access to the node +internals.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        startShell

        +
        public void startShell(java.nio.file.Path dir,
+                       boolean runLocalShell,
+                       boolean runSSHServer,
+                       Node node)
        +

        Starts an interactive shell connected to the local terminal. This shell gives administrator access to the node +internals.

        +
        • +
      + + + +
        +
      • +

        runFlowByNameFragment

        +
        public static void runFlowByNameFragment(java.lang.String nameFragment,
+                                         java.lang.String inputData,
+                                         org.crsh.text.RenderPrintWriter output)
        +

        Called from the 'flow' shell command. Takes a name fragment and finds a matching flow, or prints out +the list of options if the request is ambiguous. Then parses inputData as constructor arguments using +the runFlowFromString method and starts the requested flow using the class ANSIProgressRenderer to draw +the progress tracker. Ctrl-C can be used to cancel.

        +
        +
        See Also:
        +
        class ANSIProgressRenderer
        +
        +
        • +
      + + + +
        +
      • +

        runFlowFromString

        +
        public FlowStateMachine<?> runFlowFromString(kotlin.jvm.functions.Function1<? super net.corda.core.flows.FlowLogic<?>,? extends net.corda.core.flows.FlowStateMachine<?>> invoke,
+                                             java.lang.String inputData,
+                                             java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> clazz,
+                                             com.fasterxml.jackson.databind.ObjectMapper om)
        +

        Given a class FlowLogic class and a string in one-line Yaml form, finds an applicable constructor and starts +the flow, returning the created flow logic. Useful for lightweight invocation where text is preferable +to statically typed, compiled code.

        See the class StringToMethodCallParser class to learn more about limitations and acceptable syntax.

        +
        +
        Throws:
        +
        - if no constructor could be found for the given set of types.
        +
        See Also:
        +
        class FlowLogic, +class StringToMethodCallParser
        +
        +
        • +
      + + + +
        +
      • +

        runRPCFromString

        +
        public static java.lang.Object runRPCFromString(java.util.List<java.lang.String> input,
+                                                org.crsh.text.RenderPrintWriter out,
+                                                org.crsh.command.InvocationContext<? extends java.lang.Object> context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/InteractiveShellCommand.html b/docs/build/html/api/javadoc/net/corda/node/InteractiveShellCommand.html new file mode 100644 index 0000000000..980a2ee0db --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/InteractiveShellCommand.html @@ -0,0 +1,291 @@ + + + + + + +InteractiveShellCommand + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node
+

Class InteractiveShellCommand

+
+
+
    +
  • net.corda.node.InteractiveShellCommand
    • +
+
+
    +
  • +
    +
    +
    public class InteractiveShellCommand
    +

    Simply extends CRaSH BaseCommand to add easy access to the RPC ops class.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InteractiveShellCommand

        +
        public InteractiveShellCommand()
        +

        Simply extends CRaSH BaseCommand to add easy access to the RPC ops class.

        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        objectMapper

        +
        public com.fasterxml.jackson.databind.ObjectMapper objectMapper()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/driver/ShutdownManager.html b/docs/build/html/api/javadoc/net/corda/node/driver/ShutdownManager.html new file mode 100644 index 0000000000..613d969df5 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/driver/ShutdownManager.html @@ -0,0 +1,287 @@ + + + + + + +ShutdownManager + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.driver
+

Class ShutdownManager

+
+
+
    +
  • net.corda.node.driver.ShutdownManager
    • +
+
+
    +
  • +
    +
    +
    public class ShutdownManager
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ShutdownManager(java.util.concurrent.ExecutorService executorService) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ShutdownManager

        +
        public ShutdownManager(java.util.concurrent.ExecutorService executorService)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        shutdown

        +
        public void shutdown()
        +
        • +
      + + + +
        +
      • +

        registerShutdown

        +
        public void registerShutdown(com.google.common.util.concurrent.ListenableFuture<kotlin.jvm.functions.Function0> shutdown)
        +
        • +
      + + + +
        +
      • +

        registerProcessShutdown

        +
        public void registerProcessShutdown(com.google.common.util.concurrent.ListenableFuture<java.lang.Process> processFuture)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/internal/Node.Companion.html b/docs/build/html/api/javadoc/net/corda/node/internal/Node.Companion.html new file mode 100644 index 0000000000..b78bc5d278 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/internal/Node.Companion.html @@ -0,0 +1,174 @@ + + + + + + +Node.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.internal
+

Class Node.Companion

+
+
+
    +
  • net.corda.node.internal.Node.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    Node
    +
    +
    +
    +
    public static class Node.Companion
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcher.ObservableSerializer.html b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcher.ObservableSerializer.html new file mode 100644 index 0000000000..9dbe3b36ec --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcher.ObservableSerializer.html @@ -0,0 +1,285 @@ + + + + + + +RPCDispatcher.ObservableSerializer + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.services.messaging
+

Class RPCDispatcher.ObservableSerializer

+
+
+
    +
  • net.corda.node.services.messaging.RPCDispatcher.ObservableSerializer
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    RPCDispatcher
    +
    +
    +
    +
    public static class RPCDispatcher.ObservableSerializer
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      rx.Observable<java.lang.Object>read(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Input input, + java.lang.Class<rx.Observable> type) 
      voidwrite(com.esotericsoftware.kryo.Kryo kryo, + com.esotericsoftware.kryo.io.Output output, + rx.Observable<java.lang.Object> obj) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ObservableSerializer

        +
        public ObservableSerializer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public rx.Observable<java.lang.Object> read(com.esotericsoftware.kryo.Kryo kryo,
+                                            com.esotericsoftware.kryo.io.Input input,
+                                            java.lang.Class<rx.Observable> type)
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(com.esotericsoftware.kryo.Kryo kryo,
+                  com.esotericsoftware.kryo.io.Output output,
+                  rx.Observable<java.lang.Object> obj)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcherKt.html b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcherKt.html new file mode 100644 index 0000000000..36bb6b5ab8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCDispatcherKt.html @@ -0,0 +1,241 @@ + + + + + + +RPCDispatcherKt + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.messaging
+

Class RPCDispatcherKt

+
+
+
    +
  • net.corda.node.services.messaging.RPCDispatcherKt
    • +
+
+
    +
  • +
    +
    +
    public class RPCDispatcherKt
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createRPCKryoForSerialization

        +
        public static com.esotericsoftware.kryo.Kryo createRPCKryoForSerialization(java.lang.String qName,
+                                                                           RPCDispatcher dispatcher)
        +
        • +
      + + + +
        +
      • +

        releaseRPCKryoForSerialization

        +
        public static void releaseRPCKryoForSerialization(com.esotericsoftware.kryo.Kryo kryo)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCServerStructures.html b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCServerStructures.html new file mode 100644 index 0000000000..b16746e469 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/messaging/RPCServerStructures.html @@ -0,0 +1,228 @@ + + + + + + +RPCServerStructures + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.messaging
+

Class RPCServerStructures

+
+
+
    +
  • net.corda.node.services.messaging.RPCServerStructures
    • +
+
+
    +
  • +
    +
    +
    public class RPCServerStructures
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidrequirePermission(java.lang.String permission) +
      Helper method which checks that the current RPC user is entitled for the given permission. Throws a PermissionException otherwise.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        requirePermission

        +
        public static void requirePermission(java.lang.String permission)
        +

        Helper method which checks that the current RPC user is entitled for the given permission. Throws a PermissionException otherwise.

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/network/AbstractNetworkMapService.Companion.html b/docs/build/html/api/javadoc/net/corda/node/services/network/AbstractNetworkMapService.Companion.html new file mode 100644 index 0000000000..e5f402da14 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/network/AbstractNetworkMapService.Companion.html @@ -0,0 +1,174 @@ + + + + + + +AbstractNetworkMapService.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.network
+

Class AbstractNetworkMapService.Companion

+
+
+
    +
  • net.corda.node.services.network.AbstractNetworkMapService.Companion
    • +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/persistence/NodeAttachmentService.HashMismatchException.html b/docs/build/html/api/javadoc/net/corda/node/services/persistence/NodeAttachmentService.HashMismatchException.html new file mode 100644 index 0000000000..b9578ea0a7 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/persistence/NodeAttachmentService.HashMismatchException.html @@ -0,0 +1,290 @@ + + + + + + +NodeAttachmentService.HashMismatchException + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.services.persistence
+

Class NodeAttachmentService.HashMismatchException

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    NodeAttachmentService
    +
    +
    +
    +
    public static class NodeAttachmentService.HashMismatchException
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HashMismatchException

        +
        public HashMismatchException(SecureHash expected,
+                             SecureHash actual)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        • +
      + + + +
        +
      • +

        getExpected

        +
        public SecureHash getExpected()
        +
        • +
      + + + +
        +
      • +

        getActual

        +
        public SecureHash getActual()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Companion.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Companion.html new file mode 100644 index 0000000000..a486fae948 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Companion.html @@ -0,0 +1,229 @@ + + + + + + +BFTNonValidatingNotaryService.Companion + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTNonValidatingNotaryService.Companion

+
+
+
    +
  • net.corda.node.services.transactions.BFTNonValidatingNotaryService.Companion
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Server.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Server.html new file mode 100644 index 0000000000..7b7d8b33a7 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.Server.html @@ -0,0 +1,339 @@ + + + + + + +BFTNonValidatingNotaryService.Server + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTNonValidatingNotaryService.Server

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.ServiceFlow.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.ServiceFlow.html new file mode 100644 index 0000000000..0b96b99da8 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.ServiceFlow.html @@ -0,0 +1,311 @@ + + + + + + +BFTNonValidatingNotaryService.ServiceFlow + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTNonValidatingNotaryService.ServiceFlow

+
+
+
    +
  • FlowLogic
    • +
  • +
      +
    • net.corda.node.services.transactions.BFTNonValidatingNotaryService.ServiceFlow
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    BFTNonValidatingNotaryService
    +
    +
    +
    +
    public static class BFTNonValidatingNotaryService.ServiceFlow
+extends FlowLogic
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        call

        +
        public java.lang.Void call()
        +

        This is where you fill out your business logic. The returned object will usually be ignored, but can be +helpful if this flow is meant to be used as a subflow.

        +
        • +
      + + + +
        +
      • +

        getOtherSide

        +
        public Party getOtherSide()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.html new file mode 100644 index 0000000000..64d54896e6 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTNonValidatingNotaryService.html @@ -0,0 +1,388 @@ + + + + + + +BFTNonValidatingNotaryService + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTNonValidatingNotaryService

+
+
+
    +
  • SingletonSerializeAsToken
    • +
  • +
      +
    • NotaryService
      • +
    • +
        +
      • net.corda.node.services.transactions.BFTNonValidatingNotaryService
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SerializeAsToken
    +
    +
    +
    +
    public class BFTNonValidatingNotaryService
+extends NotaryService
    +

    A non-validating notary service operated by a group of parties that don't necessarily trust each other.

    A transaction is notarised when the consensus is reached by the cluster on its uniqueness, and timestamp validity.

    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BFTNonValidatingNotaryService

        +
        public BFTNonValidatingNotaryService(ServiceHubInternal services,
+                                     TimestampChecker timestampChecker,
+                                     int serverId,
+                                     org.jetbrains.exposed.sql.Database db,
+                                     BFTSMaRt.Client client)
        +

        A non-validating notary service operated by a group of parties that don't necessarily trust each other.

        A transaction is notarised when the consensus is reached by the cluster on its uniqueness, and timestamp validity.

        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Client.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Client.html new file mode 100644 index 0000000000..2777f12a85 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Client.html @@ -0,0 +1,364 @@ + + + + + + +BFTSMaRt.Client + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt.Client

+
+
+
    +
  • SingletonSerializeAsToken
    • +
  • +
      +
    • net.corda.node.services.transactions.BFTSMaRt.Client
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SerializeAsToken
    +
    +
    +
    Enclosing class:
    +
    BFTSMaRt
    +
    +
    +
    +
    public static class BFTSMaRt.Client
+extends SingletonSerializeAsToken
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Client

        +
        public Client(int id)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        commitTransaction

        +
        public BFTSMaRt.ClusterResponse commitTransaction(java.lang.Object transaction,
+                                                  Party otherSide)
        +

        Sends a transaction commit request to the BFT cluster. The proxy will deliver the request to every +replica, and block until a sufficient number of replies are received.

        +
        • +
      + + + +
        +
      • +

        getId

        +
        public int getId()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ClusterResponse.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ClusterResponse.html new file mode 100644 index 0000000000..d2fd259877 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ClusterResponse.html @@ -0,0 +1,213 @@ + + + + + + +BFTSMaRt.ClusterResponse + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt.ClusterResponse

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.ClusterResponse
    • +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.CommitRequest.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.CommitRequest.html new file mode 100644 index 0000000000..86e3bbf883 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.CommitRequest.html @@ -0,0 +1,387 @@ + + + + + + +BFTSMaRt.CommitRequest + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt.CommitRequest

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.CommitRequest
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ReplicaResponse.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ReplicaResponse.html new file mode 100644 index 0000000000..7d23dadf48 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.ReplicaResponse.html @@ -0,0 +1,213 @@ + + + + + + +BFTSMaRt.ReplicaResponse + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt.ReplicaResponse

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.ReplicaResponse
    • +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Server.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Server.html new file mode 100644 index 0000000000..8bf0c3399f --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.Server.html @@ -0,0 +1,528 @@ + + + + + + +BFTSMaRt.Server + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt.Server

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.Server
    • +
+
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Server

        +
        public Server(int id,
+              org.jetbrains.exposed.sql.Database db,
+              java.lang.String tableName,
+              ServiceHubInternal services,
+              TimestampChecker timestampChecker)
        +

        Maintains the commit log and executes commit commands received from the class BFTSMaRt.Client.

        The validation logic can be specified by implementing the executeCommand method.

        +
        +
        See Also:
        +
        class BFTSMaRt.Client
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCommitLog

        +
        public JDBCHashMap<net.corda.core.contracts.StateRef,net.corda.core.node.services.UniquenessProvider.ConsumingTx> getCommitLog()
        +
        • +
      + + + +
        +
      • +

        appExecuteUnordered

        +
        public byte[] appExecuteUnordered(byte[] command,
+                                  bftsmart.tom.MessageContext msgCtx)
        +
        • +
      + + + +
        +
      • +

        appExecuteBatch

        +
        public byte[] appExecuteBatch(byte[] command,
+                              bftsmart.tom.MessageContext[] mcs)
        +
        • +
      + + + + + + + +
        +
      • +

        commitInputStates

        +
        public void commitInputStates(java.util.List<net.corda.core.contracts.StateRef> states,
+                              SecureHash txId,
+                              Party callerIdentity)
        +
        • +
      + + + +
        +
      • +

        validateTimestamp

        +
        public void validateTimestamp(Timestamp t)
        +
        • +
      + + + + + + + +
        +
      • +

        getSnapshot

        +
        public byte[] getSnapshot()
        +
        • +
      + + + +
        +
      • +

        installSnapshot

        +
        public void installSnapshot(byte[] bytes)
        +
        • +
      + + + +
        +
      • +

        getId

        +
        public int getId()
        +
        • +
      + + + +
        +
      • +

        getDb

        +
        public org.jetbrains.exposed.sql.Database getDb()
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.html new file mode 100644 index 0000000000..7b2c5e18e3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/BFTSMaRt.html @@ -0,0 +1,286 @@ + + + + + + +BFTSMaRt + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class BFTSMaRt

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/Client.Companion.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/Client.Companion.html new file mode 100644 index 0000000000..0d3dbe5675 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/Client.Companion.html @@ -0,0 +1,174 @@ + + + + + + +Client.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class Client.Companion

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.Client.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    BFTSMaRt.Client
    +
    +
    +
    +
    public static class Client.Companion
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Error.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Error.html new file mode 100644 index 0000000000..37f7a737da --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Error.html @@ -0,0 +1,284 @@ + + + + + + +ClusterResponse.Error + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class ClusterResponse.Error

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Signatures.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Signatures.html new file mode 100644 index 0000000000..9d007b4818 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ClusterResponse.Signatures.html @@ -0,0 +1,284 @@ + + + + + + +ClusterResponse.Signatures + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class ClusterResponse.Signatures

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Signatures

        +
        public Signatures(java.util.List<? extends net.corda.core.crypto.DigitalSignature> txSignatures)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTxSignatures

        +
        public java.util.List<net.corda.core.crypto.DigitalSignature> getTxSignatures()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Error.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Error.html new file mode 100644 index 0000000000..c90f746ac3 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Error.html @@ -0,0 +1,284 @@ + + + + + + +ReplicaResponse.Error + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class ReplicaResponse.Error

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Signature.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Signature.html new file mode 100644 index 0000000000..8386d7b734 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/ReplicaResponse.Signature.html @@ -0,0 +1,284 @@ + + + + + + +ReplicaResponse.Signature + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class ReplicaResponse.Signature

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/services/transactions/Server.Companion.html b/docs/build/html/api/javadoc/net/corda/node/services/transactions/Server.Companion.html new file mode 100644 index 0000000000..0009e161e5 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/services/transactions/Server.Companion.html @@ -0,0 +1,174 @@ + + + + + + +Server.Companion + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.corda.node.services.transactions
+

Class Server.Companion

+
+
+
    +
  • net.corda.node.services.transactions.BFTSMaRt.Server.Companion
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    BFTSMaRt.Server
    +
    +
    +
    +
    public static class Server.Companion
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/build/html/api/javadoc/net/corda/node/utilities/AddressUtils.html b/docs/build/html/api/javadoc/net/corda/node/utilities/AddressUtils.html new file mode 100644 index 0000000000..6c69f344f2 --- /dev/null +++ b/docs/build/html/api/javadoc/net/corda/node/utilities/AddressUtils.html @@ -0,0 +1,295 @@ + + + + + + +AddressUtils + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
net.corda.node.utilities
+

Class AddressUtils

+
+
+
    +
  • net.corda.node.utilities.AddressUtils
    • +
+
+
    +
  • +
    +
    +
    public class AddressUtils
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static AddressUtilsINSTANCE 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanisPublic(java.net.InetAddress address) +
      Returns true if the provided address is a public IP address or hostname.
      +
      booleanisPublic(java.lang.String hostText) 
      java.net.InetAddresstryDetectPublicIP() +
      Returns the first public IP address found on any of the network interfaces, or null if none found.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        tryDetectPublicIP

        +
        public java.net.InetAddress tryDetectPublicIP()
        +

        Returns the first public IP address found on any of the network interfaces, or null if none found.

        +
        • +
      + + + +
        +
      • +

        isPublic

        +
        public boolean isPublic(java.net.InetAddress address)
        +

        Returns true if the provided address is a public IP address or hostname.

        +
        • +
      + + + +
        +
      • +

        isPublic

        +
        public boolean isPublic(java.lang.String hostText)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/-init-.html new file mode 100644 index 0000000000..95db296942 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/-init-.html @@ -0,0 +1,14 @@ + + + +ContractStateModel.<init> - corda + + + +corda / net.corda.client.jfx.model / ContractStateModel / <init>
+
+

<init>

+ContractStateModel() +

This model exposes the list of owned contract states.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash-states.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash-states.html new file mode 100644 index 0000000000..f310a50005 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash-states.html @@ -0,0 +1,14 @@ + + + +ContractStateModel.cashStates - corda + + + +corda / net.corda.client.jfx.model / ContractStateModel / cashStates
+
+

cashStates

+ +val cashStates: ObservableList<StateAndRef<State>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash.html new file mode 100644 index 0000000000..d33526bcf4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/cash.html @@ -0,0 +1,14 @@ + + + +ContractStateModel.cash - corda + + + +corda / net.corda.client.jfx.model / ContractStateModel / cash
+
+

cash

+ +val cash: ObservableList<Amount<Issued<Currency>>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/index.html new file mode 100644 index 0000000000..c9b3fc2902 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-contract-state-model/index.html @@ -0,0 +1,44 @@ + + + +ContractStateModel - corda + + + +corda / net.corda.client.jfx.model / ContractStateModel
+
+

ContractStateModel

+class ContractStateModel +

This model exposes the list of owned contract states.

+

Constructors

+ + + + + + + +
+<init> +ContractStateModel() +

This model exposes the list of owned contract states.

+
+

Properties

+ + + + + + + + + + + +
+cash +val cash: ObservableList<Amount<Issued<Currency>>>
+cashStates +val cashStates: ObservableList<StateAndRef<State>>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/-init-.html new file mode 100644 index 0000000000..959088b1cf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/-init-.html @@ -0,0 +1,13 @@ + + + +Diff.<init> - corda + + + +corda / net.corda.client.jfx.model / Diff / <init>
+
+

<init>

+Diff(added: Collection<StateAndRef<T>>, removed: Collection<StateAndRef<T>>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/added.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/added.html new file mode 100644 index 0000000000..537557d0b7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/added.html @@ -0,0 +1,14 @@ + + + +Diff.added - corda + + + +corda / net.corda.client.jfx.model / Diff / added
+
+

added

+ +val added: Collection<StateAndRef<T>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/index.html new file mode 100644 index 0000000000..202c99bc08 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/index.html @@ -0,0 +1,41 @@ + + + +Diff - corda + + + +corda / net.corda.client.jfx.model / Diff
+
+

Diff

+data class Diff<out T : ContractState> +

Constructors

+ + + + + + + +
+<init> +Diff(added: Collection<StateAndRef<T>>, removed: Collection<StateAndRef<T>>)
+

Properties

+ + + + + + + + + + + +
+added +val added: Collection<StateAndRef<T>>
+removed +val removed: Collection<StateAndRef<T>>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/removed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/removed.html new file mode 100644 index 0000000000..5871e504f0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-diff/removed.html @@ -0,0 +1,14 @@ + + + +Diff.removed - corda + + + +corda / net.corda.client.jfx.model / Diff / removed
+
+

removed

+ +val removed: Collection<StateAndRef<T>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/-init-.html new file mode 100644 index 0000000000..1bbf5ebf7f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/-init-.html @@ -0,0 +1,15 @@ + + + +ExchangeRateModel.<init> - corda + + + +corda / net.corda.client.jfx.model / ExchangeRateModel / <init>
+
+

<init>

+ExchangeRateModel() +

This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/exchange-rate.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/exchange-rate.html new file mode 100644 index 0000000000..d9b85caf8c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/exchange-rate.html @@ -0,0 +1,14 @@ + + + +ExchangeRateModel.exchangeRate - corda + + + +corda / net.corda.client.jfx.model / ExchangeRateModel / exchangeRate
+
+

exchangeRate

+ +val exchangeRate: ObservableValue<ExchangeRate> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/index.html new file mode 100644 index 0000000000..42852e9182 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate-model/index.html @@ -0,0 +1,40 @@ + + + +ExchangeRateModel - corda + + + +corda / net.corda.client.jfx.model / ExchangeRateModel
+
+

ExchangeRateModel

+class ExchangeRateModel +

This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

+

Constructors

+ + + + + + + +
+<init> +ExchangeRateModel() +

This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

+
+

Properties

+ + + + + + + +
+exchangeRate +val exchangeRate: ObservableValue<ExchangeRate>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/index.html new file mode 100644 index 0000000000..e62e230b8c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/index.html @@ -0,0 +1,41 @@ + + + +ExchangeRate - corda + + + +corda / net.corda.client.jfx.model / ExchangeRate
+
+

ExchangeRate

+interface ExchangeRate +

Functions

+ + + + + + + +
+rate +abstract fun rate(from: Currency, to: Currency): Double
+

Extension Functions

+ + + + + + + + + + + +
+exchangeAmount +fun ExchangeRate.exchangeAmount(amount: Amount<Currency>, to: Currency): Amount<Currency>
+exchangeDouble +fun ExchangeRate.exchangeDouble(amount: Amount<Currency>, to: Currency): Double
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/rate.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/rate.html new file mode 100644 index 0000000000..4acc89a1fd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-exchange-rate/rate.html @@ -0,0 +1,14 @@ + + + +ExchangeRate.rate - corda + + + +corda / net.corda.client.jfx.model / ExchangeRate / rate
+
+

rate

+ +abstract fun rate(from: Currency, to: Currency): Double + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/-init-.html new file mode 100644 index 0000000000..3343c1676f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/-init-.html @@ -0,0 +1,13 @@ + + + +FlowStatus.<init> - corda + + + +corda / net.corda.client.jfx.model / FlowStatus / <init>
+
+

<init>

+FlowStatus(status: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/index.html new file mode 100644 index 0000000000..676fc1a17e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/index.html @@ -0,0 +1,35 @@ + + + +FlowStatus - corda + + + +corda / net.corda.client.jfx.model / FlowStatus
+
+

FlowStatus

+data class FlowStatus +

Constructors

+ + + + + + + +
+<init> +FlowStatus(status: String)
+

Properties

+ + + + + + + +
+status +val status: String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/status.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/status.html new file mode 100644 index 0000000000..69bf8f9ec2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-flow-status/status.html @@ -0,0 +1,14 @@ + + + +FlowStatus.status - corda + + + +corda / net.corda.client.jfx.model / FlowStatus / status
+
+

status

+ +val status: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/-init-.html new file mode 100644 index 0000000000..d1b11f2ec7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/-init-.html @@ -0,0 +1,13 @@ + + + +GatheredTransactionData.<init> - corda + + + +corda / net.corda.client.jfx.model / GatheredTransactionData / <init>
+
+

<init>

+GatheredTransactionData(transaction: PartiallyResolvedTransaction, stateMachines: ObservableList<out StateMachineData>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/index.html new file mode 100644 index 0000000000..b7e1ab4d6e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/index.html @@ -0,0 +1,41 @@ + + + +GatheredTransactionData - corda + + + +corda / net.corda.client.jfx.model / GatheredTransactionData
+
+

GatheredTransactionData

+data class GatheredTransactionData +

Constructors

+ + + + + + + +
+<init> +GatheredTransactionData(transaction: PartiallyResolvedTransaction, stateMachines: ObservableList<out StateMachineData>)
+

Properties

+ + + + + + + + + + + +
+stateMachines +val stateMachines: ObservableList<out StateMachineData>
+transaction +val transaction: PartiallyResolvedTransaction
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/state-machines.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/state-machines.html new file mode 100644 index 0000000000..bc6984753e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/state-machines.html @@ -0,0 +1,14 @@ + + + +GatheredTransactionData.stateMachines - corda + + + +corda / net.corda.client.jfx.model / GatheredTransactionData / stateMachines
+
+

stateMachines

+ +val stateMachines: ObservableList<out StateMachineData> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/transaction.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/transaction.html new file mode 100644 index 0000000000..c5dbba3d18 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-gathered-transaction-data/transaction.html @@ -0,0 +1,14 @@ + + + +GatheredTransactionData.transaction - corda + + + +corda / net.corda.client.jfx.model / GatheredTransactionData / transaction
+
+

transaction

+ +val transaction: PartiallyResolvedTransaction + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/get.html new file mode 100644 index 0000000000..25cd195e5f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/get.html @@ -0,0 +1,16 @@ + + + +Models.get - corda + + + +corda / net.corda.client.jfx.model / Models / get
+
+

get

+ +fun <M : Any> get(klass: KClass<M>, origin: KClass<*>): M
+ +inline fun <reified M : Any> get(origin: KClass<*>): M + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/index.html new file mode 100644 index 0000000000..61eb6ee47b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/index.html @@ -0,0 +1,31 @@ + + + +Models - corda + + + +corda / net.corda.client.jfx.model / Models
+
+

Models

+object Models +

Functions

+ + + + + + + + + + + +
+get +fun <M : Any> get(klass: KClass<M>, origin: KClass<*>): M
+fun <M : Any> get(origin: KClass<*>): M
+initModel +fun <M : Any> initModel(klass: KClass<M>): Any
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/init-model.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/init-model.html new file mode 100644 index 0000000000..7e8faea86f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-models/init-model.html @@ -0,0 +1,14 @@ + + + +Models.initModel - corda + + + +corda / net.corda.client.jfx.model / Models / initModel
+
+

initModel

+ +fun <M : Any> initModel(klass: KClass<M>): Any + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/-init-.html new file mode 100644 index 0000000000..13d7ddeef2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/-init-.html @@ -0,0 +1,13 @@ + + + +NetworkIdentityModel.<init> - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / <init>
+
+

<init>

+NetworkIdentityModel() + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/index.html new file mode 100644 index 0000000000..72eccc7b59 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/index.html @@ -0,0 +1,65 @@ + + + +NetworkIdentityModel - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel
+
+

NetworkIdentityModel

+class NetworkIdentityModel +

Constructors

+ + + + + + + +
+<init> +NetworkIdentityModel()
+

Properties

+ + + + + + + + + + + + + + + + + + + +
+myIdentity +val myIdentity: ObservableValue<NodeInfo?>
+networkIdentities +val networkIdentities: ObservableList<NodeInfo>
+notaries +val notaries: ObservableList<NodeInfo>
+parties +val parties: ObservableList<NodeInfo>
+

Functions

+ + + + + + + +
+lookup +fun lookup(compositeKey: CompositeKey): ObservableValue<NodeInfo?>
+fun lookup(publicKey: PublicKey): ObservableValue<NodeInfo?>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/lookup.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/lookup.html new file mode 100644 index 0000000000..c4f9ac997c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/lookup.html @@ -0,0 +1,16 @@ + + + +NetworkIdentityModel.lookup - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / lookup
+
+

lookup

+ +fun lookup(compositeKey: CompositeKey): ObservableValue<NodeInfo?>
+ +fun lookup(publicKey: PublicKey): ObservableValue<NodeInfo?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/my-identity.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/my-identity.html new file mode 100644 index 0000000000..75e2f70961 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/my-identity.html @@ -0,0 +1,14 @@ + + + +NetworkIdentityModel.myIdentity - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / myIdentity
+
+

myIdentity

+ +val myIdentity: ObservableValue<NodeInfo?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/network-identities.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/network-identities.html new file mode 100644 index 0000000000..ac10a5ee53 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/network-identities.html @@ -0,0 +1,14 @@ + + + +NetworkIdentityModel.networkIdentities - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / networkIdentities
+
+

networkIdentities

+ +val networkIdentities: ObservableList<NodeInfo> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/notaries.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/notaries.html new file mode 100644 index 0000000000..5fd8fbca37 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/notaries.html @@ -0,0 +1,14 @@ + + + +NetworkIdentityModel.notaries - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / notaries
+
+

notaries

+ +val notaries: ObservableList<NodeInfo> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/parties.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/parties.html new file mode 100644 index 0000000000..9c686b17ed --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-network-identity-model/parties.html @@ -0,0 +1,14 @@ + + + +NetworkIdentityModel.parties - corda + + + +corda / net.corda.client.jfx.model / NetworkIdentityModel / parties
+
+

parties

+ +val parties: ObservableList<NodeInfo> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/-init-.html new file mode 100644 index 0000000000..4613d6ef8f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/-init-.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.<init> - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / <init>
+
+

<init>

+NodeMonitorModel() +

This model exposes raw event streams to and from the node.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/index.html new file mode 100644 index 0000000000..c4c15d9240 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/index.html @@ -0,0 +1,88 @@ + + + +NodeMonitorModel - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel
+
+

NodeMonitorModel

+class NodeMonitorModel +

This model exposes raw event streams to and from the node.

+

Constructors

+ + + + + + + +
+<init> +NodeMonitorModel() +

This model exposes raw event streams to and from the node.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+networkMap +val networkMap: Observable<MapChange>
+progressTracking +val progressTracking: Observable<ProgressTrackingEvent>
+proxyObservable +val proxyObservable: SimpleObjectProperty<CordaRPCOps?>
+stateMachineTransactionMapping +val stateMachineTransactionMapping: Observable<StateMachineTransactionMapping>
+stateMachineUpdates +val stateMachineUpdates: Observable<StateMachineUpdate>
+transactions +val transactions: Observable<SignedTransaction>
+vaultUpdates +val vaultUpdates: Observable<Update>
+

Functions

+ + + + + + + +
+register +fun register(nodeHostAndPort: HostAndPort, username: String, password: String): Unit +

Register for updates to/from a given vault. +TODO provide an unsubscribe mechanism

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/network-map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/network-map.html new file mode 100644 index 0000000000..f2cbdbb0e7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/network-map.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.networkMap - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / networkMap
+
+

networkMap

+ +val networkMap: Observable<MapChange> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/progress-tracking.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/progress-tracking.html new file mode 100644 index 0000000000..b985716d08 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/progress-tracking.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.progressTracking - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / progressTracking
+
+

progressTracking

+ +val progressTracking: Observable<ProgressTrackingEvent> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/proxy-observable.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/proxy-observable.html new file mode 100644 index 0000000000..2c68cfa6fd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/proxy-observable.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.proxyObservable - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / proxyObservable
+
+

proxyObservable

+ +val proxyObservable: SimpleObjectProperty<CordaRPCOps?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/register.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/register.html new file mode 100644 index 0000000000..64e1c4010f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/register.html @@ -0,0 +1,16 @@ + + + +NodeMonitorModel.register - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / register
+
+

register

+ +fun register(nodeHostAndPort: HostAndPort, username: String, password: String): Unit +

Register for updates to/from a given vault. +TODO provide an unsubscribe mechanism

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-transaction-mapping.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-transaction-mapping.html new file mode 100644 index 0000000000..27bb309c4f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-transaction-mapping.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.stateMachineTransactionMapping - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / stateMachineTransactionMapping
+
+

stateMachineTransactionMapping

+ +val stateMachineTransactionMapping: Observable<StateMachineTransactionMapping> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-updates.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-updates.html new file mode 100644 index 0000000000..2ce47970c1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/state-machine-updates.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.stateMachineUpdates - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / stateMachineUpdates
+
+

stateMachineUpdates

+ +val stateMachineUpdates: Observable<StateMachineUpdate> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/transactions.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/transactions.html new file mode 100644 index 0000000000..ec18bc277d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/transactions.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.transactions - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / transactions
+
+

transactions

+ +val transactions: Observable<SignedTransaction> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/vault-updates.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/vault-updates.html new file mode 100644 index 0000000000..3709707ae4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-node-monitor-model/vault-updates.html @@ -0,0 +1,14 @@ + + + +NodeMonitorModel.vaultUpdates - corda + + + +corda / net.corda.client.jfx.model / NodeMonitorModel / vaultUpdates
+
+

vaultUpdates

+ +val vaultUpdates: Observable<Update> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-init-.html new file mode 100644 index 0000000000..8593225dba --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-init-.html @@ -0,0 +1,16 @@ + + + +PartiallyResolvedTransaction.<init> - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / <init>
+
+

<init>

+PartiallyResolvedTransaction(transaction: SignedTransaction, inputs: List<ObservableValue<InputResolution>>) +

PartiallyResolvedTransaction holds a SignedTransaction that has zero or more inputs resolved. The intent is +to prepare clients for cases where an input can only be resolved in the future/cannot be resolved at all (for example +because of permissioning)

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/-init-.html new file mode 100644 index 0000000000..c902b9a763 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/-init-.html @@ -0,0 +1,13 @@ + + + +PartiallyResolvedTransaction.InputResolution.Resolved.<init> - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / Resolved / <init>
+
+

<init>

+Resolved(stateAndRef: StateAndRef<ContractState>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/index.html new file mode 100644 index 0000000000..ba02b2eaa4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/index.html @@ -0,0 +1,46 @@ + + + +PartiallyResolvedTransaction.InputResolution.Resolved - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / Resolved
+
+

Resolved

+class Resolved : InputResolution +

Constructors

+ + + + + + + +
+<init> +Resolved(stateAndRef: StateAndRef<ContractState>)
+

Properties

+ + + + + + + +
+stateAndRef +val stateAndRef: StateAndRef<ContractState>
+

Inherited Properties

+ + + + + + + +
+stateRef +val stateRef: StateRef
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/state-and-ref.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/state-and-ref.html new file mode 100644 index 0000000000..656414e781 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-resolved/state-and-ref.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.InputResolution.Resolved.stateAndRef - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / Resolved / stateAndRef
+
+

stateAndRef

+ +val stateAndRef: StateAndRef<ContractState> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/-init-.html new file mode 100644 index 0000000000..70b02fef8e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/-init-.html @@ -0,0 +1,13 @@ + + + +PartiallyResolvedTransaction.InputResolution.Unresolved.<init> - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / Unresolved / <init>
+
+

<init>

+Unresolved(stateRef: StateRef) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/index.html new file mode 100644 index 0000000000..090a5852ef --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/-unresolved/index.html @@ -0,0 +1,35 @@ + + + +PartiallyResolvedTransaction.InputResolution.Unresolved - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / Unresolved
+
+

Unresolved

+class Unresolved : InputResolution +

Constructors

+ + + + + + + +
+<init> +Unresolved(stateRef: StateRef)
+

Inherited Properties

+ + + + + + + +
+stateRef +val stateRef: StateRef
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/index.html new file mode 100644 index 0000000000..860c190588 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/index.html @@ -0,0 +1,58 @@ + + + +PartiallyResolvedTransaction.InputResolution - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution
+
+

InputResolution

+sealed class InputResolution +

Types

+ + + + + + + + + + + +
+Resolved +class Resolved : InputResolution
+Unresolved +class Unresolved : InputResolution
+

Properties

+ + + + + + + +
+stateRef +val stateRef: StateRef
+

Inheritors

+ + + + + + + + + + + +
+Resolved +class Resolved : InputResolution
+Unresolved +class Unresolved : InputResolution
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/state-ref.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/state-ref.html new file mode 100644 index 0000000000..6f22d4b861 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/-input-resolution/state-ref.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.InputResolution.stateRef - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / InputResolution / stateRef
+
+

stateRef

+ +val stateRef: StateRef + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/from-signed-transaction.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/from-signed-transaction.html new file mode 100644 index 0000000000..3b7cc8ff76 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/from-signed-transaction.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.fromSignedTransaction - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / fromSignedTransaction
+
+

fromSignedTransaction

+ +fun fromSignedTransaction(transaction: SignedTransaction, transactions: ObservableMap<SecureHash, SignedTransaction>): PartiallyResolvedTransaction + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/id.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/id.html new file mode 100644 index 0000000000..91ce918dd6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/id.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.id - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / id
+
+

id

+ +val id: SecureHash + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/index.html new file mode 100644 index 0000000000..0d3fd622c7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/index.html @@ -0,0 +1,76 @@ + + + +PartiallyResolvedTransaction - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction
+
+

PartiallyResolvedTransaction

+data class PartiallyResolvedTransaction +

PartiallyResolvedTransaction holds a SignedTransaction that has zero or more inputs resolved. The intent is +to prepare clients for cases where an input can only be resolved in the future/cannot be resolved at all (for example +because of permissioning)

+

Types

+ + + + + + + +
+InputResolution +sealed class InputResolution
+

Constructors

+ + + + + + + +
+<init> +PartiallyResolvedTransaction(transaction: SignedTransaction, inputs: List<ObservableValue<InputResolution>>) +

PartiallyResolvedTransaction holds a SignedTransaction that has zero or more inputs resolved. The intent is +to prepare clients for cases where an input can only be resolved in the future/cannot be resolved at all (for example +because of permissioning)

+
+

Properties

+ + + + + + + + + + + + + + + +
+id +val id: SecureHash
+inputs +val inputs: List<ObservableValue<InputResolution>>
+transaction +val transaction: SignedTransaction
+

Companion Object Functions

+ + + + + + + +
+fromSignedTransaction +fun fromSignedTransaction(transaction: SignedTransaction, transactions: ObservableMap<SecureHash, SignedTransaction>): PartiallyResolvedTransaction
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/inputs.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/inputs.html new file mode 100644 index 0000000000..05d9b1ffe7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/inputs.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.inputs - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / inputs
+
+

inputs

+ +val inputs: List<ObservableValue<InputResolution>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/transaction.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/transaction.html new file mode 100644 index 0000000000..50c49c3cca --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-partially-resolved-transaction/transaction.html @@ -0,0 +1,14 @@ + + + +PartiallyResolvedTransaction.transaction - corda + + + +corda / net.corda.client.jfx.model / PartiallyResolvedTransaction / transaction
+
+

transaction

+ +val transaction: SignedTransaction + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/-init-.html new file mode 100644 index 0000000000..75c047eeb8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/-init-.html @@ -0,0 +1,13 @@ + + + +ProgressTrackingEvent.<init> - corda + + + +corda / net.corda.client.jfx.model / ProgressTrackingEvent / <init>
+
+

<init>

+ProgressTrackingEvent(stateMachineId: StateMachineRunId, message: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/create-stream-from-state-machine-info.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/create-stream-from-state-machine-info.html new file mode 100644 index 0000000000..236abcc2bf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/create-stream-from-state-machine-info.html @@ -0,0 +1,14 @@ + + + +ProgressTrackingEvent.createStreamFromStateMachineInfo - corda + + + +corda / net.corda.client.jfx.model / ProgressTrackingEvent / createStreamFromStateMachineInfo
+
+

createStreamFromStateMachineInfo

+ +fun createStreamFromStateMachineInfo(stateMachine: StateMachineInfo): Observable<ProgressTrackingEvent>? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/index.html new file mode 100644 index 0000000000..ba3ee35849 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/index.html @@ -0,0 +1,52 @@ + + + +ProgressTrackingEvent - corda + + + +corda / net.corda.client.jfx.model / ProgressTrackingEvent
+
+

ProgressTrackingEvent

+data class ProgressTrackingEvent +

Constructors

+ + + + + + + +
+<init> +ProgressTrackingEvent(stateMachineId: StateMachineRunId, message: String)
+

Properties

+ + + + + + + + + + + +
+message +val message: String
+stateMachineId +val stateMachineId: StateMachineRunId
+

Companion Object Functions

+ + + + + + + +
+createStreamFromStateMachineInfo +fun createStreamFromStateMachineInfo(stateMachine: StateMachineInfo): Observable<ProgressTrackingEvent>?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/message.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/message.html new file mode 100644 index 0000000000..9f1c8a60e8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/message.html @@ -0,0 +1,14 @@ + + + +ProgressTrackingEvent.message - corda + + + +corda / net.corda.client.jfx.model / ProgressTrackingEvent / message
+
+

message

+ +val message: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/state-machine-id.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/state-machine-id.html new file mode 100644 index 0000000000..edf2777698 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-progress-tracking-event/state-machine-id.html @@ -0,0 +1,14 @@ + + + +ProgressTrackingEvent.stateMachineId - corda + + + +corda / net.corda.client.jfx.model / ProgressTrackingEvent / stateMachineId
+
+

stateMachineId

+ +val stateMachineId: StateMachineRunId + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/-init-.html new file mode 100644 index 0000000000..4b1ccebba2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/-init-.html @@ -0,0 +1,13 @@ + + + +StateMachineData.<init> - corda + + + +corda / net.corda.client.jfx.model / StateMachineData / <init>
+
+

<init>

+StateMachineData(id: StateMachineRunId, flowStatus: ObservableValue<FlowStatus?>, stateMachineStatus: ObservableValue<StateMachineStatus>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/flow-status.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/flow-status.html new file mode 100644 index 0000000000..74706df5d8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/flow-status.html @@ -0,0 +1,14 @@ + + + +StateMachineData.flowStatus - corda + + + +corda / net.corda.client.jfx.model / StateMachineData / flowStatus
+
+

flowStatus

+ +val flowStatus: ObservableValue<FlowStatus?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/id.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/id.html new file mode 100644 index 0000000000..43bce0d090 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/id.html @@ -0,0 +1,14 @@ + + + +StateMachineData.id - corda + + + +corda / net.corda.client.jfx.model / StateMachineData / id
+
+

id

+ +val id: StateMachineRunId + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/index.html new file mode 100644 index 0000000000..10e31d0a4d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/index.html @@ -0,0 +1,47 @@ + + + +StateMachineData - corda + + + +corda / net.corda.client.jfx.model / StateMachineData
+
+

StateMachineData

+data class StateMachineData +

Constructors

+ + + + + + + +
+<init> +StateMachineData(id: StateMachineRunId, flowStatus: ObservableValue<FlowStatus?>, stateMachineStatus: ObservableValue<StateMachineStatus>)
+

Properties

+ + + + + + + + + + + + + + + +
+flowStatus +val flowStatus: ObservableValue<FlowStatus?>
+id +val id: StateMachineRunId
+stateMachineStatus +val stateMachineStatus: ObservableValue<StateMachineStatus>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/state-machine-status.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/state-machine-status.html new file mode 100644 index 0000000000..dd3f3be0e1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-data/state-machine-status.html @@ -0,0 +1,14 @@ + + + +StateMachineData.stateMachineStatus - corda + + + +corda / net.corda.client.jfx.model / StateMachineData / stateMachineStatus
+
+

stateMachineStatus

+ +val stateMachineStatus: ObservableValue<StateMachineStatus> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/-init-.html new file mode 100644 index 0000000000..fdca9a5b38 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/-init-.html @@ -0,0 +1,13 @@ + + + +StateMachineStatus.Added.<init> - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / Added / <init>
+
+

<init>

+Added(stateMachineName: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/index.html new file mode 100644 index 0000000000..829d8a2966 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-added/index.html @@ -0,0 +1,46 @@ + + + +StateMachineStatus.Added - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / Added
+
+

Added

+class Added : StateMachineStatus +

Constructors

+ + + + + + + +
+<init> +Added(stateMachineName: String)
+

Inherited Properties

+ + + + + + + +
+stateMachineName +val stateMachineName: String
+

Inherited Functions

+ + + + + + + +
+toString +open fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/-init-.html new file mode 100644 index 0000000000..55958f2aa8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/-init-.html @@ -0,0 +1,13 @@ + + + +StateMachineStatus.Removed.<init> - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / Removed / <init>
+
+

<init>

+Removed(stateMachineName: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/index.html new file mode 100644 index 0000000000..eb60971305 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/-removed/index.html @@ -0,0 +1,46 @@ + + + +StateMachineStatus.Removed - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / Removed
+
+

Removed

+class Removed : StateMachineStatus +

Constructors

+ + + + + + + +
+<init> +Removed(stateMachineName: String)
+

Inherited Properties

+ + + + + + + +
+stateMachineName +val stateMachineName: String
+

Inherited Functions

+ + + + + + + +
+toString +open fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/index.html new file mode 100644 index 0000000000..97ed45df56 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/index.html @@ -0,0 +1,69 @@ + + + +StateMachineStatus - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus
+
+

StateMachineStatus

+sealed class StateMachineStatus +

Types

+ + + + + + + + + + + +
+Added +class Added : StateMachineStatus
+Removed +class Removed : StateMachineStatus
+

Properties

+ + + + + + + +
+stateMachineName +val stateMachineName: String
+

Functions

+ + + + + + + +
+toString +open fun toString(): String
+

Inheritors

+ + + + + + + + + + + +
+Added +class Added : StateMachineStatus
+Removed +class Removed : StateMachineStatus
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/state-machine-name.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/state-machine-name.html new file mode 100644 index 0000000000..13c48d520d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/state-machine-name.html @@ -0,0 +1,14 @@ + + + +StateMachineStatus.stateMachineName - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / stateMachineName
+
+

stateMachineName

+ +val stateMachineName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/to-string.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/to-string.html new file mode 100644 index 0000000000..0ae6aaa3f4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-state-machine-status/to-string.html @@ -0,0 +1,14 @@ + + + +StateMachineStatus.toString - corda + + + +corda / net.corda.client.jfx.model / StateMachineStatus / toString
+
+

toString

+ +open fun toString(): String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/-init-.html new file mode 100644 index 0000000000..76ecbed2d0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.EventSinkDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventSinkDelegate / <init>
+
+

<init>

+EventSinkDelegate(klass: KClass<M>, eventSinkProperty: (M) -> <ERROR CLASS><T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/event-sink-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/event-sink-property.html new file mode 100644 index 0000000000..36a0afb9b1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/event-sink-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.EventSinkDelegate.eventSinkProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventSinkDelegate / eventSinkProperty
+
+

eventSinkProperty

+ +val eventSinkProperty: (M) -> <ERROR CLASS><T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/get-value.html new file mode 100644 index 0000000000..d9e26ada69 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.EventSinkDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventSinkDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): <ERROR CLASS><T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/index.html new file mode 100644 index 0000000000..28572528db --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-sink-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.EventSinkDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventSinkDelegate
+
+

EventSinkDelegate

+class EventSinkDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +EventSinkDelegate(klass: KClass<M>, eventSinkProperty: (M) -> <ERROR CLASS><T>)
+

Properties

+ + + + + + + +
+eventSinkProperty +val eventSinkProperty: (M) -> <ERROR CLASS><T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): <ERROR CLASS><T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/-init-.html new file mode 100644 index 0000000000..67d9b3b4f5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.EventStreamDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventStreamDelegate / <init>
+
+

<init>

+EventStreamDelegate(klass: KClass<M>, eventStreamProperty: (M) -> <ERROR CLASS><T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/event-stream-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/event-stream-property.html new file mode 100644 index 0000000000..4a4bb8dd34 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/event-stream-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.EventStreamDelegate.eventStreamProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventStreamDelegate / eventStreamProperty
+
+

eventStreamProperty

+ +val eventStreamProperty: (M) -> <ERROR CLASS><T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/get-value.html new file mode 100644 index 0000000000..c9a9295882 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.EventStreamDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventStreamDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): <ERROR CLASS><T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/index.html new file mode 100644 index 0000000000..731146170f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-event-stream-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.EventStreamDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / EventStreamDelegate
+
+

EventStreamDelegate

+class EventStreamDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +EventStreamDelegate(klass: KClass<M>, eventStreamProperty: (M) -> <ERROR CLASS><T>)
+

Properties

+ + + + + + + +
+eventStreamProperty +val eventStreamProperty: (M) -> <ERROR CLASS><T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): <ERROR CLASS><T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/-init-.html new file mode 100644 index 0000000000..c62c1310dd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObjectPropertyDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObjectPropertyDelegate / <init>
+
+

<init>

+ObjectPropertyDelegate(klass: KClass<M>, objectPropertyProperty: (M) -> ObjectProperty<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/get-value.html new file mode 100644 index 0000000000..17fb212039 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObjectPropertyDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObjectPropertyDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): ObjectProperty<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/index.html new file mode 100644 index 0000000000..72e88df826 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObjectPropertyDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObjectPropertyDelegate
+
+

ObjectPropertyDelegate

+class ObjectPropertyDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObjectPropertyDelegate(klass: KClass<M>, objectPropertyProperty: (M) -> ObjectProperty<T>)
+

Properties

+ + + + + + + +
+objectPropertyProperty +val objectPropertyProperty: (M) -> ObjectProperty<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): ObjectProperty<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/object-property-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/object-property-property.html new file mode 100644 index 0000000000..be75f9720c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-object-property-delegate/object-property-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObjectPropertyDelegate.objectPropertyProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObjectPropertyDelegate / objectPropertyProperty
+
+

objectPropertyProperty

+ +val objectPropertyProperty: (M) -> ObjectProperty<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/-init-.html new file mode 100644 index 0000000000..b8fd124144 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObservableDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableDelegate / <init>
+
+

<init>

+ObservableDelegate(klass: KClass<M>, observableProperty: (M) -> Observable<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/get-value.html new file mode 100644 index 0000000000..b2a43cffe4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): Observable<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/index.html new file mode 100644 index 0000000000..576b4df946 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObservableDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableDelegate
+
+

ObservableDelegate

+class ObservableDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObservableDelegate(klass: KClass<M>, observableProperty: (M) -> Observable<T>)
+

Properties

+ + + + + + + +
+observableProperty +val observableProperty: (M) -> Observable<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): Observable<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/observable-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/observable-property.html new file mode 100644 index 0000000000..a6605e1765 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-delegate/observable-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableDelegate.observableProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableDelegate / observableProperty
+
+

observableProperty

+ +val observableProperty: (M) -> Observable<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/-init-.html new file mode 100644 index 0000000000..2837d2b9ef --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObservableListDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListDelegate / <init>
+
+

<init>

+ObservableListDelegate(klass: KClass<M>, observableListProperty: (M) -> ObservableList<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/get-value.html new file mode 100644 index 0000000000..9742c4c4c6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableListDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableList<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/index.html new file mode 100644 index 0000000000..7a315e3ef8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObservableListDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListDelegate
+
+

ObservableListDelegate

+class ObservableListDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObservableListDelegate(klass: KClass<M>, observableListProperty: (M) -> ObservableList<T>)
+

Properties

+ + + + + + + +
+observableListProperty +val observableListProperty: (M) -> ObservableList<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/observable-list-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/observable-list-property.html new file mode 100644 index 0000000000..f707fb1809 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-delegate/observable-list-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableListDelegate.observableListProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListDelegate / observableListProperty
+
+

observableListProperty

+ +val observableListProperty: (M) -> ObservableList<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/-init-.html new file mode 100644 index 0000000000..565f42b6c4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObservableListReadOnlyDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListReadOnlyDelegate / <init>
+
+

<init>

+ObservableListReadOnlyDelegate(klass: KClass<M>, observableListReadOnlyProperty: (M) -> ObservableList<out T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/get-value.html new file mode 100644 index 0000000000..b0696effde --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableListReadOnlyDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListReadOnlyDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableList<out T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/index.html new file mode 100644 index 0000000000..7dbcc8560f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObservableListReadOnlyDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListReadOnlyDelegate
+
+

ObservableListReadOnlyDelegate

+class ObservableListReadOnlyDelegate<M : Any, out T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObservableListReadOnlyDelegate(klass: KClass<M>, observableListReadOnlyProperty: (M) -> ObservableList<out T>)
+

Properties

+ + + + + + + +
+observableListReadOnlyProperty +val observableListReadOnlyProperty: (M) -> ObservableList<out T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableList<out T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/observable-list-read-only-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/observable-list-read-only-property.html new file mode 100644 index 0000000000..74a7d401a5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-list-read-only-delegate/observable-list-read-only-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableListReadOnlyDelegate.observableListReadOnlyProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableListReadOnlyDelegate / observableListReadOnlyProperty
+
+

observableListReadOnlyProperty

+ +val observableListReadOnlyProperty: (M) -> ObservableList<out T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/-init-.html new file mode 100644 index 0000000000..2fdf94b08c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObservableValueDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableValueDelegate / <init>
+
+

<init>

+ObservableValueDelegate(klass: KClass<M>, observableValueProperty: (M) -> ObservableValue<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/get-value.html new file mode 100644 index 0000000000..9838079234 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableValueDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableValueDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableValue<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/index.html new file mode 100644 index 0000000000..54bdb1f4b3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObservableValueDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableValueDelegate
+
+

ObservableValueDelegate

+class ObservableValueDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObservableValueDelegate(klass: KClass<M>, observableValueProperty: (M) -> ObservableValue<T>)
+

Properties

+ + + + + + + +
+observableValueProperty +val observableValueProperty: (M) -> ObservableValue<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): ObservableValue<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/observable-value-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/observable-value-property.html new file mode 100644 index 0000000000..7995ae6132 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observable-value-delegate/observable-value-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObservableValueDelegate.observableValueProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObservableValueDelegate / observableValueProperty
+
+

observableValueProperty

+ +val observableValueProperty: (M) -> ObservableValue<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/-init-.html new file mode 100644 index 0000000000..99e80c1aa4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.ObserverDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObserverDelegate / <init>
+
+

<init>

+ObserverDelegate(klass: KClass<M>, observerProperty: (M) -> Observer<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/get-value.html new file mode 100644 index 0000000000..d337386764 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObserverDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObserverDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): Observer<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/index.html new file mode 100644 index 0000000000..75564d3247 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.ObserverDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObserverDelegate
+
+

ObserverDelegate

+class ObserverDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +ObserverDelegate(klass: KClass<M>, observerProperty: (M) -> Observer<T>)
+

Properties

+ + + + + + + +
+observerProperty +val observerProperty: (M) -> Observer<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): Observer<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/observer-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/observer-property.html new file mode 100644 index 0000000000..7e25f5bc00 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-observer-delegate/observer-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.ObserverDelegate.observerProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / ObserverDelegate / observerProperty
+
+

observerProperty

+ +val observerProperty: (M) -> Observer<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/-init-.html new file mode 100644 index 0000000000..288a3d047d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.SubjectDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / SubjectDelegate / <init>
+
+

<init>

+SubjectDelegate(klass: KClass<M>, subjectProperty: (M) -> Subject<T, T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/get-value.html new file mode 100644 index 0000000000..687be89345 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.SubjectDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / SubjectDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): Subject<T, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/index.html new file mode 100644 index 0000000000..984e3f3ff4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.SubjectDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / SubjectDelegate
+
+

SubjectDelegate

+class SubjectDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +SubjectDelegate(klass: KClass<M>, subjectProperty: (M) -> Subject<T, T>)
+

Properties

+ + + + + + + +
+subjectProperty +val subjectProperty: (M) -> Subject<T, T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): Subject<T, T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/subject-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/subject-property.html new file mode 100644 index 0000000000..4fa7913d1c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-subject-delegate/subject-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.SubjectDelegate.subjectProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / SubjectDelegate / subjectProperty
+
+

subjectProperty

+ +val subjectProperty: (M) -> Subject<T, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/-init-.html new file mode 100644 index 0000000000..0f3af5d939 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/-init-.html @@ -0,0 +1,13 @@ + + + +TrackedDelegate.WritableValueDelegate.<init> - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / WritableValueDelegate / <init>
+
+

<init>

+WritableValueDelegate(klass: KClass<M>, writableValueProperty: (M) -> WritableValue<T>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/get-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/get-value.html new file mode 100644 index 0000000000..1d6bbf8213 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/get-value.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.WritableValueDelegate.getValue - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / WritableValueDelegate / getValue
+
+

getValue

+ +operator fun getValue(thisRef: Any, property: KProperty<*>): WritableValue<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/index.html new file mode 100644 index 0000000000..d9f9a098f7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/index.html @@ -0,0 +1,57 @@ + + + +TrackedDelegate.WritableValueDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / WritableValueDelegate
+
+

WritableValueDelegate

+class WritableValueDelegate<M : Any, T> : TrackedDelegate<M> +

Constructors

+ + + + + + + +
+<init> +WritableValueDelegate(klass: KClass<M>, writableValueProperty: (M) -> WritableValue<T>)
+

Properties

+ + + + + + + +
+writableValueProperty +val writableValueProperty: (M) -> WritableValue<T>
+

Inherited Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Functions

+ + + + + + + +
+getValue +operator fun getValue(thisRef: Any, property: KProperty<*>): WritableValue<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/writable-value-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/writable-value-property.html new file mode 100644 index 0000000000..73a975c7b3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/-writable-value-delegate/writable-value-property.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.WritableValueDelegate.writableValueProperty - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / WritableValueDelegate / writableValueProperty
+
+

writableValueProperty

+ +val writableValueProperty: (M) -> WritableValue<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/index.html new file mode 100644 index 0000000000..4ff01928d2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/index.html @@ -0,0 +1,154 @@ + + + +TrackedDelegate - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate
+
+

TrackedDelegate

+sealed class TrackedDelegate<M : Any> +

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+EventSinkDelegate +class EventSinkDelegate<M : Any, T> : TrackedDelegate<M>
+EventStreamDelegate +class EventStreamDelegate<M : Any, T> : TrackedDelegate<M>
+ObjectPropertyDelegate +class ObjectPropertyDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableDelegate +class ObservableDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableListDelegate +class ObservableListDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableListReadOnlyDelegate +class ObservableListReadOnlyDelegate<M : Any, out T> : TrackedDelegate<M>
+ObservableValueDelegate +class ObservableValueDelegate<M : Any, T> : TrackedDelegate<M>
+ObserverDelegate +class ObserverDelegate<M : Any, T> : TrackedDelegate<M>
+SubjectDelegate +class SubjectDelegate<M : Any, T> : TrackedDelegate<M>
+WritableValueDelegate +class WritableValueDelegate<M : Any, T> : TrackedDelegate<M>
+

Properties

+ + + + + + + +
+klass +val klass: KClass<M>
+

Inheritors

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+EventSinkDelegate +class EventSinkDelegate<M : Any, T> : TrackedDelegate<M>
+EventStreamDelegate +class EventStreamDelegate<M : Any, T> : TrackedDelegate<M>
+ObjectPropertyDelegate +class ObjectPropertyDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableDelegate +class ObservableDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableListDelegate +class ObservableListDelegate<M : Any, T> : TrackedDelegate<M>
+ObservableListReadOnlyDelegate +class ObservableListReadOnlyDelegate<M : Any, out T> : TrackedDelegate<M>
+ObservableValueDelegate +class ObservableValueDelegate<M : Any, T> : TrackedDelegate<M>
+ObserverDelegate +class ObserverDelegate<M : Any, T> : TrackedDelegate<M>
+SubjectDelegate +class SubjectDelegate<M : Any, T> : TrackedDelegate<M>
+WritableValueDelegate +class WritableValueDelegate<M : Any, T> : TrackedDelegate<M>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/klass.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/klass.html new file mode 100644 index 0000000000..637e9f797b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-tracked-delegate/klass.html @@ -0,0 +1,14 @@ + + + +TrackedDelegate.klass - corda + + + +corda / net.corda.client.jfx.model / TrackedDelegate / klass
+
+

klass

+ +val klass: KClass<M> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/-init-.html new file mode 100644 index 0000000000..0f56dad66f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/-init-.html @@ -0,0 +1,13 @@ + + + +TransactionCreateStatus.Failed.<init> - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / Failed / <init>
+
+

<init>

+Failed(message: String?) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/index.html new file mode 100644 index 0000000000..ac40323a0d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-failed/index.html @@ -0,0 +1,46 @@ + + + +TransactionCreateStatus.Failed - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / Failed
+
+

Failed

+class Failed : TransactionCreateStatus +

Constructors

+ + + + + + + +
+<init> +Failed(message: String?)
+

Inherited Properties

+ + + + + + + +
+message +val message: String?
+

Inherited Functions

+ + + + + + + +
+toString +open fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/-init-.html new file mode 100644 index 0000000000..83889d9159 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/-init-.html @@ -0,0 +1,13 @@ + + + +TransactionCreateStatus.Started.<init> - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / Started / <init>
+
+

<init>

+Started(message: String?) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/index.html new file mode 100644 index 0000000000..365be18fbf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/-started/index.html @@ -0,0 +1,46 @@ + + + +TransactionCreateStatus.Started - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / Started
+
+

Started

+class Started : TransactionCreateStatus +

Constructors

+ + + + + + + +
+<init> +Started(message: String?)
+

Inherited Properties

+ + + + + + + +
+message +val message: String?
+

Inherited Functions

+ + + + + + + +
+toString +open fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/index.html new file mode 100644 index 0000000000..8a3b91955c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/index.html @@ -0,0 +1,69 @@ + + + +TransactionCreateStatus - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus
+
+

TransactionCreateStatus

+sealed class TransactionCreateStatus +

Types

+ + + + + + + + + + + +
+Failed +class Failed : TransactionCreateStatus
+Started +class Started : TransactionCreateStatus
+

Properties

+ + + + + + + +
+message +val message: String?
+

Functions

+ + + + + + + +
+toString +open fun toString(): String
+

Inheritors

+ + + + + + + + + + + +
+Failed +class Failed : TransactionCreateStatus
+Started +class Started : TransactionCreateStatus
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/message.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/message.html new file mode 100644 index 0000000000..f23464d6cf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/message.html @@ -0,0 +1,14 @@ + + + +TransactionCreateStatus.message - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / message
+
+

message

+ +val message: String? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/to-string.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/to-string.html new file mode 100644 index 0000000000..1e9de892b0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-create-status/to-string.html @@ -0,0 +1,14 @@ + + + +TransactionCreateStatus.toString - corda + + + +corda / net.corda.client.jfx.model / TransactionCreateStatus / toString
+
+

toString

+ +open fun toString(): String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/-init-.html new file mode 100644 index 0000000000..56c7b60656 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/-init-.html @@ -0,0 +1,14 @@ + + + +TransactionDataModel.<init> - corda + + + +corda / net.corda.client.jfx.model / TransactionDataModel / <init>
+
+

<init>

+TransactionDataModel() +

This model provides an observable list of transactions and what state machines/flows recorded them

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/index.html new file mode 100644 index 0000000000..292247397d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/index.html @@ -0,0 +1,38 @@ + + + +TransactionDataModel - corda + + + +corda / net.corda.client.jfx.model / TransactionDataModel
+
+

TransactionDataModel

+class TransactionDataModel +

This model provides an observable list of transactions and what state machines/flows recorded them

+

Constructors

+ + + + + + + +
+<init> +TransactionDataModel() +

This model provides an observable list of transactions and what state machines/flows recorded them

+
+

Properties

+ + + + + + + +
+partiallyResolvedTransactions +val partiallyResolvedTransactions: ObservableList<PartiallyResolvedTransaction>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/partially-resolved-transactions.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/partially-resolved-transactions.html new file mode 100644 index 0000000000..16c28dc9a5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/-transaction-data-model/partially-resolved-transactions.html @@ -0,0 +1,14 @@ + + + +TransactionDataModel.partiallyResolvedTransactions - corda + + + +corda / net.corda.client.jfx.model / TransactionDataModel / partiallyResolvedTransactions
+
+

partiallyResolvedTransactions

+ +val partiallyResolvedTransactions: ObservableList<PartiallyResolvedTransaction> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-sink.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-sink.html new file mode 100644 index 0000000000..b57fcbb3c2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-sink.html @@ -0,0 +1,14 @@ + + + +eventSink - corda + + + +corda / net.corda.client.jfx.model / eventSink
+
+

eventSink

+ +inline fun <reified M : Any, T> eventSink(noinline sinkProperty: (M) -> <ERROR CLASS><T>): <ERROR CLASS> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-stream.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-stream.html new file mode 100644 index 0000000000..34c4a8c526 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/event-stream.html @@ -0,0 +1,14 @@ + + + +eventStream - corda + + + +corda / net.corda.client.jfx.model / eventStream
+
+

eventStream

+ +inline fun <reified M : Any, T> eventStream(noinline streamProperty: (M) -> <ERROR CLASS><T>): <ERROR CLASS> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-amount.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-amount.html new file mode 100644 index 0000000000..f610b95182 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-amount.html @@ -0,0 +1,14 @@ + + + +exchangeAmount - corda + + + +corda / net.corda.client.jfx.model / exchangeAmount
+
+

exchangeAmount

+ +fun ExchangeRate.exchangeAmount(amount: Amount<Currency>, to: Currency): Amount<Currency> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-double.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-double.html new file mode 100644 index 0000000000..e3982be8b0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/exchange-double.html @@ -0,0 +1,14 @@ + + + +exchangeDouble - corda + + + +corda / net.corda.client.jfx.model / exchangeDouble
+
+

exchangeDouble

+ +fun ExchangeRate.exchangeDouble(amount: Amount<Currency>, to: Currency): Double + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/index.html new file mode 100644 index 0000000000..d3599e8a8c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/index.html @@ -0,0 +1,206 @@ + + + +net.corda.client.jfx.model - corda + + + +corda / net.corda.client.jfx.model
+
+

Package net.corda.client.jfx.model

+

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ContractStateModel +class ContractStateModel +

This model exposes the list of owned contract states.

+
+Diff +data class Diff<out T : ContractState>
+ExchangeRate +interface ExchangeRate
+ExchangeRateModel +class ExchangeRateModel +

This model provides an exchange rate from arbitrary currency to arbitrary currency. +TODO hook up an actual oracle

+
+FlowStatus +data class FlowStatus
+GatheredTransactionData +data class GatheredTransactionData
+Models +object Models
+NetworkIdentityModel +class NetworkIdentityModel
+NodeMonitorModel +class NodeMonitorModel +

This model exposes raw event streams to and from the node.

+
+PartiallyResolvedTransaction +data class PartiallyResolvedTransaction +

PartiallyResolvedTransaction holds a SignedTransaction that has zero or more inputs resolved. The intent is +to prepare clients for cases where an input can only be resolved in the future/cannot be resolved at all (for example +because of permissioning)

+
+ProgressTrackingEvent +data class ProgressTrackingEvent
+StateMachineData +data class StateMachineData
+StateMachineStatus +sealed class StateMachineStatus
+TrackedDelegate +sealed class TrackedDelegate<M : Any>
+TransactionCreateStatus +sealed class TransactionCreateStatus
+TransactionDataModel +class TransactionDataModel +

This model provides an observable list of transactions and what state machines/flows recorded them

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+eventSink +fun <M : Any, T> eventSink(sinkProperty: (M) -> <ERROR CLASS><T>): <ERROR CLASS>
+eventStream +fun <M : Any, T> eventStream(streamProperty: (M) -> <ERROR CLASS><T>): <ERROR CLASS>
+exchangeAmount +fun ExchangeRate.exchangeAmount(amount: Amount<Currency>, to: Currency): Amount<Currency>
+exchangeDouble +fun ExchangeRate.exchangeDouble(amount: Amount<Currency>, to: Currency): Double
+objectProperty +fun <M : Any, T> objectProperty(objectProperty: (M) -> ObjectProperty<T>): ObjectPropertyDelegate<M, T>
+observable +fun <M : Any, T> observable(observableProperty: (M) -> Observable<T>): ObservableDelegate<M, T> +

This file defines a global Models store and delegates to inject event streams/sinks. Note that all streams here +are global.

+
+observableList +fun <M : Any, T> observableList(observableListProperty: (M) -> ObservableList<T>): ObservableListDelegate<M, T>
+observableListReadOnly +fun <M : Any, T> observableListReadOnly(observableListProperty: (M) -> ObservableList<out T>): ObservableListReadOnlyDelegate<M, T>
+observableValue +fun <M : Any, T> observableValue(observableValueProperty: (M) -> ObservableValue<T>): ObservableValueDelegate<M, T>
+observer +fun <M : Any, T> observer(observerProperty: (M) -> Observer<T>): ObserverDelegate<M, T>
+subject +fun <M : Any, T> subject(subjectProperty: (M) -> Subject<T, T>): SubjectDelegate<M, T>
+writableValue +fun <M : Any, T> writableValue(writableValueProperty: (M) -> WritableValue<T>): WritableValueDelegate<M, T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/object-property.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/object-property.html new file mode 100644 index 0000000000..410e6d2b5b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/object-property.html @@ -0,0 +1,14 @@ + + + +objectProperty - corda + + + +corda / net.corda.client.jfx.model / objectProperty
+
+

objectProperty

+ +inline fun <reified M : Any, T> objectProperty(noinline objectProperty: (M) -> ObjectProperty<T>): ObjectPropertyDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list-read-only.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list-read-only.html new file mode 100644 index 0000000000..5f79172aa6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list-read-only.html @@ -0,0 +1,14 @@ + + + +observableListReadOnly - corda + + + +corda / net.corda.client.jfx.model / observableListReadOnly
+
+

observableListReadOnly

+ +inline fun <reified M : Any, T> observableListReadOnly(noinline observableListProperty: (M) -> ObservableList<out T>): ObservableListReadOnlyDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list.html new file mode 100644 index 0000000000..2f3abc205a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-list.html @@ -0,0 +1,14 @@ + + + +observableList - corda + + + +corda / net.corda.client.jfx.model / observableList
+
+

observableList

+ +inline fun <reified M : Any, T> observableList(noinline observableListProperty: (M) -> ObservableList<T>): ObservableListDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-value.html new file mode 100644 index 0000000000..b8f797b528 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable-value.html @@ -0,0 +1,14 @@ + + + +observableValue - corda + + + +corda / net.corda.client.jfx.model / observableValue
+
+

observableValue

+ +inline fun <reified M : Any, T> observableValue(noinline observableValueProperty: (M) -> ObservableValue<T>): ObservableValueDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable.html new file mode 100644 index 0000000000..3bf677140c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observable.html @@ -0,0 +1,49 @@ + + + +observable - corda + + + +corda / net.corda.client.jfx.model / observable
+
+

observable

+ +inline fun <reified M : Any, T> observable(noinline observableProperty: (M) -> Observable<T>): ObservableDelegate<M, T> +

This file defines a global Models store and delegates to inject event streams/sinks. Note that all streams here +are global.

+

This allows decoupling of UI logic from stream initialisation and provides us with a central place to inspect data +flows. It also allows detecting of looping logic by constructing a stream dependency graph TODO do this.

+

Usage: +// Inject service -> client event stream +private val serviceToClient: EventStream by eventStream(WalletMonitorModel::serviceToClient)

+

Each Screen code should have a code layout like this:

+

class Screen { +val root = (..)

+

inject UI elements using fxid/inject

+

inject observable dependencies using observable/eventSinketc

+

define screen-specific observables

+

init { + wire up UI elements +} +}

+

For example if I wanted to display a list of all USD cash states: +class USDCashStatesScreen { +val root: Pane by fxml()

+

val usdCashStatesListView: ListView<Cash.State> by fxid("USDCashStatesListView")

+

val cashStates: ObservableList<Cash.State> by observableList(ContractStateModel::cashStates)

+

val usdCashStates = cashStates.filter { it.(..).currency == USD }

+

init { + Bindings.bindContent(usdCashStatesListView.items, usdCashStates) + usdCashStatesListView.setCellValueFactory(somethingsomething) +} +}

+

The UI code can just assume that the cash state list comes from somewhere outside. The initialisation of that +observable is decoupled, it may be mocked or be streamed from the network etc.

+

Later on we may even want to move all screen-specific observables to a separate Model as well (like usdCashStates) - this +would allow moving all of the aggregation logic to e.g. a different machine, all the UI will do is inject these and wire +them up with the UI elements.

+

Another advantage of this separation is that once we start adding a lot of screens we can still track data dependencies +in a central place as opposed to ad-hoc wiring up the observables.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observer.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observer.html new file mode 100644 index 0000000000..f1409acc85 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/observer.html @@ -0,0 +1,14 @@ + + + +observer - corda + + + +corda / net.corda.client.jfx.model / observer
+
+

observer

+ +inline fun <reified M : Any, T> observer(noinline observerProperty: (M) -> Observer<T>): ObserverDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/subject.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/subject.html new file mode 100644 index 0000000000..d6463a1374 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/subject.html @@ -0,0 +1,14 @@ + + + +subject - corda + + + +corda / net.corda.client.jfx.model / subject
+
+

subject

+ +inline fun <reified M : Any, T> subject(noinline subjectProperty: (M) -> Subject<T, T>): SubjectDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/writable-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/writable-value.html new file mode 100644 index 0000000000..bf6afdfda3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.model/writable-value.html @@ -0,0 +1,14 @@ + + + +writableValue - corda + + + +corda / net.corda.client.jfx.model / writableValue
+
+

writableValue

+ +inline fun <reified M : Any, T> writableValue(noinline writableValueProperty: (M) -> WritableValue<T>): WritableValueDelegate<M, T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/-init-.html new file mode 100644 index 0000000000..17d39ccc86 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/-init-.html @@ -0,0 +1,40 @@ + + + +AggregatedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / <init>
+
+

<init>

+AggregatedList(list: ObservableList<out E>, toKey: (E) -> K, assemble: (K, ObservableList<E>) -> A) +

Given an ObservableList<E> and a grouping key K, AggregatedList groups the elements by the key into a fresh +ObservableList<E> for each group and exposes the groups as an observable list of As by calling assemble on each.

+

Changes done to elements of the input list are reflected in the observable list of the respective group, whereas +additions/removals of elements in the underlying list are reflected in the exposed ObservableList<A> by +adding/deleting aggregations as expected.

+

The ordering of the exposed list is based on the hashCode of keys. +The ordering of the groups themselves is based on the hashCode of elements.

+

Warning: If there are two elements E in the source list that have the same hashCode then it is not deterministic +which one will be removed if one is removed from the source list!

+

Example: +val statesGroupedByCurrency = AggregatedList(states, { state -> state.currency }) { currency, group -> + object { + val currency = currency + val states = group + } +}

+

The above creates an observable list of (currency, statesOfCurrency) pairs.

+

Note that update events to the source list are discarded, assuming the key of elements does not change. +TODO Should we handle this case? It requires additional bookkeeping of sourceIndex->(aggregationIndex, groupIndex)

+

Parameters

+ +

+list - The underlying list. +

+toKey - Function to extract the key from an element. +

+assemble - Function to assemble the aggregation into the exposed A. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/assemble.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/assemble.html new file mode 100644 index 0000000000..bbd5746b32 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/assemble.html @@ -0,0 +1,14 @@ + + + +AggregatedList.assemble - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / assemble
+
+

assemble

+ +val assemble: (K, ObservableList<E>) -> A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get-source-index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get-source-index.html new file mode 100644 index 0000000000..10f9c4eca0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get-source-index.html @@ -0,0 +1,15 @@ + + + +AggregatedList.getSourceIndex - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / getSourceIndex
+
+

getSourceIndex

+ +fun getSourceIndex(index: Int): Int +

We cannot implement this as aggregations are one to many

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get.html new file mode 100644 index 0000000000..bb331b9c35 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/get.html @@ -0,0 +1,14 @@ + + + +AggregatedList.get - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / get
+
+

get

+ +fun get(index: Int): A? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/index.html new file mode 100644 index 0000000000..58a81b1dba --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/index.html @@ -0,0 +1,261 @@ + + + +AggregatedList - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList
+
+

AggregatedList

+class AggregatedList<A, E : Any, K : Any> : TransformationList<A, E> +

Given an ObservableList<E> and a grouping key K, AggregatedList groups the elements by the key into a fresh +ObservableList<E> for each group and exposes the groups as an observable list of As by calling assemble on each.

+

Changes done to elements of the input list are reflected in the observable list of the respective group, whereas +additions/removals of elements in the underlying list are reflected in the exposed ObservableList<A> by +adding/deleting aggregations as expected.

+

The ordering of the exposed list is based on the hashCode of keys. +The ordering of the groups themselves is based on the hashCode of elements.

+

Warning: If there are two elements E in the source list that have the same hashCode then it is not deterministic +which one will be removed if one is removed from the source list!

+

Example: +val statesGroupedByCurrency = AggregatedList(states, { state -> state.currency }) { currency, group -> + object { + val currency = currency + val states = group + } +}

+

The above creates an observable list of (currency, statesOfCurrency) pairs.

+

Note that update events to the source list are discarded, assuming the key of elements does not change. +TODO Should we handle this case? It requires additional bookkeeping of sourceIndex->(aggregationIndex, groupIndex)

+

Parameters

+ +

+list - The underlying list. +

+toKey - Function to extract the key from an element. +

+assemble - Function to assemble the aggregation into the exposed A. +

Constructors

+ + + + + + + +
+<init> +AggregatedList(list: ObservableList<out E>, toKey: (E) -> K, assemble: (K, ObservableList<E>) -> A) +

Given an ObservableList<E> and a grouping key K, AggregatedList groups the elements by the key into a fresh +ObservableList<E> for each group and exposes the groups as an observable list of As by calling assemble on each.

+
+

Properties

+ + + + + + + + + + + + + + + +
+assemble +val assemble: (K, ObservableList<E>) -> A
+size +val size: Int
+toKey +val toKey: (E) -> K
+

Functions

+ + + + + + + + + + + + + + + +
+get +fun get(index: Int): A?
+getSourceIndex +fun getSourceIndex(index: Int): Int +

We cannot implement this as aggregations are one to many

+
+sourceChanged +fun sourceChanged(c: Change<out E>): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/size.html new file mode 100644 index 0000000000..758dfc50f7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/size.html @@ -0,0 +1,14 @@ + + + +AggregatedList.size - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/source-changed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/source-changed.html new file mode 100644 index 0000000000..3a084c1766 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/source-changed.html @@ -0,0 +1,14 @@ + + + +AggregatedList.sourceChanged - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / sourceChanged
+
+

sourceChanged

+ +protected fun sourceChanged(c: Change<out E>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/to-key.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/to-key.html new file mode 100644 index 0000000000..67c01c90ca --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-aggregated-list/to-key.html @@ -0,0 +1,14 @@ + + + +AggregatedList.toKey - corda + + + +corda / net.corda.client.jfx.utils / AggregatedList / toKey
+
+

toKey

+ +val toKey: (E) -> K + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/exchange.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/exchange.html new file mode 100644 index 0000000000..6ea6dfeed0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/exchange.html @@ -0,0 +1,14 @@ + + + +AmountBindings.exchange - corda + + + +corda / net.corda.client.jfx.utils / AmountBindings / exchange
+
+

exchange

+ +fun exchange(currency: ObservableValue<Currency>, exchangeRate: ObservableValue<ExchangeRate>): ObservableValue<Pair<Currency, (Amount<Currency>) -> Long>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/index.html new file mode 100644 index 0000000000..8ea1f7074a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/index.html @@ -0,0 +1,37 @@ + + + +AmountBindings - corda + + + +corda / net.corda.client.jfx.utils / AmountBindings
+
+

AmountBindings

+object AmountBindings +

Utility bindings for the Amount type, similar in spirit to Bindings

+

Functions

+ + + + + + + + + + + + + + + +
+exchange +fun exchange(currency: ObservableValue<Currency>, exchangeRate: ObservableValue<ExchangeRate>): ObservableValue<Pair<Currency, (Amount<Currency>) -> Long>>
+sum +fun <T> sum(amounts: ObservableList<Amount<T>>, token: T): <ERROR CLASS>
+sumAmountExchange +fun sumAmountExchange(amounts: ObservableList<Amount<Currency>>, currency: ObservableValue<Currency>, exchangeRate: ObservableValue<ExchangeRate>): ObservableValue<Amount<Currency>>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum-amount-exchange.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum-amount-exchange.html new file mode 100644 index 0000000000..a6f4375396 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum-amount-exchange.html @@ -0,0 +1,14 @@ + + + +AmountBindings.sumAmountExchange - corda + + + +corda / net.corda.client.jfx.utils / AmountBindings / sumAmountExchange
+
+

sumAmountExchange

+ +fun sumAmountExchange(amounts: ObservableList<Amount<Currency>>, currency: ObservableValue<Currency>, exchangeRate: ObservableValue<ExchangeRate>): ObservableValue<Amount<Currency>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum.html new file mode 100644 index 0000000000..742f7a5266 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-amount-bindings/sum.html @@ -0,0 +1,14 @@ + + + +AmountBindings.sum - corda + + + +corda / net.corda.client.jfx.utils / AmountBindings / sum
+
+

sum

+ +fun <T> sum(amounts: ObservableList<Amount<T>>, token: T): <ERROR CLASS> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/-init-.html new file mode 100644 index 0000000000..c3a3c56133 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/-init-.html @@ -0,0 +1,23 @@ + + + +AssociatedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / AssociatedList / <init>
+
+

<init>

+AssociatedList(sourceList: ObservableList<out A>, toKey: (A) -> K, assemble: (K, A) -> B) +

AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

+

Parameters

+ +

+sourceList - The source list. +

+toKey - Function returning the key. +

+assemble - The function to assemble the final map element from the list element and the associated key. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/index.html new file mode 100644 index 0000000000..0e5f5e699f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/index.html @@ -0,0 +1,150 @@ + + + +AssociatedList - corda + + + +corda / net.corda.client.jfx.utils / AssociatedList
+
+

AssociatedList

+class AssociatedList<K, out A, B> : ReadOnlyBackedObservableMapBase<K, B, Unit> +

AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

+

Parameters

+ +

+sourceList - The source list. +

+toKey - Function returning the key. +

+assemble - The function to assemble the final map element from the list element and the associated key. +

Constructors

+ + + + + + + +
+<init> +AssociatedList(sourceList: ObservableList<out A>, toKey: (A) -> K, assemble: (K, A) -> B) +

AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

+
+

Properties

+ + + + + + + +
+sourceList +val sourceList: ObservableList<out A>
+

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+backingMap +val backingMap: HashMap<K, Pair<A, B>>
+entries +open val entries: MutableSet<MutableEntry<K, A>>
+keys +open val keys: MutableSet<K>
+size +open val size: Int
+values +open val values: MutableCollection<A>
+

Inherited Functions

+ + + + + + + + + + + + + + + + + + + +
+addListener +open fun addListener(listener: InvalidationListener): Unit
+clear +open fun clear(): Unit
+isEmpty +open fun isEmpty(): Boolean
+removeListener +open fun removeListener(listener: InvalidationListener?): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + +
+createMapChange +fun <A, K> ObservableMap<K, A>.createMapChange(key: K, removedValue: A?, addedValue: A?): Change<K, A>
+getObservableEntries +fun <K, V> ObservableMap<K, V>.getObservableEntries(): ObservableList<Entry<K, V>> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+getObservableValue +fun <K, V> ObservableMap<K, V>.getObservableValue(key: K): ObservableValue<V?> +

val nameToPerson: ObservableMap<String, Person> = (..) +val john: ObservableValue<Person?> = nameToPerson.getObservableValue("John")

+
+getObservableValues +fun <K, V> ObservableMap<K, V>.getObservableValues(): ObservableList<V> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/source-list.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/source-list.html new file mode 100644 index 0000000000..afcd036378 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-associated-list/source-list.html @@ -0,0 +1,14 @@ + + + +AssociatedList.sourceList - corda + + + +corda / net.corda.client.jfx.utils / AssociatedList / sourceList
+
+

sourceList

+ +val sourceList: ObservableList<out A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/-init-.html new file mode 100644 index 0000000000..ec67d42442 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/-init-.html @@ -0,0 +1,23 @@ + + + +ChosenList.<init> - corda + + + +corda / net.corda.client.jfx.utils / ChosenList / <init>
+
+

<init>

+ChosenList(chosenListObservable: ObservableValue<out ObservableList<out E>>) +

ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

+

Example: +val filteredStates = ChosenList(EasyBind.map(filterCriteriaType) { type -> + when (type) { + is (ByCurrency) -> statesFilteredByCurrency + is (ByIssuer) -> statesFilteredByIssuer + } +})

+

The above will create a list that chooses and delegates to the appropriate filtered list based on the type of filter.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/get.html new file mode 100644 index 0000000000..3c1fbe8384 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/get.html @@ -0,0 +1,14 @@ + + + +ChosenList.get - corda + + + +corda / net.corda.client.jfx.utils / ChosenList / get
+
+

get

+ +fun get(index: Int): E + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/index.html new file mode 100644 index 0000000000..36ee4748c2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/index.html @@ -0,0 +1,218 @@ + + + +ChosenList - corda + + + +corda / net.corda.client.jfx.utils / ChosenList
+
+

ChosenList

+class ChosenList<E> : ObservableListBase<E> +

ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

+

Example: +val filteredStates = ChosenList(EasyBind.map(filterCriteriaType) { type -> + when (type) { + is (ByCurrency) -> statesFilteredByCurrency + is (ByIssuer) -> statesFilteredByIssuer + } +})

+

The above will create a list that chooses and delegates to the appropriate filtered list based on the type of filter.

+

Constructors

+ + + + + + + +
+<init> +ChosenList(chosenListObservable: ObservableValue<out ObservableList<out E>>) +

ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

+
+

Properties

+ + + + + + + +
+size +val size: Int
+

Functions

+ + + + + + + +
+get +fun get(index: Int): E
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/size.html new file mode 100644 index 0000000000..46cff94ac5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-chosen-list/size.html @@ -0,0 +1,14 @@ + + + +ChosenList.size - corda + + + +corda / net.corda.client.jfx.utils / ChosenList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/-init-.html new file mode 100644 index 0000000000..3641901b93 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/-init-.html @@ -0,0 +1,15 @@ + + + +ConcatenatedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList / <init>
+
+

<init>

+ConcatenatedList(sourceList: ObservableList<ObservableList<A>>) +

ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get-source-index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get-source-index.html new file mode 100644 index 0000000000..4bcff1e803 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get-source-index.html @@ -0,0 +1,14 @@ + + + +ConcatenatedList.getSourceIndex - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList / getSourceIndex
+
+

getSourceIndex

+ +fun getSourceIndex(index: Int): Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get.html new file mode 100644 index 0000000000..17fd03bf19 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/get.html @@ -0,0 +1,14 @@ + + + +ConcatenatedList.get - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList / get
+
+

get

+ +fun get(index: Int): A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/index.html new file mode 100644 index 0000000000..0d62190dfc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/index.html @@ -0,0 +1,222 @@ + + + +ConcatenatedList - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList
+
+

ConcatenatedList

+class ConcatenatedList<A> : TransformationList<A, ObservableList<A>> +

ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

+

Constructors

+ + + + + + + +
+<init> +ConcatenatedList(sourceList: ObservableList<ObservableList<A>>) +

ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

+
+

Properties

+ + + + + + + +
+size +val size: Int
+

Functions

+ + + + + + + + + + + + + + + +
+get +fun get(index: Int): A
+getSourceIndex +fun getSourceIndex(index: Int): Int
+sourceChanged +fun sourceChanged(change: Change<out ObservableList<A>>): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/size.html new file mode 100644 index 0000000000..9efa19fa49 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/size.html @@ -0,0 +1,14 @@ + + + +ConcatenatedList.size - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/source-changed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/source-changed.html new file mode 100644 index 0000000000..8ba061076d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-concatenated-list/source-changed.html @@ -0,0 +1,14 @@ + + + +ConcatenatedList.sourceChanged - corda + + + +corda / net.corda.client.jfx.utils / ConcatenatedList / sourceChanged
+
+

sourceChanged

+ +protected fun sourceChanged(change: Change<out ObservableList<A>>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-init-.html new file mode 100644 index 0000000000..b92cc8be71 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-init-.html @@ -0,0 +1,15 @@ + + + +FlattenedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / <init>
+
+

<init>

+FlattenedList(sourceList: ObservableList<out ObservableValue<out A>>) +

FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/-init-.html new file mode 100644 index 0000000000..5045a0cbb6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/-init-.html @@ -0,0 +1,20 @@ + + + +FlattenedList.WrappedObservableValue.<init> - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / WrappedObservableValue / <init>
+
+

<init>

+WrappedObservableValue(observableValue: ObservableValue<A>) +

We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

+

Note that because of the bookkeeping required for this map, any remove operation and any add operation that +inserts to the middle of the list will be O(N) as we need to scan the map and shift indices accordingly.

+

Note also that we're wrapping each ObservableValue, this is required because we want to support reusing of +ObservableValues and we need each to have a different hash.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/index.html new file mode 100644 index 0000000000..e8d14a2662 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/index.html @@ -0,0 +1,46 @@ + + + +FlattenedList.WrappedObservableValue - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / WrappedObservableValue
+
+

WrappedObservableValue

+class WrappedObservableValue<A> +

We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

+

Note that because of the bookkeeping required for this map, any remove operation and any add operation that +inserts to the middle of the list will be O(N) as we need to scan the map and shift indices accordingly.

+

Note also that we're wrapping each ObservableValue, this is required because we want to support reusing of +ObservableValues and we need each to have a different hash.

+

Constructors

+ + + + + + + +
+<init> +WrappedObservableValue(observableValue: ObservableValue<A>) +

We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

+
+

Properties

+ + + + + + + +
+observableValue +val observableValue: ObservableValue<A>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/observable-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/observable-value.html new file mode 100644 index 0000000000..a697eef362 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/-wrapped-observable-value/observable-value.html @@ -0,0 +1,14 @@ + + + +FlattenedList.WrappedObservableValue.observableValue - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / WrappedObservableValue / observableValue
+
+

observableValue

+ +val observableValue: ObservableValue<A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get-source-index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get-source-index.html new file mode 100644 index 0000000000..2587b9cb20 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get-source-index.html @@ -0,0 +1,14 @@ + + + +FlattenedList.getSourceIndex - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / getSourceIndex
+
+

getSourceIndex

+ +fun getSourceIndex(index: Int): Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get.html new file mode 100644 index 0000000000..eaf2e282fb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/get.html @@ -0,0 +1,14 @@ + + + +FlattenedList.get - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / get
+
+

get

+ +fun get(index: Int): A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index-map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index-map.html new file mode 100644 index 0000000000..3ad909560f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index-map.html @@ -0,0 +1,14 @@ + + + +FlattenedList.indexMap - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / indexMap
+
+

indexMap

+ +val indexMap: HashMap<WrappedObservableValue<out A>, Pair<Int, ChangeListener<A>>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index.html new file mode 100644 index 0000000000..f27326f964 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/index.html @@ -0,0 +1,249 @@ + + + +FlattenedList - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList
+
+

FlattenedList

+class FlattenedList<A> : TransformationList<A, ObservableValue<out A>> +

FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

+

Types

+ + + + + + + +
+WrappedObservableValue +class WrappedObservableValue<A> +

We maintain an ObservableValue->index map. This is needed because we need the ObservableValue's index in order to +propagate a change and if the listener closure captures the index at the time of the call to +ObservableValue.addListener it will become incorrect if the indices shift around later.

+
+

Constructors

+ + + + + + + +
+<init> +FlattenedList(sourceList: ObservableList<out ObservableValue<out A>>) +

FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

+
+

Properties

+ + + + + + + + + + + + + + + +
+indexMap +val indexMap: HashMap<WrappedObservableValue<out A>, Pair<Int, ChangeListener<A>>>
+size +val size: Int
+sourceList +val sourceList: ObservableList<out ObservableValue<out A>>
+

Functions

+ + + + + + + + + + + + + + + +
+get +fun get(index: Int): A
+getSourceIndex +fun getSourceIndex(index: Int): Int
+sourceChanged +fun sourceChanged(c: Change<out ObservableValue<out A>>): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/size.html new file mode 100644 index 0000000000..325e51267c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/size.html @@ -0,0 +1,14 @@ + + + +FlattenedList.size - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-changed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-changed.html new file mode 100644 index 0000000000..f01f935d8b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-changed.html @@ -0,0 +1,14 @@ + + + +FlattenedList.sourceChanged - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / sourceChanged
+
+

sourceChanged

+ +protected fun sourceChanged(c: Change<out ObservableValue<out A>>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-list.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-list.html new file mode 100644 index 0000000000..39885b4f2f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-flattened-list/source-list.html @@ -0,0 +1,14 @@ + + + +FlattenedList.sourceList - corda + + + +corda / net.corda.client.jfx.utils / FlattenedList / sourceList
+
+

sourceList

+ +val sourceList: ObservableList<out ObservableValue<out A>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/-init-.html new file mode 100644 index 0000000000..018ca6851c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/-init-.html @@ -0,0 +1,15 @@ + + + +LeftOuterJoinedMap.<init> - corda + + + +corda / net.corda.client.jfx.utils / LeftOuterJoinedMap / <init>
+
+

<init>

+LeftOuterJoinedMap(leftTable: ObservableMap<K, out A>, rightTable: ObservableMap<K, out B>, assemble: (K, A, ObservableValue<B?>) -> C) +

LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/index.html new file mode 100644 index 0000000000..c122795fce --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/index.html @@ -0,0 +1,148 @@ + + + +LeftOuterJoinedMap - corda + + + +corda / net.corda.client.jfx.utils / LeftOuterJoinedMap
+
+

LeftOuterJoinedMap

+class LeftOuterJoinedMap<K : Any, A, B, C> : ReadOnlyBackedObservableMapBase<K, C, SimpleObjectProperty<B?>> +

LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

+

Constructors

+ + + + + + + +
+<init> +LeftOuterJoinedMap(leftTable: ObservableMap<K, out A>, rightTable: ObservableMap<K, out B>, assemble: (K, A, ObservableValue<B?>) -> C) +

LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

+
+

Properties

+ + + + + + + + + + + +
+leftTable +val leftTable: ObservableMap<K, out A>
+rightTable +val rightTable: ObservableMap<K, out B>
+

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+backingMap +val backingMap: HashMap<K, Pair<A, B>>
+entries +open val entries: MutableSet<MutableEntry<K, A>>
+keys +open val keys: MutableSet<K>
+size +open val size: Int
+values +open val values: MutableCollection<A>
+

Inherited Functions

+ + + + + + + + + + + + + + + + + + + +
+addListener +open fun addListener(listener: InvalidationListener): Unit
+clear +open fun clear(): Unit
+isEmpty +open fun isEmpty(): Boolean
+removeListener +open fun removeListener(listener: InvalidationListener?): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + +
+createMapChange +fun <A, K> ObservableMap<K, A>.createMapChange(key: K, removedValue: A?, addedValue: A?): Change<K, A>
+getObservableEntries +fun <K, V> ObservableMap<K, V>.getObservableEntries(): ObservableList<Entry<K, V>> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+getObservableValue +fun <K, V> ObservableMap<K, V>.getObservableValue(key: K): ObservableValue<V?> +

val nameToPerson: ObservableMap<String, Person> = (..) +val john: ObservableValue<Person?> = nameToPerson.getObservableValue("John")

+
+getObservableValues +fun <K, V> ObservableMap<K, V>.getObservableValues(): ObservableList<V> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/left-table.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/left-table.html new file mode 100644 index 0000000000..3e4aa44972 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/left-table.html @@ -0,0 +1,14 @@ + + + +LeftOuterJoinedMap.leftTable - corda + + + +corda / net.corda.client.jfx.utils / LeftOuterJoinedMap / leftTable
+
+

leftTable

+ +val leftTable: ObservableMap<K, out A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/right-table.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/right-table.html new file mode 100644 index 0000000000..15d1e3798f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-left-outer-joined-map/right-table.html @@ -0,0 +1,14 @@ + + + +LeftOuterJoinedMap.rightTable - corda + + + +corda / net.corda.client.jfx.utils / LeftOuterJoinedMap / rightTable
+
+

rightTable

+ +val rightTable: ObservableMap<K, out B> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/create.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/create.html new file mode 100644 index 0000000000..849ba4a6a1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/create.html @@ -0,0 +1,21 @@ + + + +MapValuesList.create - corda + + + +corda / net.corda.client.jfx.utils / MapValuesList / create
+
+

create

+ +fun <K, A, C> create(sourceMap: ObservableMap<K, A>, assemble: (Entry<K, A>) -> C): MapValuesList<K, A, C> +

create is the factory of MapValuesList.

+

Parameters

+ +

+sourceMap - The source map. +

+assemble - The function to be called for map each entry to construct the final list elements. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/index.html new file mode 100644 index 0000000000..bac15ac7a3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/index.html @@ -0,0 +1,198 @@ + + + +MapValuesList - corda + + + +corda / net.corda.client.jfx.utils / MapValuesList
+
+

MapValuesList

+class MapValuesList<K, A, C> : ObservableList<C> +

MapValuesList takes an ObservableMap and returns its values as an ObservableList. +The order of returned elements is deterministic but unspecified.

+

Properties

+ + + + + + + +
+sourceMap +val sourceMap: ObservableMap<K, A>
+

Companion Object Functions

+ + + + + + + +
+create +fun <K, A, C> create(sourceMap: ObservableMap<K, A>, assemble: (Entry<K, A>) -> C): MapValuesList<K, A, C> +

create is the factory of MapValuesList.

+
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/source-map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/source-map.html new file mode 100644 index 0000000000..12320707ff --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-map-values-list/source-map.html @@ -0,0 +1,14 @@ + + + +MapValuesList.sourceMap - corda + + + +corda / net.corda.client.jfx.utils / MapValuesList / sourceMap
+
+

sourceMap

+ +val sourceMap: ObservableMap<K, A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/-init-.html new file mode 100644 index 0000000000..131595a2a9 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/-init-.html @@ -0,0 +1,16 @@ + + + +MappedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / MappedList / <init>
+
+

<init>

+MappedList(list: ObservableList<A>, function: (A) -> B) +

This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/function.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/function.html new file mode 100644 index 0000000000..4c8245301b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/function.html @@ -0,0 +1,14 @@ + + + +MappedList.function - corda + + + +corda / net.corda.client.jfx.utils / MappedList / function
+
+

function

+ +val function: (A) -> B + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get-source-index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get-source-index.html new file mode 100644 index 0000000000..2edcceb9b9 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get-source-index.html @@ -0,0 +1,14 @@ + + + +MappedList.getSourceIndex - corda + + + +corda / net.corda.client.jfx.utils / MappedList / getSourceIndex
+
+

getSourceIndex

+ +fun getSourceIndex(index: Int): Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get.html new file mode 100644 index 0000000000..ad4f1bfea7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/get.html @@ -0,0 +1,14 @@ + + + +MappedList.get - corda + + + +corda / net.corda.client.jfx.utils / MappedList / get
+
+

get

+ +fun get(index: Int): B + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/index.html new file mode 100644 index 0000000000..a99a503d7d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/index.html @@ -0,0 +1,230 @@ + + + +MappedList - corda + + + +corda / net.corda.client.jfx.utils / MappedList
+
+

MappedList

+class MappedList<A, B> : TransformationList<B, A> +

This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

+

Constructors

+ + + + + + + +
+<init> +MappedList(list: ObservableList<A>, function: (A) -> B) +

This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

+
+

Properties

+ + + + + + + + + + + +
+function +val function: (A) -> B
+size +val size: Int
+

Functions

+ + + + + + + + + + + + + + + +
+get +fun get(index: Int): B
+getSourceIndex +fun getSourceIndex(index: Int): Int
+sourceChanged +fun sourceChanged(change: Change<out A>): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/size.html new file mode 100644 index 0000000000..88200c28ae --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/size.html @@ -0,0 +1,14 @@ + + + +MappedList.size - corda + + + +corda / net.corda.client.jfx.utils / MappedList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/source-changed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/source-changed.html new file mode 100644 index 0000000000..90baec58ce --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-mapped-list/source-changed.html @@ -0,0 +1,14 @@ + + + +MappedList.sourceChanged - corda + + + +corda / net.corda.client.jfx.utils / MappedList / sourceChanged
+
+

sourceChanged

+ +protected fun sourceChanged(change: Change<out A>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/-init-.html new file mode 100644 index 0000000000..ca196f9320 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/-init-.html @@ -0,0 +1,24 @@ + + + +ReadOnlyBackedObservableMapBase.<init> - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / <init>
+
+

<init>

+ReadOnlyBackedObservableMapBase() +

ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.

+

Non-read-only API calls throw.

+

Parameters

+ +

+K - The key type. +

+A - The exposed map element type. +

+B - Auxiliary data subclasses may wish to store in the backing map. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/add-listener.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/add-listener.html new file mode 100644 index 0000000000..5030082f64 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/add-listener.html @@ -0,0 +1,16 @@ + + + +ReadOnlyBackedObservableMapBase.addListener - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / addListener
+
+

addListener

+ +open fun addListener(listener: InvalidationListener): Unit
+ +open fun addListener(listener: MapChangeListener<in K, in A>?): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/backing-map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/backing-map.html new file mode 100644 index 0000000000..7db0b26416 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/backing-map.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.backingMap - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / backingMap
+
+

backingMap

+ +protected val backingMap: HashMap<K, Pair<A, B>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/clear.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/clear.html new file mode 100644 index 0000000000..c048c6d8f3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/clear.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.clear - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / clear
+
+

clear

+ +open fun clear(): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-key.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-key.html new file mode 100644 index 0000000000..a0eca8a98f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-key.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.containsKey - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / containsKey
+
+

containsKey

+ +open fun containsKey(key: K): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-value.html new file mode 100644 index 0000000000..9aefc2f7b2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/contains-value.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.containsValue - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / containsValue
+
+

containsValue

+ +open fun containsValue(value: A): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/entries.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/entries.html new file mode 100644 index 0000000000..b93d76111e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/entries.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.entries - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / entries
+
+

entries

+ +open val entries: MutableSet<MutableEntry<K, A>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/fire-change.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/fire-change.html new file mode 100644 index 0000000000..6af6f89017 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/fire-change.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.fireChange - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / fireChange
+
+

fireChange

+ +protected fun fireChange(change: Change<out K, out A>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/get.html new file mode 100644 index 0000000000..a5111e13b7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/get.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.get - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / get
+
+

get

+ +open fun get(key: K): A? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/index.html new file mode 100644 index 0000000000..d23d9e1a16 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/index.html @@ -0,0 +1,207 @@ + + + +ReadOnlyBackedObservableMapBase - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase
+
+

ReadOnlyBackedObservableMapBase

+open class ReadOnlyBackedObservableMapBase<K, A, B> : ObservableMap<K, A> +

ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.

+

Non-read-only API calls throw.

+

Parameters

+ +

+K - The key type. +

+A - The exposed map element type. +

+B - Auxiliary data subclasses may wish to store in the backing map. +

Constructors

+ + + + + + + +
+<init> +ReadOnlyBackedObservableMapBase() +

ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+backingMap +val backingMap: HashMap<K, Pair<A, B>>
+entries +open val entries: MutableSet<MutableEntry<K, A>>
+keys +open val keys: MutableSet<K>
+size +open val size: Int
+values +open val values: MutableCollection<A>
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+addListener +open fun addListener(listener: InvalidationListener): Unit
+open fun addListener(listener: MapChangeListener<in K, in A>?): Unit
+clear +open fun clear(): Unit
+containsKey +open fun containsKey(key: K): Boolean
+containsValue +open fun containsValue(value: A): Boolean
+fireChange +fun fireChange(change: Change<out K, out A>): Unit
+get +open fun get(key: K): A?
+isEmpty +open fun isEmpty(): Boolean
+put +open fun put(key: K, value: A): A
+putAll +open fun putAll(from: Map<out K, A>): Unit
+remove +open fun remove(key: K): A
+removeListener +open fun removeListener(listener: InvalidationListener?): Unit
+open fun removeListener(listener: MapChangeListener<in K, in A>?): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + +
+createMapChange +fun <A, K> ObservableMap<K, A>.createMapChange(key: K, removedValue: A?, addedValue: A?): Change<K, A>
+getObservableEntries +fun <K, V> ObservableMap<K, V>.getObservableEntries(): ObservableList<Entry<K, V>> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+getObservableValue +fun <K, V> ObservableMap<K, V>.getObservableValue(key: K): ObservableValue<V?> +

val nameToPerson: ObservableMap<String, Person> = (..) +val john: ObservableValue<Person?> = nameToPerson.getObservableValue("John")

+
+getObservableValues +fun <K, V> ObservableMap<K, V>.getObservableValues(): ObservableList<V> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+

Inheritors

+ + + + + + + + + + + +
+AssociatedList +class AssociatedList<K, out A, B> : ReadOnlyBackedObservableMapBase<K, B, Unit> +

AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

+
+LeftOuterJoinedMap +class LeftOuterJoinedMap<K : Any, A, B, C> : ReadOnlyBackedObservableMapBase<K, C, SimpleObjectProperty<B?>> +

LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/is-empty.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/is-empty.html new file mode 100644 index 0000000000..d0c2441873 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/is-empty.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.isEmpty - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / isEmpty
+
+

isEmpty

+ +open fun isEmpty(): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/keys.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/keys.html new file mode 100644 index 0000000000..5be21aea25 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/keys.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.keys - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / keys
+
+

keys

+ +open val keys: MutableSet<K> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put-all.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put-all.html new file mode 100644 index 0000000000..8b98d1197e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put-all.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.putAll - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / putAll
+
+

putAll

+ +open fun putAll(from: Map<out K, A>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put.html new file mode 100644 index 0000000000..a2110cd1af --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/put.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.put - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / put
+
+

put

+ +open fun put(key: K, value: A): A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove-listener.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove-listener.html new file mode 100644 index 0000000000..9f3acab983 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove-listener.html @@ -0,0 +1,16 @@ + + + +ReadOnlyBackedObservableMapBase.removeListener - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / removeListener
+
+

removeListener

+ +open fun removeListener(listener: InvalidationListener?): Unit
+ +open fun removeListener(listener: MapChangeListener<in K, in A>?): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove.html new file mode 100644 index 0000000000..62220f2fab --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/remove.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.remove - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / remove
+
+

remove

+ +open fun remove(key: K): A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/size.html new file mode 100644 index 0000000000..4086456736 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/size.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.size - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / size
+
+

size

+ +open val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/values.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/values.html new file mode 100644 index 0000000000..8b68646c09 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-read-only-backed-observable-map-base/values.html @@ -0,0 +1,14 @@ + + + +ReadOnlyBackedObservableMapBase.values - corda + + + +corda / net.corda.client.jfx.utils / ReadOnlyBackedObservableMapBase / values
+
+

values

+ +open val values: MutableCollection<A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/-init-.html new file mode 100644 index 0000000000..24f4c55c2e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/-init-.html @@ -0,0 +1,15 @@ + + + +ReplayedList.<init> - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / <init>
+
+

<init>

+ReplayedList(sourceList: ObservableList<A>) +

This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get-source-index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get-source-index.html new file mode 100644 index 0000000000..71d848f396 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get-source-index.html @@ -0,0 +1,14 @@ + + + +ReplayedList.getSourceIndex - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / getSourceIndex
+
+

getSourceIndex

+ +fun getSourceIndex(index: Int): Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get.html new file mode 100644 index 0000000000..1e2d15e555 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/get.html @@ -0,0 +1,14 @@ + + + +ReplayedList.get - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / get
+
+

get

+ +fun get(index: Int): A + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/index.html new file mode 100644 index 0000000000..9c300f27ca --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/index.html @@ -0,0 +1,228 @@ + + + +ReplayedList - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList
+
+

ReplayedList

+class ReplayedList<A> : TransformationList<A, A> +

This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

+

Constructors

+ + + + + + + +
+<init> +ReplayedList(sourceList: ObservableList<A>) +

This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

+
+

Properties

+ + + + + + + + + + + +
+replayedList +val replayedList: ArrayList<A>
+size +val size: Int
+

Functions

+ + + + + + + + + + + + + + + +
+get +fun get(index: Int): A
+getSourceIndex +fun getSourceIndex(index: Int): Int
+sourceChanged +fun sourceChanged(c: Change<out A>): Unit
+

Extension Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+indexOfOrThrow +fun <T> List<T>.indexOfOrThrow(item: T): Int +

Returns the index of the given item or throws IllegalArgumentException if not found.

+
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+noneOrSingle +fun <T> Iterable<T>.noneOrSingle(predicate: (T) -> Boolean): T? +

Returns the single element matching the given predicate, or null if element was not found, +or throws if more than one element was found.

+fun <T> Iterable<T>.noneOrSingle(): T? +

Returns single element, or null if element was not found, or throws if more than one element was found.

+
+randomOrNull +fun <T> List<T>.randomOrNull(): T? +

Returns a random element in the list, or null if empty

+fun <T> List<T>.randomOrNull(predicate: (T) -> Boolean): T? +

Returns a random element in the list matching the given predicate, or null if none found

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/replayed-list.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/replayed-list.html new file mode 100644 index 0000000000..8da40934b5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/replayed-list.html @@ -0,0 +1,14 @@ + + + +ReplayedList.replayedList - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / replayedList
+
+

replayedList

+ +val replayedList: ArrayList<A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/size.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/size.html new file mode 100644 index 0000000000..37f7342a35 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/size.html @@ -0,0 +1,14 @@ + + + +ReplayedList.size - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / size
+
+

size

+ +val size: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/source-changed.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/source-changed.html new file mode 100644 index 0000000000..5ff04ce0e4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/-replayed-list/source-changed.html @@ -0,0 +1,14 @@ + + + +ReplayedList.sourceChanged - corda + + + +corda / net.corda.client.jfx.utils / ReplayedList / sourceChanged
+
+

sourceChanged

+ +protected fun sourceChanged(c: Change<out A>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/index.html new file mode 100644 index 0000000000..52ce89877e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/index.html @@ -0,0 +1,190 @@ + + + +net.corda.client.jfx.utils - corda + + + +corda / net.corda.client.jfx.utils
+
+

Package net.corda.client.jfx.utils

+

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+AggregatedList +class AggregatedList<A, E : Any, K : Any> : TransformationList<A, E> +

Given an ObservableList<E> and a grouping key K, AggregatedList groups the elements by the key into a fresh +ObservableList<E> for each group and exposes the groups as an observable list of As by calling assemble on each.

+
+AmountBindings +object AmountBindings +

Utility bindings for the Amount type, similar in spirit to Bindings

+
+AssociatedList +class AssociatedList<K, out A, B> : ReadOnlyBackedObservableMapBase<K, B, Unit> +

AssociatedList creates an ObservableMap from an ObservableList by associating each list element with a unique key. +It is not allowed to have several elements map to the same value!

+
+ChosenList +class ChosenList<E> : ObservableListBase<E> +

ChosenList manages an ObservableList that may be changed by the wrapping ObservableValue. Whenever the underlying +ObservableValue changes the exposed list changes to the new value. Changes to the list are simply propagated.

+
+ConcatenatedList +class ConcatenatedList<A> : TransformationList<A, ObservableList<A>> +

ConcatenatedList takes a list of lists and concatenates them. Any change to the underlying lists or the outer list +is propagated as expected.

+
+FlattenedList +class FlattenedList<A> : TransformationList<A, ObservableValue<out A>> +

FlattenedList flattens the passed in list of ObservableValues so that changes in individual updates to the values +are reflected in the exposed list as expected.

+
+LeftOuterJoinedMap +class LeftOuterJoinedMap<K : Any, A, B, C> : ReadOnlyBackedObservableMapBase<K, C, SimpleObjectProperty<B?>> +

LeftOuterJoinedMap implements a special case of a left outer join where we're matching on primary keys of both +tables.

+
+MapValuesList +class MapValuesList<K, A, C> : ObservableList<C> +

MapValuesList takes an ObservableMap and returns its values as an ObservableList. +The order of returned elements is deterministic but unspecified.

+
+MappedList +class MappedList<A, B> : TransformationList<B, A> +

This is a variant of EasyBind.map where the mapped list is backed, therefore the mapping function will only be run +when an element is inserted or updated. +Use this instead of EasyBind.map to trade off memory vs CPU, or if (god forbid) the mapped function is side-effecting.

+
+ReadOnlyBackedObservableMapBase +open class ReadOnlyBackedObservableMapBase<K, A, B> : ObservableMap<K, A> +

ReadOnlyBackedObservableMapBase is a base class implementing all abstract functions required for an ObservableMap +using a backing HashMap that subclasses should modify.

+
+ReplayedList +class ReplayedList<A> : TransformationList<A, A> +

This list type just replays changes propagated from the underlying source list. Used for testing changes and backing a +non-backed observable

+
+

Extensions for External Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+javafx.beans.value.ObservableValue +
+javafx.collections.ObservableList +
+javafx.collections.ObservableMap +
+kotlin.Function1 +
+kotlin.Function2 +
+kotlin.Function3 +
+kotlin.Function4 +
+kotlin.collections.Collection +
+rx.Observable +
+

Functions

+ + + + + + + +
+lift +fun <A> A.lift(): ObservableValue<A> +

val aliceHeight: ObservableValue = (..) +val bobHeight: ObservableValue = (..) +fun sumHeight(a: Long, b: Long): Long { .. }

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind-out.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind-out.html new file mode 100644 index 0000000000..397732410a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind-out.html @@ -0,0 +1,16 @@ + + + +bindOut - corda + + + +corda / net.corda.client.jfx.utils / javafx.beans.value.ObservableValue / bindOut
+
+

bindOut

+ +fun <A, B> ObservableValue<out A>.bindOut(function: (A) -> ObservableValue<out B>): ObservableValue<out B> +

A variant of bind that has out variance on the output type. This is sometimes useful when kotlin is too eager to +propagate variance constraints and type inference fails.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind.html new file mode 100644 index 0000000000..4820ea480b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/bind.html @@ -0,0 +1,17 @@ + + + +bind - corda + + + +corda / net.corda.client.jfx.utils / javafx.beans.value.ObservableValue / bind
+
+

bind

+ +fun <A, B> ObservableValue<out A>.bind(function: (A) -> ObservableValue<B>): ObservableValue<B> +

data class Person(val height: ObservableValue) +val person: ObservableValue = (..) +val personHeight: ObservableValue = person.bind { it.height }

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/index.html new file mode 100644 index 0000000000..39e7b9a8bb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/index.html @@ -0,0 +1,50 @@ + + + +net.corda.client.jfx.utils.javafx.beans.value.ObservableValue - corda + + + +corda / net.corda.client.jfx.utils / javafx.beans.value.ObservableValue
+
+

Extensions for javafx.beans.value.ObservableValue

+ + + + + + + + + + + + + + + + + + + +
+bind +fun <A, B> ObservableValue<out A>.bind(function: (A) -> ObservableValue<B>): ObservableValue<B> +

data class Person(val height: ObservableValue) +val person: ObservableValue = (..) +val personHeight: ObservableValue = person.bind { it.height }

+
+bindOut +fun <A, B> ObservableValue<out A>.bindOut(function: (A) -> ObservableValue<out B>): ObservableValue<out B> +

A variant of bind that has out variance on the output type. This is sometimes useful when kotlin is too eager to +propagate variance constraints and type inference fails.

+
+isNotNull +fun ObservableValue<*>.isNotNull(): BooleanBinding
+map +fun <A, B> ObservableValue<out A>.map(function: (A) -> B): ObservableValue<B> +

val person: ObservableValue = (..) +val personName: ObservableValue = person.map { it.name }

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/is-not-null.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/is-not-null.html new file mode 100644 index 0000000000..cb0b5aca75 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/is-not-null.html @@ -0,0 +1,14 @@ + + + +isNotNull - corda + + + +corda / net.corda.client.jfx.utils / javafx.beans.value.ObservableValue / isNotNull
+
+

isNotNull

+ +fun ObservableValue<*>.isNotNull(): BooleanBinding + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/map.html new file mode 100644 index 0000000000..1a554c8001 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.beans.value.-observable-value/map.html @@ -0,0 +1,16 @@ + + + +map - corda + + + +corda / net.corda.client.jfx.utils / javafx.beans.value.ObservableValue / map
+
+

map

+ +fun <A, B> ObservableValue<out A>.map(function: (A) -> B): ObservableValue<B> +

val person: ObservableValue = (..) +val personName: ObservableValue = person.map { it.name }

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by-aggregation.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by-aggregation.html new file mode 100644 index 0000000000..2861a5c408 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by-aggregation.html @@ -0,0 +1,22 @@ + + + +associateByAggregation - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / associateByAggregation
+
+

associateByAggregation

+ +

+fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+ +

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by.html new file mode 100644 index 0000000000..0edd6c3dc7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/associate-by.html @@ -0,0 +1,23 @@ + + + +associateBy - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / associateBy
+
+

associateBy

+ +

+fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+ +

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/concatenate.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/concatenate.html new file mode 100644 index 0000000000..e09ffc411e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/concatenate.html @@ -0,0 +1,16 @@ + + + +concatenate - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / concatenate
+
+

concatenate

+ +fun <A> ObservableList<ObservableList<A>>.concatenate(): ObservableList<A> +

val groups: ObservableList<ObservableList> = (..) +val allPeople: ObservableList = groups.concatenate()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter-not-null.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter-not-null.html new file mode 100644 index 0000000000..3a11748cf3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter-not-null.html @@ -0,0 +1,17 @@ + + + +filterNotNull - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / filterNotNull
+
+

filterNotNull

+ +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter.html new file mode 100644 index 0000000000..b2cdec4ad7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/filter.html @@ -0,0 +1,19 @@ + + + +filter - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / filter
+
+

filter

+ +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+

val filteredPeople: ObservableList = people.filter(filterCriterion.map(filterFunction))

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-default.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-default.html new file mode 100644 index 0000000000..62f93476f6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-default.html @@ -0,0 +1,16 @@ + + + +firstOrDefault - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / firstOrDefault
+
+

firstOrDefault

+ +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-null-observable.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-null-observable.html new file mode 100644 index 0000000000..d65679fe70 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first-or-null-observable.html @@ -0,0 +1,16 @@ + + + +firstOrNullObservable - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / firstOrNullObservable
+
+

firstOrNullObservable

+ +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first.html new file mode 100644 index 0000000000..f55b42dd32 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/first.html @@ -0,0 +1,14 @@ + + + +first - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / first
+
+

first

+ +fun <A> ObservableList<A>.first(): ObservableValue<A?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/flatten.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/flatten.html new file mode 100644 index 0000000000..fe655f1704 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/flatten.html @@ -0,0 +1,17 @@ + + + +flatten - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / flatten
+
+

flatten

+ +fun <A> ObservableList<out ObservableValue<out A>>.flatten(): ObservableList<A> +

data class Person(val height: ObservableValue) +val people: ObservableList = (..) +val heights: ObservableList = people.map(Person::height).flatten()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/fold-observable.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/fold-observable.html new file mode 100644 index 0000000000..54ea11acd3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/fold-observable.html @@ -0,0 +1,17 @@ + + + +foldObservable - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / foldObservable
+
+

foldObservable

+ +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/get-value-at.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/get-value-at.html new file mode 100644 index 0000000000..2cc8ab08a4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/get-value-at.html @@ -0,0 +1,14 @@ + + + +getValueAt - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / getValueAt
+
+

getValueAt

+ +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/index.html new file mode 100644 index 0000000000..4149dc8867 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/index.html @@ -0,0 +1,160 @@ + + + +net.corda.client.jfx.utils.javafx.collections.ObservableList - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList
+
+

Extensions for javafx.collections.ObservableList

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+associateBy +fun <K, A, B> ObservableList<out A>.associateBy(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, B> +

data class Person(val height: Long) +val people: ObservableList = (..) +val nameToHeight: ObservableMap<String, Long> = people.associateBy(Person::name) { name, person -> person.height }

+fun <K, A> ObservableList<out A>.associateBy(toKey: (A) -> K): ObservableMap<K, A> +

val people: ObservableList = (..) +val nameToPerson: ObservableMap<String, Person> = people.associateBy(Person::name)

+
+associateByAggregation +fun <K : Any, A : Any, B> ObservableList<out A>.associateByAggregation(toKey: (A) -> K, assemble: (K, A) -> B): ObservableMap<K, ObservableList<B>> +

val people: ObservableList = (..) +val heightToNames: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height) { name, person -> person.name }

+fun <K : Any, A : Any> ObservableList<out A>.associateByAggregation(toKey: (A) -> K): ObservableMap<K, ObservableList<A>> +

val people: ObservableList = (..) +val heightToPeople: ObservableMap<Long, ObservableList> = people.associateByAggregation(Person::height)

+
+concatenate +fun <A> ObservableList<ObservableList<A>>.concatenate(): ObservableList<A> +

val groups: ObservableList<ObservableList> = (..) +val allPeople: ObservableList = groups.concatenate()

+
+filter +fun <A> ObservableList<out A>.filter(predicate: ObservableValue<(A) -> Boolean>): ObservableList<A> +

enum class FilterCriterion { HEIGHT, NAME } +val filterCriterion: ObservableValue = (..) +val people: ObservableList = (..) +fun filterFunction(filterCriterion: FilterCriterion): (Person) -> Boolean { .. }

+
+filterNotNull +fun <A> ObservableList<out A?>.filterNotNull(): ObservableList<A> +

data class Dog(val owner: Person?) +val dogs: ObservableList = (..) +val owners: ObservableList = dogs.map(Dog::owner).filterNotNull()

+
+first +fun <A> ObservableList<A>.first(): ObservableValue<A?>
+firstOrDefault +fun <A> ObservableList<A>.firstOrDefault(default: ObservableValue<A?>, predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return provided default value if the list is empty.

+
+firstOrNullObservable +fun <A> ObservableList<A>.firstOrNullObservable(predicate: (A) -> Boolean): ObservableValue<A?> +

Return first element of the observable list as observable value. +Return ObservableValue(null) if the list is empty.

+
+flatten +fun <A> ObservableList<out ObservableValue<out A>>.flatten(): ObservableList<A> +

data class Person(val height: ObservableValue) +val people: ObservableList = (..) +val heights: ObservableList = people.map(Person::height).flatten()

+
+foldObservable +fun <A, B> ObservableList<out A>.foldObservable(initial: B, folderFunction: (B, A) -> B): ObservableValue<B> +

val people: ObservableList = (..) +val concatenatedNames = people.foldObservable("", { names, person -> names + person.name }) +val concatenatedNames2 = people.map(Person::name).fold("", String::plus)

+
+getValueAt +fun <A> ObservableList<A>.getValueAt(index: Int): ObservableValue<A?>
+last +fun <A> ObservableList<A>.last(): ObservableValue<A?>
+leftOuterJoin +fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+
+map +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+
+unique +fun <T : Any> ObservableList<T>.unique(): ObservableList<T>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/last.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/last.html new file mode 100644 index 0000000000..2b96b8f24e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/last.html @@ -0,0 +1,14 @@ + + + +last - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / last
+
+

last

+ +fun <A> ObservableList<A>.last(): ObservableValue<A?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/left-outer-join.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/left-outer-join.html new file mode 100644 index 0000000000..86c1cc7aec --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/left-outer-join.html @@ -0,0 +1,31 @@ + + + +leftOuterJoin - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / leftOuterJoin
+
+

leftOuterJoin

+ +

+fun <A : Any, B : Any, C, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K, assemble: (A, ObservableList<B>) -> C): ObservableList<C> +

data class Person(val name: String, val managerName: String) +val people: ObservableList = (..) +val managerEmployeeMapping: ObservableList<Pair<Person, ObservableList>> = +people.leftOuterJoin(people, Person::name, Person::managerName) { manager, employees -> Pair(manager, employees) }

+ +

+fun <A : Any, B : Any, K : Any> ObservableList<A>.leftOuterJoin(rightTable: ObservableList<B>, leftToJoinKey: (A) -> K, rightToJoinKey: (B) -> K): ObservableMap<K, Pair<ObservableList<A>, ObservableList<B>>> +

data class Person(name: String, favouriteSpecies: Species) +data class Animal(name: String, species: Species) +val people: ObservableList = (..) +val animals: ObservableList = (..) +val peopleToFavouriteAnimals: ObservableMap<Species, Pair<ObservableList, ObservableList>> = +people.leftOuterJoin(animals, Person::favouriteSpecies, Animal::species)

+

This is the most general left join, given a joining key it returns for each key a pair of relevant elements from the +left and right tables. It is "left outer" in the sense that all members of the left table are guaranteed to be in +the result, but this may not be the case for the right table.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/map.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/map.html new file mode 100644 index 0000000000..e75b1a597c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/map.html @@ -0,0 +1,21 @@ + + + +map - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / map
+
+

map

+ +fun <A, B> ObservableList<out A>.map(cached: Boolean = true, function: (A) -> B): ObservableList<B> +

val dogs: ObservableList = (..) +val dogOwners: ObservableList = dogs.map { it.owner }

+

Parameters

+ +

+cached - If true the results of the mapped function are cached in a backing list. If false each get() will + re-run the function. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/unique.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/unique.html new file mode 100644 index 0000000000..74882018ea --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-list/unique.html @@ -0,0 +1,14 @@ + + + +unique - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableList / unique
+
+

unique

+ +fun <T : Any> ObservableList<T>.unique(): ObservableList<T> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/create-map-change.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/create-map-change.html new file mode 100644 index 0000000000..466e537d0f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/create-map-change.html @@ -0,0 +1,14 @@ + + + +createMapChange - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableMap / createMapChange
+
+

createMapChange

+ +fun <A, K> ObservableMap<K, A>.createMapChange(key: K, removedValue: A?, addedValue: A?): Change<K, A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-entries.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-entries.html new file mode 100644 index 0000000000..198d41e35d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-entries.html @@ -0,0 +1,16 @@ + + + +getObservableEntries - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableMap / getObservableEntries
+
+

getObservableEntries

+ +fun <K, V> ObservableMap<K, V>.getObservableEntries(): ObservableList<Entry<K, V>> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-value.html new file mode 100644 index 0000000000..832a02961b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-value.html @@ -0,0 +1,16 @@ + + + +getObservableValue - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableMap / getObservableValue
+
+

getObservableValue

+ +fun <K, V> ObservableMap<K, V>.getObservableValue(key: K): ObservableValue<V?> +

val nameToPerson: ObservableMap<String, Person> = (..) +val john: ObservableValue<Person?> = nameToPerson.getObservableValue("John")

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-values.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-values.html new file mode 100644 index 0000000000..e983e8a7e6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/get-observable-values.html @@ -0,0 +1,16 @@ + + + +getObservableValues - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableMap / getObservableValues
+
+

getObservableValues

+ +fun <K, V> ObservableMap<K, V>.getObservableValues(): ObservableList<V> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/index.html new file mode 100644 index 0000000000..cef0de9bf3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/javafx.collections.-observable-map/index.html @@ -0,0 +1,49 @@ + + + +net.corda.client.jfx.utils.javafx.collections.ObservableMap - corda + + + +corda / net.corda.client.jfx.utils / javafx.collections.ObservableMap
+
+

Extensions for javafx.collections.ObservableMap

+ + + + + + + + + + + + + + + + + + + +
+createMapChange +fun <A, K> ObservableMap<K, A>.createMapChange(key: K, removedValue: A?, addedValue: A?): Change<K, A>
+getObservableEntries +fun <K, V> ObservableMap<K, V>.getObservableEntries(): ObservableList<Entry<K, V>> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+getObservableValue +fun <K, V> ObservableMap<K, V>.getObservableValue(key: K): ObservableValue<V?> +

val nameToPerson: ObservableMap<String, Person> = (..) +val john: ObservableValue<Person?> = nameToPerson.getObservableValue("John")

+
+getObservableValues +fun <K, V> ObservableMap<K, V>.getObservableValues(): ObservableList<V> +

val nameToPerson: ObservableMap<String, Person> = (..) +val people: ObservableList = nameToPerson.getObservableValues()

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/index.html new file mode 100644 index 0000000000..8081d036b4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/index.html @@ -0,0 +1,22 @@ + + + +net.corda.client.jfx.utils.kotlin.Function1 - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function1
+
+

Extensions for kotlin.Function1

+ + + + + + + +
+lift +fun <A, R> (A) -> R.lift(arg0: ObservableValue<A>): ObservableValue<R>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/lift.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/lift.html new file mode 100644 index 0000000000..e8b5224a17 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function1/lift.html @@ -0,0 +1,14 @@ + + + +lift - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function1 / lift
+
+

lift

+ +fun <A, R> (A) -> R.lift(arg0: ObservableValue<A>): ObservableValue<R> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/index.html new file mode 100644 index 0000000000..fce81f3e4e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/index.html @@ -0,0 +1,22 @@ + + + +net.corda.client.jfx.utils.kotlin.Function2 - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function2
+
+

Extensions for kotlin.Function2

+ + + + + + + +
+lift +fun <A, B, R> (A, B) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>): ObservableValue<R>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/lift.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/lift.html new file mode 100644 index 0000000000..1b94a57f38 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function2/lift.html @@ -0,0 +1,14 @@ + + + +lift - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function2 / lift
+
+

lift

+ +fun <A, B, R> (A, B) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>): ObservableValue<R> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/index.html new file mode 100644 index 0000000000..eff269239e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/index.html @@ -0,0 +1,22 @@ + + + +net.corda.client.jfx.utils.kotlin.Function3 - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function3
+
+

Extensions for kotlin.Function3

+ + + + + + + +
+lift +fun <A, B, C, R> (A, B, C) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>, arg2: ObservableValue<C>): ObservableValue<R>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/lift.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/lift.html new file mode 100644 index 0000000000..01842f7376 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function3/lift.html @@ -0,0 +1,14 @@ + + + +lift - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function3 / lift
+
+

lift

+ +fun <A, B, C, R> (A, B, C) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>, arg2: ObservableValue<C>): ObservableValue<R> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/index.html new file mode 100644 index 0000000000..50cd129437 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/index.html @@ -0,0 +1,22 @@ + + + +net.corda.client.jfx.utils.kotlin.Function4 - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function4
+
+

Extensions for kotlin.Function4

+ + + + + + + +
+lift +fun <A, B, C, D, R> (A, B, C, D) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>, arg2: ObservableValue<C>, arg3: ObservableValue<D>): ObservableValue<R>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/lift.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/lift.html new file mode 100644 index 0000000000..18b802a39c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.-function4/lift.html @@ -0,0 +1,14 @@ + + + +lift - corda + + + +corda / net.corda.client.jfx.utils / kotlin.Function4 / lift
+
+

lift

+ +fun <A, B, C, D, R> (A, B, C, D) -> R.lift(arg0: ObservableValue<A>, arg1: ObservableValue<B>, arg2: ObservableValue<C>, arg3: ObservableValue<D>): ObservableValue<R> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/index.html new file mode 100644 index 0000000000..561d23e90d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/index.html @@ -0,0 +1,26 @@ + + + +net.corda.client.jfx.utils.kotlin.collections.Collection - corda + + + +corda / net.corda.client.jfx.utils / kotlin.collections.Collection
+
+

Extensions for kotlin.collections.Collection

+ + + + + + + +
+sequence +fun <A> Collection<ObservableValue<out A>>.sequence(): ObservableList<A> +

data class Person(val height: ObservableValue) +val people: List = listOf(alice, bob) +val heights: ObservableList = people.map(Person::height).sequence()

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/sequence.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/sequence.html new file mode 100644 index 0000000000..8dc709c943 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/kotlin.collections.-collection/sequence.html @@ -0,0 +1,17 @@ + + + +sequence - corda + + + +corda / net.corda.client.jfx.utils / kotlin.collections.Collection / sequence
+
+

sequence

+ +fun <A> Collection<ObservableValue<out A>>.sequence(): ObservableList<A> +

data class Person(val height: ObservableValue) +val people: List = listOf(alice, bob) +val heights: ObservableList = people.map(Person::height).sequence()

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/lift.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/lift.html new file mode 100644 index 0000000000..b52bc6d72a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/lift.html @@ -0,0 +1,19 @@ + + + +lift - corda + + + +corda / net.corda.client.jfx.utils / lift
+
+

lift

+ +fun <A> A.lift(): ObservableValue<A> +

val aliceHeight: ObservableValue = (..) +val bobHeight: ObservableValue = (..) +fun sumHeight(a: Long, b: Long): Long { .. }

+

val aliceBobSumHeight = ::sumHeight.lift(aliceHeight, bobHeight) +val aliceHeightPlus2 = ::sumHeight.lift(aliceHeight, 2L.lift())

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold-to-observable-value.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold-to-observable-value.html new file mode 100644 index 0000000000..191177e888 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold-to-observable-value.html @@ -0,0 +1,22 @@ + + + +foldToObservableValue - corda + + + +corda / net.corda.client.jfx.utils / rx.Observable / foldToObservableValue
+
+

foldToObservableValue

+ +fun <A, B> Observable<A>.foldToObservableValue(initial: B, folderFun: (A, B) -> B): ObservableValue<B> +

foldToObservableValue takes an rx.Observable stream and creates an ObservableValue out of it.

+

Parameters

+ +

+initial - The initial value of the returned observable. +

+folderFun - The transformation function to be called on the observable value when a new element is emitted on + the stream. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold.html new file mode 100644 index 0000000000..bbb31e0588 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/fold.html @@ -0,0 +1,22 @@ + + + +fold - corda + + + +corda / net.corda.client.jfx.utils / rx.Observable / fold
+
+

fold

+ +fun <T, R> Observable<T>.fold(accumulator: R, folderFun: (R, T) -> Unit): R +

fold takes an rx.Observable stream and applies fold function on it, and collects all elements using the accumulator.

+

Parameters

+ +

+accumulator - The accumulator for accumulating elements. +

+folderFun - The transformation function to be called on the observable list when a new element is emitted on + the stream, which should modify the list as needed. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/index.html new file mode 100644 index 0000000000..c4d97e496e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/index.html @@ -0,0 +1,48 @@ + + + +net.corda.client.jfx.utils.rx.Observable - corda + + + +corda / net.corda.client.jfx.utils / rx.Observable
+
+

Extensions for rx.Observable

+ + + + + + + + + + + + + + + + + + + +
+fold +fun <T, R> Observable<T>.fold(accumulator: R, folderFun: (R, T) -> Unit): R +

fold takes an rx.Observable stream and applies fold function on it, and collects all elements using the accumulator.

+
+foldToObservableValue +fun <A, B> Observable<A>.foldToObservableValue(initial: B, folderFun: (A, B) -> B): ObservableValue<B> +

foldToObservableValue takes an rx.Observable stream and creates an ObservableValue out of it.

+
+recordAsAssociation +fun <A, K> Observable<A>.recordAsAssociation(toKey: (A) -> K, merge: (K, oldValue: A, newValue: A) -> A = { _key, _oldValue, newValue -> newValue }): ObservableMap<K, A> +

This variant simply associates each event with its key.

+
+recordInSequence +fun <A> Observable<A>.recordInSequence(): ObservableList<A> +

recordInSequence records incoming events on the rx.Observable in sequence.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-as-association.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-as-association.html new file mode 100644 index 0000000000..7852efad57 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-as-association.html @@ -0,0 +1,21 @@ + + + +recordAsAssociation - corda + + + +corda / net.corda.client.jfx.utils / rx.Observable / recordAsAssociation
+
+

recordAsAssociation

+ +fun <A, K> Observable<A>.recordAsAssociation(toKey: (A) -> K, merge: (K, oldValue: A, newValue: A) -> A = { _key, _oldValue, newValue -> newValue }): ObservableMap<K, A> +

This variant simply associates each event with its key.

+

Parameters

+ +

+toKey - Function retrieving the key to associate with. +

+merge - The function to be called if there is an existing element at the key. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-in-sequence.html b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-in-sequence.html new file mode 100644 index 0000000000..1e766d191d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.jfx.utils/rx.-observable/record-in-sequence.html @@ -0,0 +1,15 @@ + + + +recordInSequence - corda + + + +corda / net.corda.client.jfx.utils / rx.Observable / recordInSequence
+
+

recordInSequence

+ +fun <A> Observable<A>.recordInSequence(): ObservableList<A> +

recordInSequence records incoming events on the rx.Observable in sequence.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.mock/long.html b/docs/build/html/api/kotlin/corda/net.corda.client.mock/long.html new file mode 100644 index 0000000000..df9699e9a2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.mock/long.html @@ -0,0 +1,14 @@ + + + +net.corda.client.mock.long - corda + + + +corda / net.corda.client.mock / long
+
+

long

+ +fun Generator.Companion.long(): Generator<Long> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-init-.html new file mode 100644 index 0000000000..2087d4a078 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-init-.html @@ -0,0 +1,39 @@ + + + +CordaRPCClientImpl.<init> - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / <init>
+
+

<init>

+CordaRPCClientImpl(session: ClientSession, sessionLock: ReentrantLock, username: String) +

Core RPC engine implementation, to learn how to use RPC you should be looking at CordaRPCClient.

+

Design notes

+

The way RPCs are handled is fairly standard except for the handling of observables. When an RPC might return +an Observable it is specially tagged. This causes the client to create a new transient queue for the +receiving of observables and their observations with a random ID in the name. This ID is sent to the server in +a message header. All observations are sent via this single queue.

+

The reason for doing it this way and not the more obvious approach of one-queue-per-observable is that we want +the queues to be transient, meaning their lifetime in the broker is tied to the session that created them. +A server side observable and its associated queue is not a cost-free thing, let alone the memory and resources +needed to actually generate the observations themselves, therefore we want to ensure these cannot leak. A +transient queue will be deleted automatically if the client session terminates, which by default happens on +disconnect but can also be configured to happen after a short delay (this allows clients to e.g. switch IP +address). On the server the deletion of the observations queue triggers unsubscription from the associated +observables, which in turn may then be garbage collected.

+

Creating a transient queue requires a roundtrip to the broker and thus doing an RPC that could return +observables takes two server roundtrips instead of one. That's why we require RPCs to be marked with +RPCReturnsObservables as needing this special treatment instead of always doing it.

+

If the Artemis/JMS APIs allowed us to create transient queues assigned to someone else then we could +potentially use a different design in which the node creates new transient queues (one per observable) on the +fly. The client would then have to watch out for this and start consuming those queues as they were created.

+

We use one queue per RPC because we don't know ahead of time how many observables the server might return and +often the server doesn't know either, which pushes towards a single queue design, but at the same time the +processing of observations returned by an RPC might be striped across multiple threads and we'd like +backpressure management to not be scoped per client process but with more granularity. So we end up with +a compromise where the unit of backpressure management is the response to a single RPC.

+

TODO: Backpressure isn't propagated all the way through the MQ broker at the moment.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/-init-.html new file mode 100644 index 0000000000..bc54d14ddf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/-init-.html @@ -0,0 +1,13 @@ + + + +CordaRPCClientImpl.ObservableDeserializer.<init> - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / ObservableDeserializer / <init>
+
+

<init>

+ObservableDeserializer() + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/index.html new file mode 100644 index 0000000000..e00bcbef2c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/index.html @@ -0,0 +1,41 @@ + + + +CordaRPCClientImpl.ObservableDeserializer - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / ObservableDeserializer
+
+

ObservableDeserializer

+class ObservableDeserializer : Serializer<Observable<Any>> +

Constructors

+ + + + + + + +
+<init> +ObservableDeserializer()
+

Functions

+ + + + + + + + + + + +
+read +fun read(kryo: Kryo, input: Input, type: Class<Observable<Any>>): Observable<Any>
+write +fun write(kryo: Kryo, output: Output, object: Observable<Any>): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/read.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/read.html new file mode 100644 index 0000000000..b4652a0e9d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/read.html @@ -0,0 +1,14 @@ + + + +CordaRPCClientImpl.ObservableDeserializer.read - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / ObservableDeserializer / read
+
+

read

+ +fun read(kryo: Kryo, input: Input, type: Class<Observable<Any>>): Observable<Any> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/write.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/write.html new file mode 100644 index 0000000000..723b24226f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/-observable-deserializer/write.html @@ -0,0 +1,14 @@ + + + +CordaRPCClientImpl.ObservableDeserializer.write - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / ObservableDeserializer / write
+
+

write

+ +fun write(kryo: Kryo, output: Output, object: Observable<Any>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/index.html new file mode 100644 index 0000000000..2a21bcfd9e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/index.html @@ -0,0 +1,76 @@ + + + +CordaRPCClientImpl - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl
+
+

CordaRPCClientImpl

+class CordaRPCClientImpl +

Core RPC engine implementation, to learn how to use RPC you should be looking at CordaRPCClient.

+

Design notes

+

The way RPCs are handled is fairly standard except for the handling of observables. When an RPC might return +an Observable it is specially tagged. This causes the client to create a new transient queue for the +receiving of observables and their observations with a random ID in the name. This ID is sent to the server in +a message header. All observations are sent via this single queue.

+

The reason for doing it this way and not the more obvious approach of one-queue-per-observable is that we want +the queues to be transient, meaning their lifetime in the broker is tied to the session that created them. +A server side observable and its associated queue is not a cost-free thing, let alone the memory and resources +needed to actually generate the observations themselves, therefore we want to ensure these cannot leak. A +transient queue will be deleted automatically if the client session terminates, which by default happens on +disconnect but can also be configured to happen after a short delay (this allows clients to e.g. switch IP +address). On the server the deletion of the observations queue triggers unsubscription from the associated +observables, which in turn may then be garbage collected.

+

Creating a transient queue requires a roundtrip to the broker and thus doing an RPC that could return +observables takes two server roundtrips instead of one. That's why we require RPCs to be marked with +RPCReturnsObservables as needing this special treatment instead of always doing it.

+

If the Artemis/JMS APIs allowed us to create transient queues assigned to someone else then we could +potentially use a different design in which the node creates new transient queues (one per observable) on the +fly. The client would then have to watch out for this and start consuming those queues as they were created.

+

We use one queue per RPC because we don't know ahead of time how many observables the server might return and +often the server doesn't know either, which pushes towards a single queue design, but at the same time the +processing of observations returned by an RPC might be striped across multiple threads and we'd like +backpressure management to not be scoped per client process but with more granularity. So we end up with +a compromise where the unit of backpressure management is the response to a single RPC.

+

TODO: Backpressure isn't propagated all the way through the MQ broker at the moment.

+

Types

+ + + + + + + +
+ObservableDeserializer +class ObservableDeserializer : Serializer<Observable<Any>>
+

Constructors

+ + + + + + + +
+<init> +CordaRPCClientImpl(session: ClientSession, sessionLock: ReentrantLock, username: String) +

Core RPC engine implementation, to learn how to use RPC you should be looking at CordaRPCClient.

+
+

Functions

+ + + + + + + +
+proxyFor +fun <T : RPCOps> proxyFor(rpcInterface: Class<T>, timeout: Duration? = null, minVersion: Int = 0): T +

Builds a proxy for the given type, which must descend from RPCOps.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/proxy-for.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/proxy-for.html new file mode 100644 index 0000000000..fac1399839 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client-impl/proxy-for.html @@ -0,0 +1,18 @@ + + + +CordaRPCClientImpl.proxyFor - corda + + + +corda / net.corda.client.rpc / CordaRPCClientImpl / proxyFor
+
+

proxyFor

+ +fun <T : RPCOps> proxyFor(rpcInterface: Class<T>, timeout: Duration? = null, minVersion: Int = 0): T +

Builds a proxy for the given type, which must descend from RPCOps.

+

See Also
+

CordaRPCClient.proxy

+

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/-init-.html new file mode 100644 index 0000000000..565f92d09a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/-init-.html @@ -0,0 +1,21 @@ + + + +CordaRPCClient.<init> - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / <init>
+
+

<init>

+CordaRPCClient(host: HostAndPort, config: SSLConfiguration? = null, serviceConfigurationOverride: ServerLocator.() -> Unit = null) +

An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

+

Parameters

+ +

+host - The hostname and messaging port of the node. +

+config - If specified, the SSL configuration to use. If not specified, SSL will be disabled and the node will only be authenticated on non-SSL RPC port, the RPC traffic with not be encrypted when SSL is disabled. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/close.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/close.html new file mode 100644 index 0000000000..764cb1b636 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/close.html @@ -0,0 +1,15 @@ + + + +CordaRPCClient.close - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / close
+
+

close

+ +fun close(): Unit +

Shuts down the client and lets the server know it can free the used resources (in a nice way).

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/config.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/config.html new file mode 100644 index 0000000000..51e6a61f47 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/config.html @@ -0,0 +1,14 @@ + + + +CordaRPCClient.config - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / config
+
+

config

+ +val config: SSLConfiguration? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/host.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/host.html new file mode 100644 index 0000000000..034ed81e39 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/host.html @@ -0,0 +1,14 @@ + + + +CordaRPCClient.host - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / host
+
+

host

+ +val host: HostAndPort + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/index.html new file mode 100644 index 0000000000..d95edac2b5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/index.html @@ -0,0 +1,113 @@ + + + +CordaRPCClient - corda + + + +corda / net.corda.client.rpc / CordaRPCClient
+
+

CordaRPCClient

+@ThreadSafe class CordaRPCClient : Closeable, ArtemisMessagingComponent +

An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

+

Parameters

+ +

+host - The hostname and messaging port of the node. +

+config - If specified, the SSL configuration to use. If not specified, SSL will be disabled and the node will only be authenticated on non-SSL RPC port, the RPC traffic with not be encrypted when SSL is disabled. +

Constructors

+ + + + + + + +
+<init> +CordaRPCClient(host: HostAndPort, config: SSLConfiguration? = null, serviceConfigurationOverride: ServerLocator.() -> Unit = null) +

An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

+
+

Properties

+ + + + + + + + + + + + + + + +
+config +val config: SSLConfiguration?
+host +val host: HostAndPort
+serviceConfigurationOverride +val serviceConfigurationOverride: ServerLocator.() -> Unit
+

Functions

+ + + + + + + + + + + + + + + + + + + +
+close +fun close(): Unit +

Shuts down the client and lets the server know it can free the used resources (in a nice way).

+
+proxy +fun proxy(timeout: Duration? = null, minVersion: Int = 0): CordaRPCOps +

Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.

+
+start +fun start(username: String, password: String): CordaRPCClient +

Opens the connection to the server with the given username and password, then returns itself. +Registers a JVM shutdown hook to cleanly disconnect.

+
+use +fun <T> use(username: String, password: String, block: CordaRPCOps.() -> T): T +

A convenience function that opens a connection with the given credentials, executes the given code block with all +available RPCs in scope and shuts down the RPC connection again. It's meant for quick prototyping and demos. For +more control you probably want to control the lifecycle of the client and proxies independently, as well as +configuring a timeout and other such features via the proxy method.

+
+

Companion Object Properties

+ + + + + + + +
+log +val log: Logger
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/log.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/log.html new file mode 100644 index 0000000000..d8e0dbb4cf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/log.html @@ -0,0 +1,14 @@ + + + +CordaRPCClient.log - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / log
+
+

log

+ +val log: Logger + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/proxy.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/proxy.html new file mode 100644 index 0000000000..741d4c64c8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/proxy.html @@ -0,0 +1,43 @@ + + + +CordaRPCClient.proxy - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / proxy
+
+

proxy

+ +@JvmOverloads fun proxy(timeout: Duration? = null, minVersion: Int = 0): CordaRPCOps +

Returns a fresh proxy that lets you invoke RPCs on the server. Calls on it block, and if the server throws an +exception then it will be rethrown on the client. Proxies are thread safe but only one RPC can be in flight at +once. If you'd like to perform multiple RPCs in parallel, use this function multiple times to get multiple +proxies.

+

Creation of a proxy is a somewhat expensive operation that involves calls to the server, so if you want to do +calls from many threads at once you should cache one proxy per thread and reuse them. This function itself is +thread safe though so requires no extra synchronisation.

+

RPC sends and receives are logged on the net.corda.rpc logger.

+

By default there are no timeouts on calls. This is deliberate, RPCs without timeouts can survive restarts, +maintenance downtime and moves of the server. RPCs can survive temporary losses or changes in client connectivity, +like switching between wifi networks. You can specify a timeout on the level of a proxy. If a call times +out it will throw RPCException.Deadline.

+

The CordaRPCOps defines what client RPCs are available. If an RPC returns an Observable anywhere in the +object graph returned then the server-side observable is transparently linked to a messaging queue, and that +queue linked to another observable on the client side here. You are expected to use it. The server will begin +buffering messages immediately that it will expect you to drain by subscribing to the returned observer. You can +opt-out of this by simply casting the Observable to Closeable or AutoCloseable and then calling the close +method on it. You don't have to explicitly close the observable if you actually subscribe to it: it will close +itself and free up the server-side resources either when the client or JVM itself is shutdown, or when there are +no more subscribers to it. Once all the subscribers to a returned observable are unsubscribed, the observable is +closed and you can't then re-subscribe again: you'll have to re-request a fresh observable with another RPC.

+

The proxy and linked observables consume some small amount of resources on the server. It's OK to just exit your +process and let the server clean up, but in a long running process where you only need something for a short +amount of time it is polite to cast the objects to Closeable or AutoCloseable and close it when you are done. +Finalizers are in place to warn you if you lose a reference to an unclosed proxy or observable.

+

Exceptions

+ +

+RPCException - if the server version is too low or if the server isn't reachable within the given time. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/service-configuration-override.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/service-configuration-override.html new file mode 100644 index 0000000000..331a5bd0e3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/service-configuration-override.html @@ -0,0 +1,14 @@ + + + +CordaRPCClient.serviceConfigurationOverride - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / serviceConfigurationOverride
+
+

serviceConfigurationOverride

+ +val serviceConfigurationOverride: ServerLocator.() -> Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/start.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/start.html new file mode 100644 index 0000000000..ff75c3a060 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/start.html @@ -0,0 +1,16 @@ + + + +CordaRPCClient.start - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / start
+
+

start

+ +fun start(username: String, password: String): CordaRPCClient +

Opens the connection to the server with the given username and password, then returns itself. +Registers a JVM shutdown hook to cleanly disconnect.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/use.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/use.html new file mode 100644 index 0000000000..c1baa0eb3d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/-corda-r-p-c-client/use.html @@ -0,0 +1,19 @@ + + + +CordaRPCClient.use - corda + + + +corda / net.corda.client.rpc / CordaRPCClient / use
+
+

use

+ +fun <T> use(username: String, password: String, block: CordaRPCOps.() -> T): T +

A convenience function that opens a connection with the given credentials, executes the given code block with all +available RPCs in scope and shuts down the RPC connection again. It's meant for quick prototyping and demos. For +more control you probably want to control the lifecycle of the client and proxies independently, as well as +configuring a timeout and other such features via the proxy method.

+

After this method returns the client is closed and can't be restarted.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/create-r-p-c-kryo-for-deserialization.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/create-r-p-c-kryo-for-deserialization.html new file mode 100644 index 0000000000..097c394135 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/create-r-p-c-kryo-for-deserialization.html @@ -0,0 +1,14 @@ + + + +createRPCKryoForDeserialization - corda + + + +corda / net.corda.client.rpc / createRPCKryoForDeserialization
+
+

createRPCKryoForDeserialization

+ +fun createRPCKryoForDeserialization(rpcClient: CordaRPCClientImpl, qName: String? = null, rpcName: String? = null, rpcLocation: Throwable? = null): Kryo + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/index.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/index.html new file mode 100644 index 0000000000..acb3bd3096 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/index.html @@ -0,0 +1,51 @@ + + + +net.corda.client.rpc - corda + + + +corda / net.corda.client.rpc
+
+

Package net.corda.client.rpc

+

Types

+ + + + + + + + + + + +
+CordaRPCClient +class CordaRPCClient : Closeable, ArtemisMessagingComponent +

An RPC client connects to the specified server and allows you to make calls to the server that perform various +useful tasks. See the documentation for proxy or review the docsite to learn more about how this API works.

+
+CordaRPCClientImpl +class CordaRPCClientImpl +

Core RPC engine implementation, to learn how to use RPC you should be looking at CordaRPCClient.

+
+

Functions

+ + + + + + + + + + + +
+createRPCKryoForDeserialization +fun createRPCKryoForDeserialization(rpcClient: CordaRPCClientImpl, qName: String? = null, rpcName: String? = null, rpcLocation: Throwable? = null): Kryo
+releaseRPCKryoForDeserialization +fun releaseRPCKryoForDeserialization(kryo: Kryo): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.client.rpc/release-r-p-c-kryo-for-deserialization.html b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/release-r-p-c-kryo-for-deserialization.html new file mode 100644 index 0000000000..621656a42d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.client.rpc/release-r-p-c-kryo-for-deserialization.html @@ -0,0 +1,14 @@ + + + +releaseRPCKryoForDeserialization - corda + + + +corda / net.corda.client.rpc / releaseRPCKryoForDeserialization
+
+

releaseRPCKryoForDeserialization

+ +fun releaseRPCKryoForDeserialization(kryo: Kryo): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-amount/parse-currency.html b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-amount/parse-currency.html new file mode 100644 index 0000000000..55fbff3010 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-amount/parse-currency.html @@ -0,0 +1,37 @@ + + + +Amount.parseCurrency - corda + + + +corda / net.corda.core.contracts / Amount / parseCurrency
+
+

parseCurrency

+ +fun parseCurrency(input: String): Amount<Currency> +

Returns an amount that is equal to the given currency amount in text. Examples of what is supported:

+
  • 12 USD
    • +
  • 14.50 USD
    • +
  • 10 USD
    • +
  • 30 CHF
    • +
  • $10.24
    • +
  • £13
    • +
  • €5000
    • +
+

Note this method does NOT respect internationalisation rules: it ignores commas and uses . as the +decimal point separator, always. It also ignores the users locale:

+
  • $ is always USD,
    • +
  • £ is always GBP
    • +
  • € is always the Euro
    • +
  • ¥ is always Japanese Yen.
    • +
  • ₽ is always the Russian ruble.
    • +
+

Thus an input of $12 expecting some other countries dollar will not work. Do your own parsing if +you need correct handling of currency amounts with locale-sensitive handling.

+

Exceptions

+ +

+IllegalArgumentException - if the input string was not understood. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-j-p-y.html b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-j-p-y.html new file mode 100644 index 0000000000..8f1b30f550 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-j-p-y.html @@ -0,0 +1,14 @@ + + + +JPY - corda + + + +corda / net.corda.core.contracts / JPY
+
+

JPY

+ +@JvmField val JPY: Currency + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-r-u-b.html b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-r-u-b.html new file mode 100644 index 0000000000..31e88a5b87 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.contracts/-r-u-b.html @@ -0,0 +1,14 @@ + + + +RUB - corda + + + +corda / net.corda.core.contracts / RUB
+
+

RUB

+ +@JvmField val RUB: Currency + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-private-key.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-private-key.html new file mode 100644 index 0000000000..59d40ea20b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-private-key.html @@ -0,0 +1,40 @@ + + + +Crypto.decodePrivateKey - corda + + + +corda / net.corda.core.crypto / Crypto / decodePrivateKey
+
+

decodePrivateKey

+ +

+fun decodePrivateKey(encodedKey: ByteArray): PrivateKey +

Decode a PKCS8 encoded key to its PrivateKey object.

+

Parameters

+ +

+encodedKey - a PKCS8 encoded private key. +

Exceptions

+ +

+IllegalArgumentException - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key. +

+fun decodePrivateKey(encodedKey: ByteArray, schemeCodeName: String): PrivateKey +

Decode a PKCS8 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

+

Parameters

+ +

+encodedKey - a PKCS8 encoded private key. +

+schemeCodeName - a String that should match a key in supportedSignatureSchemes map (e.g. ECDSA_SECP256K1_SHA256). +

Exceptions

+ +

+IllegalArgumentException - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-public-key.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-public-key.html new file mode 100644 index 0000000000..b2bf33905d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/decode-public-key.html @@ -0,0 +1,44 @@ + + + +Crypto.decodePublicKey - corda + + + +corda / net.corda.core.crypto / Crypto / decodePublicKey
+
+

decodePublicKey

+ +

+fun decodePublicKey(encodedKey: ByteArray): PublicKey +

Decode an X509 encoded key to its PublicKey object.

+

Parameters

+ +

+encodedKey - an X509 encoded public key. +

Exceptions

+ +

+UnsupportedSchemeException - on not supported scheme. +

+IllegalArgumentException - on not supported scheme or if the given key specification +is inappropriate for this key factory to produce a private key. +

+fun decodePublicKey(encodedKey: ByteArray, schemeCodeName: String): PublicKey +

Decode an X509 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

+

Parameters

+ +

+encodedKey - an X509 encoded public key. +

+schemeCodeName - a String that should match a key in supportedSignatureSchemes map (e.g. ECDSA_SECP256K1_SHA256). +

Exceptions

+ +

+IllegalArgumentException - if the requested scheme is not supported +

+InvalidKeySpecException - if the given key specification +is inappropriate for this key factory to produce a public key. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-sign.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-sign.html new file mode 100644 index 0000000000..94828ddf72 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-sign.html @@ -0,0 +1,77 @@ + + + +Crypto.doSign - corda + + + +corda / net.corda.core.crypto / Crypto / doSign
+
+

doSign

+ +

+fun doSign(privateKey: PrivateKey, clearData: ByteArray): ByteArray +

Generic way to sign ByteArray data with a PrivateKey. Strategy on on identifying the actual signing scheme is based +on the PrivateKey type, but if the schemeCodeName is known, then better use doSign(signatureScheme: String, privateKey: PrivateKey, clearData: ByteArray).

+

Parameters

+ +

+privateKey - the signer's PrivateKey. +

+clearData - the data/message to be signed in ByteArray form (usually the Merkle root). +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported for this private key. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+the digital signature (in ByteArray) on the input message.

+ +

+fun doSign(schemeCodeName: String, privateKey: PrivateKey, clearData: ByteArray): ByteArray +

Generic way to sign ByteArray data with a PrivateKey and a known schemeCodeName String.

+

Parameters

+ +

+schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256). +

+privateKey - the signer's PrivateKey. +

+clearData - the data/message to be signed in ByteArray form (usually the Merkle root). +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+the digital signature (in ByteArray) on the input message.

+ +

+fun doSign(privateKey: PrivateKey, metaData: MetaData): TransactionSignature +

Generic way to sign MetaData objects with a PrivateKey. +MetaData is a wrapper over the transaction's Merkle root in order to attach extra information, such as a timestamp or partial and blind signature indicators.

+

Parameters

+ +

+privateKey - the signer's PrivateKey. +

+metaData - a MetaData object that adds extra information to a transaction. +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported for this private key or +if metaData.schemeCodeName is not aligned with key type. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+a TransactionSignature object than contains the output of a successful signing and the metaData.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-verify.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-verify.html new file mode 100644 index 0000000000..d37ed12c66 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/do-verify.html @@ -0,0 +1,87 @@ + + + +Crypto.doVerify - corda + + + +corda / net.corda.core.crypto / Crypto / doVerify
+
+

doVerify

+ +

+fun doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray): Boolean +

Utility to simplify the act of verifying a digital signature. +It returns true if it succeeds, but it always throws an exception if verification fails.

+

Parameters

+ +

+publicKey - the signer's PublicKey. +

+signatureData - the signatureData on a message. +

+clearData - the clear data/message that was signed (usually the Merkle root). +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible. +

+IllegalArgumentException - if the signature scheme is not supported or if any of the clear or signature data is empty. +

Return
+true if verification passes or throws an exception if verification fails.

+ +

+fun doVerify(publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray): Boolean +

Utility to simplify the act of verifying a digital signature by identifying the signature scheme used from the input public key's type. +It returns true if it succeeds, but it always throws an exception if verification fails. +Strategy on identifying the actual signing scheme is based on the PublicKey type, but if the schemeCodeName is known, +then better use doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray).

+

Parameters

+ +

+publicKey - the signer's PublicKey. +

+signatureData - the signatureData on a message. +

+clearData - the clear data/message that was signed (usually the Merkle root). +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible. +

+IllegalArgumentException - if the signature scheme is not supported or if any of the clear or signature data is empty. +

Return
+true if verification passes or throws an exception if verification fails.

+ +

+fun doVerify(publicKey: PublicKey, transactionSignature: TransactionSignature): Boolean +

Utility to simplify the act of verifying a TransactionSignature. +It returns true if it succeeds, but it always throws an exception if verification fails.

+

Parameters

+ +

+publicKey - the signer's PublicKey. +

+transactionSignature - the signatureData on a message. +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData scheme is unable to process the input data provided, if the verification is not possible. +

+IllegalArgumentException - if the signature scheme is not supported or if any of the clear or signature data is empty. +

Return
+true if verification passes or throws an exception if verification fails.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/find-signature-scheme-code-name.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/find-signature-scheme-code-name.html new file mode 100644 index 0000000000..47ee4cadbc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/find-signature-scheme-code-name.html @@ -0,0 +1,26 @@ + + + +Crypto.findSignatureSchemeCodeName - corda + + + +corda / net.corda.core.crypto / Crypto / findSignatureSchemeCodeName
+
+

findSignatureSchemeCodeName

+ +fun findSignatureSchemeCodeName(key: Key): String +

Retrieve the corresponding signature scheme code name based on the type of the input Key. +See Crypto for the supported scheme code names.

+

Parameters

+ +

+key - either private or public. +

Exceptions

+ +

+IllegalArgumentException - if the requested key type is not supported. +

Return
+signatureSchemeCodeName for a Key.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/generate-key-pair.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/generate-key-pair.html new file mode 100644 index 0000000000..0b8db377ad --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/generate-key-pair.html @@ -0,0 +1,33 @@ + + + +Crypto.generateKeyPair - corda + + + +corda / net.corda.core.crypto / Crypto / generateKeyPair
+
+

generateKeyPair

+ +

+fun generateKeyPair(schemeCodeName: String): KeyPair +

Utility to simplify the act of generating keys. +Normally, we don't expect other errors here, assuming that key generation parameters for every supported signature scheme have been unit-tested.

+

Parameters

+ +

+schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256). +

Exceptions

+ +

+IllegalArgumentException - if the requested signature scheme is not supported. +

Return
+a KeyPair for the requested scheme.

+ +

+fun generateKeyPair(): KeyPair +

Generate a KeyPair using the default signature scheme.

+

Return
+a new KeyPair.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/get-default-signature-scheme-code-name.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/get-default-signature-scheme-code-name.html new file mode 100644 index 0000000000..178fd33594 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/get-default-signature-scheme-code-name.html @@ -0,0 +1,16 @@ + + + +Crypto.getDefaultSignatureSchemeCodeName - corda + + + +corda / net.corda.core.crypto / Crypto / getDefaultSignatureSchemeCodeName
+
+

getDefaultSignatureSchemeCodeName

+ +fun getDefaultSignatureSchemeCodeName(): String +

Return
+the default signature scheme's code name.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/index.html new file mode 100644 index 0000000000..a4b42e728d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/index.html @@ -0,0 +1,115 @@ + + + +Crypto - corda + + + +corda / net.corda.core.crypto / Crypto
+
+

Crypto

+object Crypto +

This object controls and provides the available and supported signature schemes for Corda. +Any implemented SignatureScheme should be strictly defined here. +However, only the schemes returned by {@link #listSupportedSignatureSchemes()} are supported. +Note that Corda currently supports the following signature schemes by their code names:

+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+decodePrivateKey +fun decodePrivateKey(encodedKey: ByteArray): PrivateKey +

Decode a PKCS8 encoded key to its PrivateKey object.

+fun decodePrivateKey(encodedKey: ByteArray, schemeCodeName: String): PrivateKey +

Decode a PKCS8 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

+
+decodePublicKey +fun decodePublicKey(encodedKey: ByteArray): PublicKey +

Decode an X509 encoded key to its PublicKey object.

+fun decodePublicKey(encodedKey: ByteArray, schemeCodeName: String): PublicKey +

Decode an X509 encoded key to its PrivateKey object based on the input scheme code name. +This will be used by Kryo deserialisation.

+
+doSign +fun doSign(privateKey: PrivateKey, clearData: ByteArray): ByteArray +

Generic way to sign ByteArray data with a PrivateKey. Strategy on on identifying the actual signing scheme is based +on the PrivateKey type, but if the schemeCodeName is known, then better use doSign(signatureScheme: String, privateKey: PrivateKey, clearData: ByteArray).

+fun doSign(schemeCodeName: String, privateKey: PrivateKey, clearData: ByteArray): ByteArray +

Generic way to sign ByteArray data with a PrivateKey and a known schemeCodeName String.

+fun doSign(privateKey: PrivateKey, metaData: MetaData): TransactionSignature +

Generic way to sign MetaData objects with a PrivateKey. +MetaData is a wrapper over the transaction's Merkle root in order to attach extra information, such as a timestamp or partial and blind signature indicators.

+
+doVerify +fun doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray): Boolean +

Utility to simplify the act of verifying a digital signature. +It returns true if it succeeds, but it always throws an exception if verification fails.

+fun doVerify(publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray): Boolean +

Utility to simplify the act of verifying a digital signature by identifying the signature scheme used from the input public key's type. +It returns true if it succeeds, but it always throws an exception if verification fails. +Strategy on identifying the actual signing scheme is based on the PublicKey type, but if the schemeCodeName is known, +then better use doVerify(schemeCodeName: String, publicKey: PublicKey, signatureData: ByteArray, clearData: ByteArray).

+fun doVerify(publicKey: PublicKey, transactionSignature: TransactionSignature): Boolean +

Utility to simplify the act of verifying a TransactionSignature. +It returns true if it succeeds, but it always throws an exception if verification fails.

+
+findSignatureSchemeCodeName +fun findSignatureSchemeCodeName(key: Key): String +

Retrieve the corresponding signature scheme code name based on the type of the input Key. +See Crypto for the supported scheme code names.

+
+generateKeyPair +fun generateKeyPair(schemeCodeName: String): KeyPair +

Utility to simplify the act of generating keys. +Normally, we don't expect other errors here, assuming that key generation parameters for every supported signature scheme have been unit-tested.

+fun generateKeyPair(): KeyPair +

Generate a KeyPair using the default signature scheme.

+
+getDefaultSignatureSchemeCodeName +fun getDefaultSignatureSchemeCodeName(): String
+isSupportedSignatureScheme +fun isSupportedSignatureScheme(schemeCodeName: String): Boolean +

Check if the requested signature scheme is supported by the system.

+
+listSupportedSignatureSchemes +fun listSupportedSignatureSchemes(): List<String>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/is-supported-signature-scheme.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/is-supported-signature-scheme.html new file mode 100644 index 0000000000..493145ddee --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/is-supported-signature-scheme.html @@ -0,0 +1,21 @@ + + + +Crypto.isSupportedSignatureScheme - corda + + + +corda / net.corda.core.crypto / Crypto / isSupportedSignatureScheme
+
+

isSupportedSignatureScheme

+ +fun isSupportedSignatureScheme(schemeCodeName: String): Boolean +

Check if the requested signature scheme is supported by the system.

+

Parameters

+ +

+schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256). +

Return
+true if the signature scheme is supported.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/list-supported-signature-schemes.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/list-supported-signature-schemes.html new file mode 100644 index 0000000000..1b71f6ce58 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-crypto/list-supported-signature-schemes.html @@ -0,0 +1,16 @@ + + + +Crypto.listSupportedSignatureSchemes - corda + + + +corda / net.corda.core.crypto / Crypto / listSupportedSignatureSchemes
+
+

listSupportedSignatureSchemes

+ +fun listSupportedSignatureSchemes(): List<String> +

Return
+a List of Strings with the scheme code names defined in SignatureScheme for all of our supported signature schemes, see Crypto.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/-init-.html new file mode 100644 index 0000000000..6b33db906f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/-init-.html @@ -0,0 +1,13 @@ + + + +EdDSAKeyFactory.<init> - corda + + + +corda / net.corda.core.crypto / EdDSAKeyFactory / <init>
+
+

<init>

+EdDSAKeyFactory() + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/index.html new file mode 100644 index 0000000000..921796592f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-ed-d-s-a-key-factory/index.html @@ -0,0 +1,27 @@ + + + +EdDSAKeyFactory - corda + + + +corda / net.corda.core.crypto / EdDSAKeyFactory
+
+

EdDSAKeyFactory

+class EdDSAKeyFactory : KeyFactory +

Custom KeyFactory for EdDSA with null security Provider. +This is required as a SignatureScheme requires a java.security.KeyFactory property, but i2p has +its own KeyFactory for EdDSA, thus this actually a Proxy Pattern over i2p's KeyFactory.

+

Constructors

+ + + + + + + +
+<init> +EdDSAKeyFactory()
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/-init-.html new file mode 100644 index 0000000000..16752f794e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/-init-.html @@ -0,0 +1,39 @@ + + + +MetaData.<init> - corda + + + +corda / net.corda.core.crypto / MetaData / <init>
+
+

<init>

+MetaData(schemeCodeName: String, versionID: String, signatureType: SignatureType = SignatureType.FULL, timestamp: Instant?, visibleInputs: BitSet?, signedInputs: BitSet?, merkleRoot: ByteArray, publicKey: PublicKey) +

A MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.

+

Parameters

+ +

+schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256). +

+versionID - DLT's version. +

+signatureType - type of the signature, see SignatureType (e.g. FULL, PARTIAL, BLIND, PARTIAL_AND_BLIND). +

+timestamp - the signature's timestamp as provided by the signer. +

+visibleInputs - for partially/fully blind signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the transaction were visible when the signature was calculated. +

+signedInputs - for partial signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the Merkle tree are actually signed. +

+merkleRoot - the Merkle root of the transaction. +

+publicKey - the signer's public key. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/bytes.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/bytes.html new file mode 100644 index 0000000000..a39fc083de --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/bytes.html @@ -0,0 +1,14 @@ + + + +MetaData.bytes - corda + + + +corda / net.corda.core.crypto / MetaData / bytes
+
+

bytes

+ +fun bytes(): ByteArray + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/equals.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/equals.html new file mode 100644 index 0000000000..93fb0aefde --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/equals.html @@ -0,0 +1,14 @@ + + + +MetaData.equals - corda + + + +corda / net.corda.core.crypto / MetaData / equals
+
+

equals

+ +open fun equals(other: Any?): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/hash-code.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/hash-code.html new file mode 100644 index 0000000000..019da55ebc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/hash-code.html @@ -0,0 +1,14 @@ + + + +MetaData.hashCode - corda + + + +corda / net.corda.core.crypto / MetaData / hashCode
+
+

hashCode

+ +open fun hashCode(): Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/index.html new file mode 100644 index 0000000000..0989d8daaf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/index.html @@ -0,0 +1,133 @@ + + + +MetaData - corda + + + +corda / net.corda.core.crypto / MetaData
+
+

MetaData

+open class MetaData +

A MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.

+

Parameters

+ +

+schemeCodeName - a signature scheme's code name (e.g. ECDSA_SECP256K1_SHA256). +

+versionID - DLT's version. +

+signatureType - type of the signature, see SignatureType (e.g. FULL, PARTIAL, BLIND, PARTIAL_AND_BLIND). +

+timestamp - the signature's timestamp as provided by the signer. +

+visibleInputs - for partially/fully blind signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the transaction were visible when the signature was calculated. +

+signedInputs - for partial signatures. We use Merkle tree boolean index flags (from left to right) +indicating what parts of the Merkle tree are actually signed. +

+merkleRoot - the Merkle root of the transaction. +

+publicKey - the signer's public key. +

Constructors

+ + + + + + + +
+<init> +MetaData(schemeCodeName: String, versionID: String, signatureType: SignatureType = SignatureType.FULL, timestamp: Instant?, visibleInputs: BitSet?, signedInputs: BitSet?, merkleRoot: ByteArray, publicKey: PublicKey) +

A MetaData object adds extra information to a transaction. MetaData is used to support a universal +digital signature model enabling full, partial, fully or partially blind and metaData attached signatures, +(such as an attached timestamp). A MetaData object contains both the merkle root of the transaction and the signer's public key. +When signatureType is set to FULL, then visibleInputs and signedInputs can be ignored. +Note: We could omit signatureType as it can always be defined by combining visibleInputs and signedInputs, +but it helps to speed up the process when FULL is used, and thus we can bypass the extra check on boolean arrays.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+merkleRoot +val merkleRoot: ByteArray
+publicKey +val publicKey: PublicKey
+schemeCodeName +val schemeCodeName: String
+signatureType +val signatureType: SignatureType
+signedInputs +val signedInputs: BitSet?
+timestamp +val timestamp: Instant?
+versionID +val versionID: String
+visibleInputs +val visibleInputs: BitSet?
+

Functions

+ + + + + + + + + + + + + + + +
+bytes +fun bytes(): ByteArray
+equals +open fun equals(other: Any?): Boolean
+hashCode +open fun hashCode(): Int
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/merkle-root.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/merkle-root.html new file mode 100644 index 0000000000..45b43d6fd2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/merkle-root.html @@ -0,0 +1,14 @@ + + + +MetaData.merkleRoot - corda + + + +corda / net.corda.core.crypto / MetaData / merkleRoot
+
+

merkleRoot

+ +val merkleRoot: ByteArray + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/public-key.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/public-key.html new file mode 100644 index 0000000000..6e9b1eb0b6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/public-key.html @@ -0,0 +1,14 @@ + + + +MetaData.publicKey - corda + + + +corda / net.corda.core.crypto / MetaData / publicKey
+
+

publicKey

+ +val publicKey: PublicKey + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/scheme-code-name.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/scheme-code-name.html new file mode 100644 index 0000000000..fabfa3642b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/scheme-code-name.html @@ -0,0 +1,14 @@ + + + +MetaData.schemeCodeName - corda + + + +corda / net.corda.core.crypto / MetaData / schemeCodeName
+
+

schemeCodeName

+ +val schemeCodeName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signature-type.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signature-type.html new file mode 100644 index 0000000000..78ddce413a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signature-type.html @@ -0,0 +1,14 @@ + + + +MetaData.signatureType - corda + + + +corda / net.corda.core.crypto / MetaData / signatureType
+
+

signatureType

+ +val signatureType: SignatureType + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signed-inputs.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signed-inputs.html new file mode 100644 index 0000000000..c64c8a0f4c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/signed-inputs.html @@ -0,0 +1,14 @@ + + + +MetaData.signedInputs - corda + + + +corda / net.corda.core.crypto / MetaData / signedInputs
+
+

signedInputs

+ +val signedInputs: BitSet? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/timestamp.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/timestamp.html new file mode 100644 index 0000000000..eccac09aa6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/timestamp.html @@ -0,0 +1,14 @@ + + + +MetaData.timestamp - corda + + + +corda / net.corda.core.crypto / MetaData / timestamp
+
+

timestamp

+ +val timestamp: Instant? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/version-i-d.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/version-i-d.html new file mode 100644 index 0000000000..2c0fe1a35c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/version-i-d.html @@ -0,0 +1,14 @@ + + + +MetaData.versionID - corda + + + +corda / net.corda.core.crypto / MetaData / versionID
+
+

versionID

+ +val versionID: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/visible-inputs.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/visible-inputs.html new file mode 100644 index 0000000000..218c976bf7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-meta-data/visible-inputs.html @@ -0,0 +1,14 @@ + + + +MetaData.visibleInputs - corda + + + +corda / net.corda.core.crypto / MetaData / visibleInputs
+
+

visibleInputs

+ +val visibleInputs: BitSet? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/-init-.html new file mode 100644 index 0000000000..68ed29dca4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/-init-.html @@ -0,0 +1,37 @@ + + + +SignatureScheme.<init> - corda + + + +corda / net.corda.core.crypto / SignatureScheme / <init>
+
+

<init>

+SignatureScheme(schemeNumberID: Int, schemeCodeName: String, algorithmName: String, sig: Signature, keyFactory: KeyFactory, keyPairGenerator: KeyPairGeneratorSpi, algSpec: AlgorithmParameterSpec?, keySize: Int, desc: String) +

This class is used to define a digital signature scheme.

+

Parameters

+ +

+schemeNumberID - we assign a number ID for more efficient on-wire serialisation. Please ensure uniqueness between schemes. +

+schemeCodeName - code name for this signature scheme (e.g. RSA_SHA256, ECDSA_SECP256K1_SHA256, ECDSA_SECP256R1_SHA256, EDDSA_ED25519_SHA512, SPHINCS-256_SHA512). +

+algorithmName - which signature algorithm is used (e.g. RSA, ECDSA. EdDSA, SPHINCS-256). +

+sig - the Signature class that provides the functionality of a digital signature scheme. +eg. Signature.getInstance("SHA256withECDSA", "BC"). +

+keyFactory - the KeyFactory for this scheme (e.g. KeyFactory.getInstance("RSA", "BC")). +

+keyPairGenerator - defines the Service Provider Interface (SPI) for the {@code KeyPairGenerator} class. +e.g. KeyPairGenerator.getInstance("ECDSA", "BC"). +

+algSpec - parameter specs for the underlying algorithm. Note that RSA is defined by the key size rather than algSpec. +eg. ECGenParameterSpec("secp256k1"). +

+keySize - the private key size (currently used for RSA only). +

+desc - a human-readable description for this scheme. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/alg-spec.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/alg-spec.html new file mode 100644 index 0000000000..0c258a6297 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/alg-spec.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.algSpec - corda + + + +corda / net.corda.core.crypto / SignatureScheme / algSpec
+
+

algSpec

+ +val algSpec: AlgorithmParameterSpec? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/algorithm-name.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/algorithm-name.html new file mode 100644 index 0000000000..89635acf75 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/algorithm-name.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.algorithmName - corda + + + +corda / net.corda.core.crypto / SignatureScheme / algorithmName
+
+

algorithmName

+ +val algorithmName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/desc.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/desc.html new file mode 100644 index 0000000000..afb42403fd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/desc.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.desc - corda + + + +corda / net.corda.core.crypto / SignatureScheme / desc
+
+

desc

+ +val desc: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/index.html new file mode 100644 index 0000000000..452357317e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/index.html @@ -0,0 +1,109 @@ + + + +SignatureScheme - corda + + + +corda / net.corda.core.crypto / SignatureScheme
+
+

SignatureScheme

+data class SignatureScheme +

This class is used to define a digital signature scheme.

+

Parameters

+ +

+schemeNumberID - we assign a number ID for more efficient on-wire serialisation. Please ensure uniqueness between schemes. +

+schemeCodeName - code name for this signature scheme (e.g. RSA_SHA256, ECDSA_SECP256K1_SHA256, ECDSA_SECP256R1_SHA256, EDDSA_ED25519_SHA512, SPHINCS-256_SHA512). +

+algorithmName - which signature algorithm is used (e.g. RSA, ECDSA. EdDSA, SPHINCS-256). +

+sig - the Signature class that provides the functionality of a digital signature scheme. +eg. Signature.getInstance("SHA256withECDSA", "BC"). +

+keyFactory - the KeyFactory for this scheme (e.g. KeyFactory.getInstance("RSA", "BC")). +

+keyPairGenerator - defines the Service Provider Interface (SPI) for the {@code KeyPairGenerator} class. +e.g. KeyPairGenerator.getInstance("ECDSA", "BC"). +

+algSpec - parameter specs for the underlying algorithm. Note that RSA is defined by the key size rather than algSpec. +eg. ECGenParameterSpec("secp256k1"). +

+keySize - the private key size (currently used for RSA only). +

+desc - a human-readable description for this scheme. +

Constructors

+ + + + + + + +
+<init> +SignatureScheme(schemeNumberID: Int, schemeCodeName: String, algorithmName: String, sig: Signature, keyFactory: KeyFactory, keyPairGenerator: KeyPairGeneratorSpi, algSpec: AlgorithmParameterSpec?, keySize: Int, desc: String) +

This class is used to define a digital signature scheme.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+algSpec +val algSpec: AlgorithmParameterSpec?
+algorithmName +val algorithmName: String
+desc +val desc: String
+keyFactory +val keyFactory: KeyFactory
+keyPairGenerator +val keyPairGenerator: KeyPairGeneratorSpi
+keySize +val keySize: Int
+schemeCodeName +val schemeCodeName: String
+schemeNumberID +val schemeNumberID: Int
+sig +val sig: Signature
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-factory.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-factory.html new file mode 100644 index 0000000000..a1e2f4b015 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-factory.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.keyFactory - corda + + + +corda / net.corda.core.crypto / SignatureScheme / keyFactory
+
+

keyFactory

+ +val keyFactory: KeyFactory + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-pair-generator.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-pair-generator.html new file mode 100644 index 0000000000..5938449ce3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-pair-generator.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.keyPairGenerator - corda + + + +corda / net.corda.core.crypto / SignatureScheme / keyPairGenerator
+
+

keyPairGenerator

+ +val keyPairGenerator: KeyPairGeneratorSpi + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-size.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-size.html new file mode 100644 index 0000000000..1de9a2a0b8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/key-size.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.keySize - corda + + + +corda / net.corda.core.crypto / SignatureScheme / keySize
+
+

keySize

+ +val keySize: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-code-name.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-code-name.html new file mode 100644 index 0000000000..f8fd0a27f4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-code-name.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.schemeCodeName - corda + + + +corda / net.corda.core.crypto / SignatureScheme / schemeCodeName
+
+

schemeCodeName

+ +val schemeCodeName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-number-i-d.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-number-i-d.html new file mode 100644 index 0000000000..94adaf9eb7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/scheme-number-i-d.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.schemeNumberID - corda + + + +corda / net.corda.core.crypto / SignatureScheme / schemeNumberID
+
+

schemeNumberID

+ +val schemeNumberID: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/sig.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/sig.html new file mode 100644 index 0000000000..fb5f771d25 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-scheme/sig.html @@ -0,0 +1,14 @@ + + + +SignatureScheme.sig - corda + + + +corda / net.corda.core.crypto / SignatureScheme / sig
+
+

sig

+ +val sig: Signature + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-b-l-i-n-d.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-b-l-i-n-d.html new file mode 100644 index 0000000000..15e8046f02 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-b-l-i-n-d.html @@ -0,0 +1,13 @@ + + + +SignatureType.BLIND - corda + + + +corda / net.corda.core.crypto / SignatureType / BLIND
+
+

BLIND

+BLIND + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-f-u-l-l.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-f-u-l-l.html new file mode 100644 index 0000000000..4471d64295 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-f-u-l-l.html @@ -0,0 +1,13 @@ + + + +SignatureType.FULL - corda + + + +corda / net.corda.core.crypto / SignatureType / FULL
+
+

FULL

+FULL + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l.html new file mode 100644 index 0000000000..ad6e3ef29d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l.html @@ -0,0 +1,13 @@ + + + +SignatureType.PARTIAL - corda + + + +corda / net.corda.core.crypto / SignatureType / PARTIAL
+
+

PARTIAL

+PARTIAL + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l_-a-n-d_-b-l-i-n-d.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l_-a-n-d_-b-l-i-n-d.html new file mode 100644 index 0000000000..5e7150bd9b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/-p-a-r-t-i-a-l_-a-n-d_-b-l-i-n-d.html @@ -0,0 +1,13 @@ + + + +SignatureType.PARTIAL_AND_BLIND - corda + + + +corda / net.corda.core.crypto / SignatureType / PARTIAL_AND_BLIND
+
+

PARTIAL_AND_BLIND

+PARTIAL_AND_BLIND + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/index.html new file mode 100644 index 0000000000..d11f028b3e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-signature-type/index.html @@ -0,0 +1,43 @@ + + + +SignatureType - corda + + + +corda / net.corda.core.crypto / SignatureType
+
+

SignatureType

+enum class SignatureType +

Supported Signature types:

+

Enum Values

+ + + + + + + + + + + + + + + + + + + +
+FULL +
+PARTIAL +
+BLIND +
+PARTIAL_AND_BLIND +
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/-init-.html new file mode 100644 index 0000000000..a212e5f7c2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/-init-.html @@ -0,0 +1,15 @@ + + + +TransactionSignature.<init> - corda + + + +corda / net.corda.core.crypto / TransactionSignature / <init>
+
+

<init>

+TransactionSignature(signatureData: ByteArray, metaData: MetaData) +

A wrapper around a digital signature accompanied with metadata, see MetaData.Full and DigitalSignature. +The signature protocol works as follows: s = sign(MetaData.hashBytes).

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/index.html new file mode 100644 index 0000000000..04104cb54d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/index.html @@ -0,0 +1,77 @@ + + + +TransactionSignature - corda + + + +corda / net.corda.core.crypto / TransactionSignature
+
+

TransactionSignature

+open class TransactionSignature : DigitalSignature +

A wrapper around a digital signature accompanied with metadata, see MetaData.Full and DigitalSignature. +The signature protocol works as follows: s = sign(MetaData.hashBytes).

+

Constructors

+ + + + + + + +
+<init> +TransactionSignature(signatureData: ByteArray, metaData: MetaData) +

A wrapper around a digital signature accompanied with metadata, see MetaData.Full and DigitalSignature. +The signature protocol works as follows: s = sign(MetaData.hashBytes).

+
+

Properties

+ + + + + + + + + + + +
+metaData +val metaData: MetaData
+signatureData +val signatureData: ByteArray
+

Functions

+ + + + + + + +
+verify +fun verify(): Boolean +

Function to auto-verify a MetaData object's signature. +Note that MetaData contains both public key and merkle root of the transaction.

+
+

Extension Functions

+ + + + + + + + + + + +
+deserialize +fun <T : Any> OpaqueBytes.deserialize(kryo: KryoPool = p2PKryo()): T
+sha256 +fun OpaqueBytes.sha256(): SHA256
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/meta-data.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/meta-data.html new file mode 100644 index 0000000000..2243f695a8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/meta-data.html @@ -0,0 +1,14 @@ + + + +TransactionSignature.metaData - corda + + + +corda / net.corda.core.crypto / TransactionSignature / metaData
+
+

metaData

+ +val metaData: MetaData + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/signature-data.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/signature-data.html new file mode 100644 index 0000000000..6bfca602fc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/signature-data.html @@ -0,0 +1,14 @@ + + + +TransactionSignature.signatureData - corda + + + +corda / net.corda.core.crypto / TransactionSignature / signatureData
+
+

signatureData

+ +val signatureData: ByteArray + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/verify.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/verify.html new file mode 100644 index 0000000000..556e395905 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/-transaction-signature/verify.html @@ -0,0 +1,26 @@ + + + +TransactionSignature.verify - corda + + + +corda / net.corda.core.crypto / TransactionSignature / verify
+
+

verify

+ +fun verify(): Boolean +

Function to auto-verify a MetaData object's signature. +Note that MetaData contains both public key and merkle root of the transaction.

+

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc. +

+IllegalArgumentException - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/sign.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/sign.html new file mode 100644 index 0000000000..f3d7ad68e1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/sign.html @@ -0,0 +1,29 @@ + + + +sign - corda + + + +corda / net.corda.core.crypto / java.security.KeyPair / sign
+
+

sign

+ +fun KeyPair.sign(clearData: ByteArray): ByteArray +

Helper function to sign with a key pair.

+

Parameters

+ +

+clearData - the data/message to be signed in ByteArray form (usually the Merkle root). +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported for this private key. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+the digital signature (in ByteArray) on the input message.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/verify.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/verify.html new file mode 100644 index 0000000000..4b9f601fd3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-key-pair/verify.html @@ -0,0 +1,31 @@ + + + +verify - corda + + + +corda / net.corda.core.crypto / java.security.KeyPair / verify
+
+

verify

+ +fun KeyPair.verify(signatureData: ByteArray, clearData: ByteArray): Boolean +

Helper function for the signers to verify their own signature.

+

Parameters

+ +

+signature - the signature on a message. +

+clearData - the clear data/message that was signed (usually the Merkle root). +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc. +

+IllegalArgumentException - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-private-key/sign.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-private-key/sign.html new file mode 100644 index 0000000000..b3f51caa5d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-private-key/sign.html @@ -0,0 +1,48 @@ + + + +sign - corda + + + +corda / net.corda.core.crypto / java.security.PrivateKey / sign
+
+

sign

+ +

+fun PrivateKey.sign(clearData: ByteArray): ByteArray +

Helper function for signing.

+

Parameters

+ +

+clearData - the data/message to be signed in ByteArray form (usually the Merkle root). +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported for this private key. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+the digital signature (in ByteArray) on the input message.

+ +

+fun PrivateKey.sign(metaData: MetaData): TransactionSignature +

Helper function for signing.

+

Parameters

+ +

+metaDataFull - tha attached MetaData object. +

Exceptions

+ +

+IllegalArgumentException - if the signature scheme is not supported for this private key. +

+InvalidKeyException - if the private key is invalid. +

+SignatureException - if signing is not possible due to malformed data or private key. +

Return
+a DSWithMetaDataFull object.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-public-key/verify.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-public-key/verify.html new file mode 100644 index 0000000000..c4e72e6816 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/java.security.-public-key/verify.html @@ -0,0 +1,50 @@ + + + +verify - corda + + + +corda / net.corda.core.crypto / java.security.PublicKey / verify
+
+

verify

+ +

+fun PublicKey.verify(signatureData: ByteArray, clearData: ByteArray): Boolean +

Helper function to verify a signature.

+

Parameters

+ +

+signatureData - the signature on a message. +

+clearData - the clear data/message that was signed (usually the Merkle root). +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc. +

+IllegalArgumentException - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty. +

+fun PublicKey.verify(transactionSignature: TransactionSignature): Boolean +

Helper function to verify a metadata attached signature. It is noted that the transactionSignature contains +signatureData and a MetaData object that contains the signer's public key and the transaction's Merkle root.

+

Parameters

+ +

+transactionSignature - a TransactionSignature object that . +

Exceptions

+ +

+InvalidKeyException - if the key is invalid. +

+SignatureException - if this signatureData object is not initialized properly, +the passed-in signatureData is improperly encoded or of the wrong type, +if this signatureData algorithm is unable to process the input data provided, etc. +

+IllegalArgumentException - if the signature scheme is not supported for this private key or if any of the clear or signature data is empty. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.crypto/safe-random-bytes.html b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/safe-random-bytes.html new file mode 100644 index 0000000000..18065593d2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.crypto/safe-random-bytes.html @@ -0,0 +1,27 @@ + + + +safeRandomBytes - corda + + + +corda / net.corda.core.crypto / safeRandomBytes
+
+

safeRandomBytes

+ +fun safeRandomBytes(numOfBytes: Int): ByteArray +

Generate a securely random ByteArray of requested number of bytes. Usually used for seeds, nonces and keys.

+

Parameters

+ +

+numOfBytes - how many random bytes to output. +

Exceptions

+ +

+NoSuchAlgorithmException - thrown if "NativePRNGNonBlocking" is not supported on the JVM +or if no strong SecureRandom implementations are available or if Security.getProperty("securerandom.strongAlgorithms") is null or empty, +which should never happen and suggests an unusual JVM or non-standard Java library. +

Return
+a random ByteArray.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.flows/-flow-logic-ref-factory/flow-whitelist.html b/docs/build/html/api/kotlin/corda/net.corda.core.flows/-flow-logic-ref-factory/flow-whitelist.html new file mode 100644 index 0000000000..d3dbdc89ec --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.flows/-flow-logic-ref-factory/flow-whitelist.html @@ -0,0 +1,14 @@ + + + +FlowLogicRefFactory.flowWhitelist - corda + + + +corda / net.corda.core.flows / FlowLogicRefFactory / flowWhitelist
+
+

flowWhitelist

+ +val flowWhitelist: Map<String, Set<String>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.messaging/-corda-r-p-c-ops/registered-flows.html b/docs/build/html/api/kotlin/corda/net.corda.core.messaging/-corda-r-p-c-ops/registered-flows.html new file mode 100644 index 0000000000..2851dfa6c9 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.messaging/-corda-r-p-c-ops/registered-flows.html @@ -0,0 +1,15 @@ + + + +CordaRPCOps.registeredFlows - corda + + + +corda / net.corda.core.messaging / CordaRPCOps / registeredFlows
+
+

registeredFlows

+ +abstract fun registeredFlows(): List<String> +

Enumerates the class names of the flows that this node knows about.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/automatically-extract-attachments.html b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/automatically-extract-attachments.html new file mode 100644 index 0000000000..f8192b2311 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/automatically-extract-attachments.html @@ -0,0 +1,17 @@ + + + +AttachmentStorage.automaticallyExtractAttachments - corda + + + +corda / net.corda.core.node.services / AttachmentStorage / automaticallyExtractAttachments
+
+

automaticallyExtractAttachments

+ +abstract var automaticallyExtractAttachments: Boolean +

If true, newly inserted attachments will be unzipped to a subdirectory of the storePath. This is intended for +human browsing convenience: the attachment itself will still be the file (that is, edits to the extracted directory +will not have any effect).

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/store-path.html b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/store-path.html new file mode 100644 index 0000000000..d9397e352b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-attachment-storage/store-path.html @@ -0,0 +1,14 @@ + + + +AttachmentStorage.storePath - corda + + + +corda / net.corda.core.node.services / AttachmentStorage / storePath
+
+

storePath

+ +abstract var storePath: Path + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/is-network-map.html b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/is-network-map.html new file mode 100644 index 0000000000..c491457dcd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/is-network-map.html @@ -0,0 +1,14 @@ + + + +ServiceType.isNetworkMap - corda + + + +corda / net.corda.core.node.services / ServiceType / isNetworkMap
+
+

isNetworkMap

+ +fun isNetworkMap(): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/network-map.html b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/network-map.html new file mode 100644 index 0000000000..a551a29c71 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node.services/-service-type/network-map.html @@ -0,0 +1,14 @@ + + + +ServiceType.networkMap - corda + + + +corda / net.corda.core.node.services / ServiceType / networkMap
+
+

networkMap

+ +val networkMap: ServiceType + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-info/version.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-info/version.html new file mode 100644 index 0000000000..3617e3751f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-info/version.html @@ -0,0 +1,14 @@ + + + +NodeInfo.version - corda + + + +corda / net.corda.core.node / NodeInfo / version
+
+

version

+ +val version: Version + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/-init-.html new file mode 100644 index 0000000000..7b95b3c8e1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/-init-.html @@ -0,0 +1,13 @@ + + + +NodeVersionInfo.<init> - corda + + + +corda / net.corda.core.node / NodeVersionInfo / <init>
+
+

<init>

+NodeVersionInfo(version: Version, revision: String, vendor: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/index.html new file mode 100644 index 0000000000..ea041ea228 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/index.html @@ -0,0 +1,47 @@ + + + +NodeVersionInfo - corda + + + +corda / net.corda.core.node / NodeVersionInfo
+
+

NodeVersionInfo

+data class NodeVersionInfo +

Constructors

+ + + + + + + +
+<init> +NodeVersionInfo(version: Version, revision: String, vendor: String)
+

Properties

+ + + + + + + + + + + + + + + +
+revision +val revision: String
+vendor +val vendor: String
+version +val version: Version
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/revision.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/revision.html new file mode 100644 index 0000000000..60a62f7c57 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/revision.html @@ -0,0 +1,14 @@ + + + +NodeVersionInfo.revision - corda + + + +corda / net.corda.core.node / NodeVersionInfo / revision
+
+

revision

+ +val revision: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/vendor.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/vendor.html new file mode 100644 index 0000000000..33febb4ee5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/vendor.html @@ -0,0 +1,14 @@ + + + +NodeVersionInfo.vendor - corda + + + +corda / net.corda.core.node / NodeVersionInfo / vendor
+
+

vendor

+ +val vendor: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/version.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/version.html new file mode 100644 index 0000000000..139e070ba2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-node-version-info/version.html @@ -0,0 +1,14 @@ + + + +NodeVersionInfo.version - corda + + + +corda / net.corda.core.node / NodeVersionInfo / version
+
+

version

+ +val version: Version + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/-init-.html new file mode 100644 index 0000000000..2f4c14ef90 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/-init-.html @@ -0,0 +1,17 @@ + + + +Version.<init> - corda + + + +corda / net.corda.core.node / Version / <init>
+
+

<init>

+Version(major: Int, minor: Int, snapshot: Boolean) +

Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

+

If two Versions are equal (i.e. equals returns true) but they are both snapshot then they may refer to different +builds of the node. NodeVersionInfo.revision would be required to differentiate the two.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/index.html new file mode 100644 index 0000000000..71ad1488a1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/index.html @@ -0,0 +1,76 @@ + + + +Version - corda + + + +corda / net.corda.core.node / Version
+
+

Version

+data class Version +

Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

+

If two Versions are equal (i.e. equals returns true) but they are both snapshot then they may refer to different +builds of the node. NodeVersionInfo.revision would be required to differentiate the two.

+

Constructors

+ + + + + + + +
+<init> +Version(major: Int, minor: Int, snapshot: Boolean) +

Versions of the same major version but with different minor versions are considered compatible with each other. One +exception to this is when the major version is 0 - each different minor version should be considered incompatible.

+
+

Properties

+ + + + + + + + + + + + + + + +
+major +val major: Int
+minor +val minor: Int
+snapshot +val snapshot: Boolean
+

Functions

+ + + + + + + +
+toString +fun toString(): String
+

Companion Object Functions

+ + + + + + + +
+parse +fun parse(string: String): Version
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/major.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/major.html new file mode 100644 index 0000000000..af51cff00c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/major.html @@ -0,0 +1,14 @@ + + + +Version.major - corda + + + +corda / net.corda.core.node / Version / major
+
+

major

+ +val major: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/minor.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/minor.html new file mode 100644 index 0000000000..b179c82184 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/minor.html @@ -0,0 +1,14 @@ + + + +Version.minor - corda + + + +corda / net.corda.core.node / Version / minor
+
+

minor

+ +val minor: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/parse.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/parse.html new file mode 100644 index 0000000000..48c8015591 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/parse.html @@ -0,0 +1,14 @@ + + + +Version.parse - corda + + + +corda / net.corda.core.node / Version / parse
+
+

parse

+ +fun parse(string: String): Version + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/snapshot.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/snapshot.html new file mode 100644 index 0000000000..2370b74f84 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/snapshot.html @@ -0,0 +1,14 @@ + + + +Version.snapshot - corda + + + +corda / net.corda.core.node / Version / snapshot
+
+

snapshot

+ +val snapshot: Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/to-string.html b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/to-string.html new file mode 100644 index 0000000000..5a6ec9359f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.node/-version/to-string.html @@ -0,0 +1,14 @@ + + + +Version.toString - corda + + + +corda / net.corda.core.node / Version / toString
+
+

toString

+ +fun toString(): String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/-init-.html new file mode 100644 index 0000000000..9009ac84c2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/-init-.html @@ -0,0 +1,14 @@ + + + +BlobConverter.<init> - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / <init>
+
+

<init>

+BlobConverter() +

Converts from a ByteArray to a Blob.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-mapped.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-mapped.html new file mode 100644 index 0000000000..688a292d0c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-mapped.html @@ -0,0 +1,14 @@ + + + +BlobConverter.convertToMapped - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / convertToMapped
+
+

convertToMapped

+ +fun convertToMapped(type: Class<out ByteArray>?, value: Blob?): ByteArray? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-persisted.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-persisted.html new file mode 100644 index 0000000000..37a3e18ef1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/convert-to-persisted.html @@ -0,0 +1,14 @@ + + + +BlobConverter.convertToPersisted - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / convertToPersisted
+
+

convertToPersisted

+ +fun convertToPersisted(value: ByteArray?): Blob? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-mapped-type.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-mapped-type.html new file mode 100644 index 0000000000..942da71c22 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-mapped-type.html @@ -0,0 +1,14 @@ + + + +BlobConverter.getMappedType - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / getMappedType
+
+

getMappedType

+ +fun getMappedType(): Class<ByteArray> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-size.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-size.html new file mode 100644 index 0000000000..4ff6050056 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-size.html @@ -0,0 +1,15 @@ + + + +BlobConverter.getPersistedSize - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / getPersistedSize
+
+

getPersistedSize

+ +fun getPersistedSize(): Int? +

creates BLOB(INT.MAX) = 2 GB

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-type.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-type.html new file mode 100644 index 0000000000..b52388baba --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/get-persisted-type.html @@ -0,0 +1,14 @@ + + + +BlobConverter.getPersistedType - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter / getPersistedType
+
+

getPersistedType

+ +fun getPersistedType(): Class<Blob> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/index.html new file mode 100644 index 0000000000..221f217701 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-blob-converter/index.html @@ -0,0 +1,64 @@ + + + +BlobConverter - corda + + + +corda / net.corda.core.schemas.requery.converters / BlobConverter
+
+

BlobConverter

+class BlobConverter : Converter<ByteArray, Blob> +

Converts from a ByteArray to a Blob.

+

Constructors

+ + + + + + + +
+<init> +BlobConverter() +

Converts from a ByteArray to a Blob.

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + +
+convertToMapped +fun convertToMapped(type: Class<out ByteArray>?, value: Blob?): ByteArray?
+convertToPersisted +fun convertToPersisted(value: ByteArray?): Blob?
+getMappedType +fun getMappedType(): Class<ByteArray>
+getPersistedSize +fun getPersistedSize(): Int? +

creates BLOB(INT.MAX) = 2 GB

+
+getPersistedType +fun getPersistedType(): Class<Blob>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/-init-.html new file mode 100644 index 0000000000..4f1950f42e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/-init-.html @@ -0,0 +1,14 @@ + + + +SecureHashConverter.<init> - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / <init>
+
+

<init>

+SecureHashConverter() +

Convert from a SecureHash to a String

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-mapped.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-mapped.html new file mode 100644 index 0000000000..b4661a377b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-mapped.html @@ -0,0 +1,14 @@ + + + +SecureHashConverter.convertToMapped - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / convertToMapped
+
+

convertToMapped

+ +fun convertToMapped(type: Class<out SecureHash>, value: String?): SecureHash? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-persisted.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-persisted.html new file mode 100644 index 0000000000..90b6707db3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/convert-to-persisted.html @@ -0,0 +1,14 @@ + + + +SecureHashConverter.convertToPersisted - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / convertToPersisted
+
+

convertToPersisted

+ +fun convertToPersisted(value: SecureHash?): String? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-mapped-type.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-mapped-type.html new file mode 100644 index 0000000000..d826e69b15 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-mapped-type.html @@ -0,0 +1,14 @@ + + + +SecureHashConverter.getMappedType - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / getMappedType
+
+

getMappedType

+ +fun getMappedType(): Class<SecureHash> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-size.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-size.html new file mode 100644 index 0000000000..43f2096749 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-size.html @@ -0,0 +1,16 @@ + + + +SecureHashConverter.getPersistedSize - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / getPersistedSize
+
+

getPersistedSize

+ +fun getPersistedSize(): Int? +

SecureHash consists of 32 bytes which need VARCHAR(64) in hex +TODO: think about other hash widths

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-type.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-type.html new file mode 100644 index 0000000000..0985be8e90 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/get-persisted-type.html @@ -0,0 +1,14 @@ + + + +SecureHashConverter.getPersistedType - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter / getPersistedType
+
+

getPersistedType

+ +fun getPersistedType(): Class<String> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/index.html new file mode 100644 index 0000000000..6c206b6d77 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.schemas.requery.converters/-secure-hash-converter/index.html @@ -0,0 +1,65 @@ + + + +SecureHashConverter - corda + + + +corda / net.corda.core.schemas.requery.converters / SecureHashConverter
+
+

SecureHashConverter

+class SecureHashConverter : Converter<SecureHash, String> +

Convert from a SecureHash to a String

+

Constructors

+ + + + + + + +
+<init> +SecureHashConverter() +

Convert from a SecureHash to a String

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + +
+convertToMapped +fun convertToMapped(type: Class<out SecureHash>, value: String?): SecureHash?
+convertToPersisted +fun convertToPersisted(value: SecureHash?): String?
+getMappedType +fun getMappedType(): Class<SecureHash>
+getPersistedSize +fun getPersistedSize(): Int? +

SecureHash consists of 32 bytes which need VARCHAR(64) in hex +TODO: think about other hash widths

+
+getPersistedType +fun getPersistedType(): Class<String>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-corda-class-resolver/reset.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-corda-class-resolver/reset.html new file mode 100644 index 0000000000..c25c336b1d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-corda-class-resolver/reset.html @@ -0,0 +1,14 @@ + + + +CordaClassResolver.reset - corda + + + +corda / net.corda.core.serialization / CordaClassResolver / reset
+
+

reset

+ +fun reset(): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/index.html new file mode 100644 index 0000000000..58b88506f0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/index.html @@ -0,0 +1,31 @@ + + + +LoggerSerializer - corda + + + +corda / net.corda.core.serialization / LoggerSerializer
+
+

LoggerSerializer

+@ThreadSafe object LoggerSerializer : Serializer<Logger> +

For serialising a Logger.

+

Functions

+ + + + + + + + + + + +
+read +fun read(kryo: Kryo, input: Input, type: Class<Logger>): Logger
+write +fun write(kryo: Kryo, output: Output, obj: Logger): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/read.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/read.html new file mode 100644 index 0000000000..df48fa4382 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/read.html @@ -0,0 +1,14 @@ + + + +LoggerSerializer.read - corda + + + +corda / net.corda.core.serialization / LoggerSerializer / read
+
+

read

+ +fun read(kryo: Kryo, input: Input, type: Class<Logger>): Logger + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/write.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/write.html new file mode 100644 index 0000000000..eb6658c383 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-logger-serializer/write.html @@ -0,0 +1,14 @@ + + + +LoggerSerializer.write - corda + + + +corda / net.corda.core.serialization / LoggerSerializer / write
+
+

write

+ +fun write(kryo: Kryo, output: Output, obj: Logger): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/index.html new file mode 100644 index 0000000000..8365c8e1ab --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/index.html @@ -0,0 +1,31 @@ + + + +MetaDataSerializer - corda + + + +corda / net.corda.core.serialization / MetaDataSerializer
+
+

MetaDataSerializer

+@ThreadSafe object MetaDataSerializer : Serializer<MetaData> +

For serialising a MetaData object.

+

Functions

+ + + + + + + + + + + +
+read +fun read(kryo: Kryo, input: Input, type: Class<MetaData>): MetaData
+write +fun write(kryo: Kryo, output: Output, obj: MetaData): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/read.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/read.html new file mode 100644 index 0000000000..eebd52c7e7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/read.html @@ -0,0 +1,14 @@ + + + +MetaDataSerializer.read - corda + + + +corda / net.corda.core.serialization / MetaDataSerializer / read
+
+

read

+ +fun read(kryo: Kryo, input: Input, type: Class<MetaData>): MetaData + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/write.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/write.html new file mode 100644 index 0000000000..dde9e2ab71 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/-meta-data-serializer/write.html @@ -0,0 +1,14 @@ + + + +MetaDataSerializer.write - corda + + + +corda / net.corda.core.serialization / MetaDataSerializer / write
+
+

write

+ +fun write(kryo: Kryo, output: Output, obj: MetaData): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/with-attachment-storage.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/with-attachment-storage.html new file mode 100644 index 0000000000..1d6c4f785c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/with-attachment-storage.html @@ -0,0 +1,14 @@ + + + +withAttachmentStorage - corda + + + +corda / net.corda.core.serialization / com.esotericsoftware.kryo.Kryo / withAttachmentStorage
+
+

withAttachmentStorage

+ +fun <T> Kryo.withAttachmentStorage(attachmentStorage: AttachmentStorage?, block: () -> T): T + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/without-references.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/without-references.html new file mode 100644 index 0000000000..de9ec15e22 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/com.esotericsoftware.kryo.-kryo/without-references.html @@ -0,0 +1,14 @@ + + + +withoutReferences - corda + + + +corda / net.corda.core.serialization / com.esotericsoftware.kryo.Kryo / withoutReferences
+
+

withoutReferences

+ +fun <T> Kryo.withoutReferences(block: () -> T): T + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/create-test-kryo.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/create-test-kryo.html new file mode 100644 index 0000000000..ea22ad9cc1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/create-test-kryo.html @@ -0,0 +1,14 @@ + + + +createTestKryo - corda + + + +corda / net.corda.core.serialization / createTestKryo
+
+

createTestKryo

+ +fun createTestKryo(): Kryo + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/p2-p-kryo.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/p2-p-kryo.html new file mode 100644 index 0000000000..6d64b2f21f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/p2-p-kryo.html @@ -0,0 +1,37 @@ + + + +p2PKryo - corda + + + +corda / net.corda.core.serialization / p2PKryo
+
+

p2PKryo

+ +fun p2PKryo(): KryoPool +

Serialization utilities, using the Kryo framework with a custom serialiser for immutable data classes and a dead +simple, totally non-extensible binary (sub)format.

+

This is NOT what should be used in any final platform product, rather, the final state should be a precisely +specified and standardised binary format with attention paid to anti-malleability, versioning and performance. +FIX SBE is a potential candidate: it prioritises performance over convenience and was designed for HFT. Google +Protocol Buffers with a minor tightening to make field reordering illegal is another possibility.

+

FIX SBE: + https://real-logic.github.io/simple-binary-encoding/ + http://mechanical-sympathy.blogspot.co.at/2014/05/simple-binary-encoding.html +Protocol buffers: + https://developers.google.com/protocol-buffers/

+

But for now we use Kryo to maximise prototyping speed.

+

Note that this code ignores ALL concerns beyond convenience, in particular it ignores:

+
  • Performance
    • +
  • Security
    • +
+

This code will happily deserialise literally anything, including malicious streams that would reconstruct classes +in invalid states, thus violating system invariants. It isn't designed to handle malicious streams and therefore, +isn't usable beyond the prototyping stage. But that's fine: we can revisit serialisation technologies later after +a formal evaluation process.

+

We now distinguish between internal, storage related Kryo and external, network facing Kryo. We presently use +some non-whitelisted classes as part of internal storage. +TODO: eliminate internal, storage related whitelist issues, such as private keys in blob storage.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.serialization/storage-kryo.html b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/storage-kryo.html new file mode 100644 index 0000000000..294e75d5f0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.serialization/storage-kryo.html @@ -0,0 +1,14 @@ + + + +storageKryo - corda + + + +corda / net.corda.core.serialization / storageKryo
+
+

storageKryo

+ +fun storageKryo(): KryoPool + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/green-tick.html b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/green-tick.html new file mode 100644 index 0000000000..22dce87583 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/green-tick.html @@ -0,0 +1,14 @@ + + + +Emoji.greenTick - corda + + + +corda / net.corda.core.utilities / Emoji / greenTick
+
+

greenTick

+ +val greenTick: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/no-entry.html b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/no-entry.html new file mode 100644 index 0000000000..5fc60542cd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/no-entry.html @@ -0,0 +1,14 @@ + + + +Emoji.noEntry - corda + + + +corda / net.corda.core.utilities / Emoji / noEntry
+
+

noEntry

+ +val noEntry: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/skull-and-crossbones.html b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/skull-and-crossbones.html new file mode 100644 index 0000000000..cbd77cf7eb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core.utilities/-emoji/skull-and-crossbones.html @@ -0,0 +1,14 @@ + + + +Emoji.skullAndCrossbones - corda + + + +corda / net.corda.core.utilities / Emoji / skullAndCrossbones
+
+

skullAndCrossbones

+ +val skullAndCrossbones: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.core/java.nio.file.-path/read-all-lines.html b/docs/build/html/api/kotlin/corda/net.corda.core/java.nio.file.-path/read-all-lines.html new file mode 100644 index 0000000000..a33873abd7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.core/java.nio.file.-path/read-all-lines.html @@ -0,0 +1,14 @@ + + + +readAllLines - corda + + + +corda / net.corda.core / java.nio.file.Path / readAllLines
+
+

readAllLines

+ +fun Path.readAllLines(charset: Charset = UTF_8): List<String> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-flow-command/-pay-cash/issuer-constraint.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-flow-command/-pay-cash/issuer-constraint.html new file mode 100644 index 0000000000..379e72ea3c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-flow-command/-pay-cash/issuer-constraint.html @@ -0,0 +1,14 @@ + + + +CashFlowCommand.PayCash.issuerConstraint - corda + + + +corda / net.corda.flows / CashFlowCommand / PayCash / issuerConstraint
+
+

issuerConstraint

+ +val issuerConstraint: Party? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-payment-flow/issuer-constraint.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-payment-flow/issuer-constraint.html new file mode 100644 index 0000000000..8c09d6e8d2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-cash-payment-flow/issuer-constraint.html @@ -0,0 +1,14 @@ + + + +CashPaymentFlow.issuerConstraint - corda + + + +corda / net.corda.flows / CashPaymentFlow / issuerConstraint
+
+

issuerConstraint

+ +val issuerConstraint: Set<Party>? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/-init-.html new file mode 100644 index 0000000000..90f2e70a0d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/-init-.html @@ -0,0 +1,15 @@ + + + +TransactionParts.<init> - corda + + + +corda / net.corda.flows / TransactionParts / <init>
+
+

<init>

+TransactionParts(id: SecureHash, inputs: List<StateRef>, timestamp: Timestamp?) +

The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/id.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/id.html new file mode 100644 index 0000000000..f9f1e3c224 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/id.html @@ -0,0 +1,14 @@ + + + +TransactionParts.id - corda + + + +corda / net.corda.flows / TransactionParts / id
+
+

id

+ +val id: SecureHash + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/index.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/index.html new file mode 100644 index 0000000000..a8132cab59 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/index.html @@ -0,0 +1,52 @@ + + + +TransactionParts - corda + + + +corda / net.corda.flows / TransactionParts
+
+

TransactionParts

+data class TransactionParts +

The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

+

Constructors

+ + + + + + + +
+<init> +TransactionParts(id: SecureHash, inputs: List<StateRef>, timestamp: Timestamp?) +

The minimum amount of information needed to notarise a transaction. Note that this does not include +any sensitive transaction details.

+
+

Properties

+ + + + + + + + + + + + + + + +
+id +val id: SecureHash
+inputs +val inputs: List<StateRef>
+timestamp +val timestamp: Timestamp?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/inputs.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/inputs.html new file mode 100644 index 0000000000..83921a0ab2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/inputs.html @@ -0,0 +1,14 @@ + + + +TransactionParts.inputs - corda + + + +corda / net.corda.flows / TransactionParts / inputs
+
+

inputs

+ +val inputs: List<StateRef> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/timestamp.html b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/timestamp.html new file mode 100644 index 0000000000..f6cd50dcb9 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.flows/-transaction-parts/timestamp.html @@ -0,0 +1,14 @@ + + + +TransactionParts.timestamp - corda + + + +corda / net.corda.flows / TransactionParts / timestamp
+
+

timestamp

+ +val timestamp: Timestamp? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/deserialize.html new file mode 100644 index 0000000000..02c756b8e3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.AmountDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / AmountDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): Amount<*> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/index.html new file mode 100644 index 0000000000..5b61d306d4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.AmountDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / AmountDeserializer
+
+

AmountDeserializer

+object AmountDeserializer : JsonDeserializer<Amount<*>> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): Amount<*>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/index.html new file mode 100644 index 0000000000..82e123bc50 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.AmountSerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / AmountSerializer
+
+

AmountSerializer

+object AmountSerializer : JsonSerializer<Amount<*>> +

Functions

+ + + + + + + +
+serialize +fun serialize(value: Amount<*>, gen: JsonGenerator, serializers: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/serialize.html new file mode 100644 index 0000000000..c333ad3bb8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-amount-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.AmountSerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / AmountSerializer / serialize
+
+

serialize

+ +fun serialize(value: Amount<*>, gen: JsonGenerator, serializers: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/deserialize.html new file mode 100644 index 0000000000..73ded6a2e3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.AnonymousPartyDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / AnonymousPartyDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): AnonymousParty + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/index.html new file mode 100644 index 0000000000..a55796e66d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.AnonymousPartyDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / AnonymousPartyDeserializer
+
+

AnonymousPartyDeserializer

+object AnonymousPartyDeserializer : JsonDeserializer<AnonymousParty> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): AnonymousParty
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/index.html new file mode 100644 index 0000000000..71c6978480 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.AnonymousPartySerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / AnonymousPartySerializer
+
+

AnonymousPartySerializer

+object AnonymousPartySerializer : JsonSerializer<AnonymousParty> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: AnonymousParty, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/serialize.html new file mode 100644 index 0000000000..db98f931d1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-anonymous-party-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.AnonymousPartySerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / AnonymousPartySerializer / serialize
+
+

serialize

+ +fun serialize(obj: AnonymousParty, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/deserialize.html new file mode 100644 index 0000000000..055fd3350c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.CalendarDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / CalendarDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): BusinessCalendar + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/index.html new file mode 100644 index 0000000000..45197f5d07 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-calendar-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.CalendarDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / CalendarDeserializer
+
+

CalendarDeserializer

+object CalendarDeserializer : JsonDeserializer<BusinessCalendar> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): BusinessCalendar
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/deserialize.html new file mode 100644 index 0000000000..8ab52ea90d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.CompositeKeyDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / CompositeKeyDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): CompositeKey + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/index.html new file mode 100644 index 0000000000..bead54ad77 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.CompositeKeyDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / CompositeKeyDeserializer
+
+

CompositeKeyDeserializer

+object CompositeKeyDeserializer : JsonDeserializer<CompositeKey> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): CompositeKey
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/index.html new file mode 100644 index 0000000000..11187eace6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.CompositeKeySerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / CompositeKeySerializer
+
+

CompositeKeySerializer

+object CompositeKeySerializer : JsonSerializer<CompositeKey> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: CompositeKey, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/serialize.html new file mode 100644 index 0000000000..2a6996a80f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-composite-key-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.CompositeKeySerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / CompositeKeySerializer / serialize
+
+

serialize

+ +fun serialize(obj: CompositeKey, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/-init-.html new file mode 100644 index 0000000000..861d5fc429 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/-init-.html @@ -0,0 +1,13 @@ + + + +JacksonSupport.IdentityObjectMapper.<init> - corda + + + +corda / net.corda.jackson / JacksonSupport / IdentityObjectMapper / <init>
+
+

<init>

+IdentityObjectMapper(identityService: IdentityService, factory: JsonFactory) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/identity-service.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/identity-service.html new file mode 100644 index 0000000000..a49e767c74 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/identity-service.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.IdentityObjectMapper.identityService - corda + + + +corda / net.corda.jackson / JacksonSupport / IdentityObjectMapper / identityService
+
+

identityService

+ +val identityService: IdentityService + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/index.html new file mode 100644 index 0000000000..5559df7d51 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/index.html @@ -0,0 +1,52 @@ + + + +JacksonSupport.IdentityObjectMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / IdentityObjectMapper
+
+

IdentityObjectMapper

+class IdentityObjectMapper : PartyObjectMapper, ObjectMapper +

Constructors

+ + + + + + + +
+<init> +IdentityObjectMapper(identityService: IdentityService, factory: JsonFactory)
+

Properties

+ + + + + + + +
+identityService +val identityService: IdentityService
+

Functions

+ + + + + + + + + + + +
+partyFromKey +fun partyFromKey(owningKey: CompositeKey): Party?
+partyFromName +fun partyFromName(partyName: String): Party?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-key.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-key.html new file mode 100644 index 0000000000..6d690d6d06 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-key.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.IdentityObjectMapper.partyFromKey - corda + + + +corda / net.corda.jackson / JacksonSupport / IdentityObjectMapper / partyFromKey
+
+

partyFromKey

+ +fun partyFromKey(owningKey: CompositeKey): Party? +

Overrides PartyObjectMapper.partyFromKey

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-name.html new file mode 100644 index 0000000000..1e68c336be --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-identity-object-mapper/party-from-name.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.IdentityObjectMapper.partyFromName - corda + + + +corda / net.corda.jackson / JacksonSupport / IdentityObjectMapper / partyFromName
+
+

partyFromName

+ +fun partyFromName(partyName: String): Party? +

Overrides PartyObjectMapper.partyFromName

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/-init-.html new file mode 100644 index 0000000000..193e786117 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/-init-.html @@ -0,0 +1,13 @@ + + + +JacksonSupport.NoPartyObjectMapper.<init> - corda + + + +corda / net.corda.jackson / JacksonSupport / NoPartyObjectMapper / <init>
+
+

<init>

+NoPartyObjectMapper(factory: JsonFactory) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/index.html new file mode 100644 index 0000000000..6ab051872c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/index.html @@ -0,0 +1,41 @@ + + + +JacksonSupport.NoPartyObjectMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / NoPartyObjectMapper
+
+

NoPartyObjectMapper

+class NoPartyObjectMapper : PartyObjectMapper, ObjectMapper +

Constructors

+ + + + + + + +
+<init> +NoPartyObjectMapper(factory: JsonFactory)
+

Functions

+ + + + + + + + + + + +
+partyFromKey +fun partyFromKey(owningKey: CompositeKey): Party?
+partyFromName +fun partyFromName(partyName: String): Party?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-key.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-key.html new file mode 100644 index 0000000000..f1061d0b9d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-key.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.NoPartyObjectMapper.partyFromKey - corda + + + +corda / net.corda.jackson / JacksonSupport / NoPartyObjectMapper / partyFromKey
+
+

partyFromKey

+ +fun partyFromKey(owningKey: CompositeKey): Party? +

Overrides PartyObjectMapper.partyFromKey

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-name.html new file mode 100644 index 0000000000..a41f54f356 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-no-party-object-mapper/party-from-name.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.NoPartyObjectMapper.partyFromName - corda + + + +corda / net.corda.jackson / JacksonSupport / NoPartyObjectMapper / partyFromName
+
+

partyFromName

+ +fun partyFromName(partyName: String): Party? +

Overrides PartyObjectMapper.partyFromName

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/deserialize.html new file mode 100644 index 0000000000..23945d2c58 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.NodeInfoDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / NodeInfoDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): NodeInfo + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/index.html new file mode 100644 index 0000000000..9e90d53dbc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.NodeInfoDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / NodeInfoDeserializer
+
+

NodeInfoDeserializer

+object NodeInfoDeserializer : JsonDeserializer<NodeInfo> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): NodeInfo
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/index.html new file mode 100644 index 0000000000..5802b01589 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.NodeInfoSerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / NodeInfoSerializer
+
+

NodeInfoSerializer

+object NodeInfoSerializer : JsonSerializer<NodeInfo> +

Functions

+ + + + + + + +
+serialize +fun serialize(value: NodeInfo, gen: JsonGenerator, serializers: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/serialize.html new file mode 100644 index 0000000000..15fe0b4380 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-node-info-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.NodeInfoSerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / NodeInfoSerializer / serialize
+
+

serialize

+ +fun serialize(value: NodeInfo, gen: JsonGenerator, serializers: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/deserialize.html new file mode 100644 index 0000000000..0513060416 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.OpaqueBytesDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / OpaqueBytesDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, ctxt: DeserializationContext): OpaqueBytes + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/index.html new file mode 100644 index 0000000000..f210e36120 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.OpaqueBytesDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / OpaqueBytesDeserializer
+
+

OpaqueBytesDeserializer

+object OpaqueBytesDeserializer : JsonDeserializer<OpaqueBytes> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, ctxt: DeserializationContext): OpaqueBytes
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/index.html new file mode 100644 index 0000000000..45d94309bb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.OpaqueBytesSerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / OpaqueBytesSerializer
+
+

OpaqueBytesSerializer

+object OpaqueBytesSerializer : JsonSerializer<OpaqueBytes> +

Functions

+ + + + + + + +
+serialize +fun serialize(value: OpaqueBytes, gen: JsonGenerator, serializers: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/serialize.html new file mode 100644 index 0000000000..8653d2de42 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-opaque-bytes-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.OpaqueBytesSerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / OpaqueBytesSerializer / serialize
+
+

serialize

+ +fun serialize(value: OpaqueBytes, gen: JsonGenerator, serializers: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/deserialize.html new file mode 100644 index 0000000000..0a90d62af6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PartyDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / PartyDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): Party + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/index.html new file mode 100644 index 0000000000..79da30b960 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.PartyDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / PartyDeserializer
+
+

PartyDeserializer

+object PartyDeserializer : JsonDeserializer<Party> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): Party
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/index.html new file mode 100644 index 0000000000..d1fb4b1572 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/index.html @@ -0,0 +1,53 @@ + + + +JacksonSupport.PartyObjectMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / PartyObjectMapper
+
+

PartyObjectMapper

+interface PartyObjectMapper +

Functions

+ + + + + + + + + + + +
+partyFromKey +abstract fun partyFromKey(owningKey: CompositeKey): Party?
+partyFromName +abstract fun partyFromName(partyName: String): Party?
+

Inheritors

+ + + + + + + + + + + + + + + +
+IdentityObjectMapper +class IdentityObjectMapper : PartyObjectMapper, ObjectMapper
+NoPartyObjectMapper +class NoPartyObjectMapper : PartyObjectMapper, ObjectMapper
+RpcObjectMapper +class RpcObjectMapper : PartyObjectMapper, ObjectMapper
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-key.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-key.html new file mode 100644 index 0000000000..dec438fa43 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-key.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PartyObjectMapper.partyFromKey - corda + + + +corda / net.corda.jackson / JacksonSupport / PartyObjectMapper / partyFromKey
+
+

partyFromKey

+ +abstract fun partyFromKey(owningKey: CompositeKey): Party? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-name.html new file mode 100644 index 0000000000..6746ca87cb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-object-mapper/party-from-name.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PartyObjectMapper.partyFromName - corda + + + +corda / net.corda.jackson / JacksonSupport / PartyObjectMapper / partyFromName
+
+

partyFromName

+ +abstract fun partyFromName(partyName: String): Party? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/index.html new file mode 100644 index 0000000000..1866069afa --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.PartySerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / PartySerializer
+
+

PartySerializer

+object PartySerializer : JsonSerializer<Party> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: Party, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/serialize.html new file mode 100644 index 0000000000..6ebba5d93c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-party-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PartySerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / PartySerializer / serialize
+
+

serialize

+ +fun serialize(obj: Party, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/deserialize.html new file mode 100644 index 0000000000..0c7132124e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PublicKeyDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / PublicKeyDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): EdDSAPublicKey + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/index.html new file mode 100644 index 0000000000..ae4594a6a0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-deserializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.PublicKeyDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / PublicKeyDeserializer
+
+

PublicKeyDeserializer

+object PublicKeyDeserializer : JsonDeserializer<EdDSAPublicKey> +

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): EdDSAPublicKey
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/index.html new file mode 100644 index 0000000000..909f66bcac --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.PublicKeySerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / PublicKeySerializer
+
+

PublicKeySerializer

+object PublicKeySerializer : JsonSerializer<EdDSAPublicKey> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: EdDSAPublicKey, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/serialize.html new file mode 100644 index 0000000000..8f46b11deb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-public-key-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.PublicKeySerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / PublicKeySerializer / serialize
+
+

serialize

+ +fun serialize(obj: EdDSAPublicKey, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/-init-.html new file mode 100644 index 0000000000..84e3c9711b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/-init-.html @@ -0,0 +1,13 @@ + + + +JacksonSupport.RpcObjectMapper.<init> - corda + + + +corda / net.corda.jackson / JacksonSupport / RpcObjectMapper / <init>
+
+

<init>

+RpcObjectMapper(rpc: CordaRPCOps, factory: JsonFactory) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/index.html new file mode 100644 index 0000000000..0404bf65d5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/index.html @@ -0,0 +1,52 @@ + + + +JacksonSupport.RpcObjectMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / RpcObjectMapper
+
+

RpcObjectMapper

+class RpcObjectMapper : PartyObjectMapper, ObjectMapper +

Constructors

+ + + + + + + +
+<init> +RpcObjectMapper(rpc: CordaRPCOps, factory: JsonFactory)
+

Properties

+ + + + + + + +
+rpc +val rpc: CordaRPCOps
+

Functions

+ + + + + + + + + + + +
+partyFromKey +fun partyFromKey(owningKey: CompositeKey): Party?
+partyFromName +fun partyFromName(partyName: String): Party?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-key.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-key.html new file mode 100644 index 0000000000..acafc7e8a0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-key.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.RpcObjectMapper.partyFromKey - corda + + + +corda / net.corda.jackson / JacksonSupport / RpcObjectMapper / partyFromKey
+
+

partyFromKey

+ +fun partyFromKey(owningKey: CompositeKey): Party? +

Overrides PartyObjectMapper.partyFromKey

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-name.html new file mode 100644 index 0000000000..ae22fdcedb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/party-from-name.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.RpcObjectMapper.partyFromName - corda + + + +corda / net.corda.jackson / JacksonSupport / RpcObjectMapper / partyFromName
+
+

partyFromName

+ +fun partyFromName(partyName: String): Party? +

Overrides PartyObjectMapper.partyFromName

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/rpc.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/rpc.html new file mode 100644 index 0000000000..721b8def7e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-rpc-object-mapper/rpc.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.RpcObjectMapper.rpc - corda + + + +corda / net.corda.jackson / JacksonSupport / RpcObjectMapper / rpc
+
+

rpc

+ +val rpc: CordaRPCOps + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/-init-.html new file mode 100644 index 0000000000..35f75b60f8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/-init-.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.SecureHashDeserializer.<init> - corda + + + +corda / net.corda.jackson / JacksonSupport / SecureHashDeserializer / <init>
+
+

<init>

+SecureHashDeserializer() +

Implemented as a class so that we can instantiate for T.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/deserialize.html new file mode 100644 index 0000000000..b13aaf6ce2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.SecureHashDeserializer.deserialize - corda + + + +corda / net.corda.jackson / JacksonSupport / SecureHashDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(parser: JsonParser, context: DeserializationContext): T + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/index.html new file mode 100644 index 0000000000..1357596b16 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-deserializer/index.html @@ -0,0 +1,38 @@ + + + +JacksonSupport.SecureHashDeserializer - corda + + + +corda / net.corda.jackson / JacksonSupport / SecureHashDeserializer
+
+

SecureHashDeserializer

+class SecureHashDeserializer<T : SecureHash> : JsonDeserializer<T> +

Implemented as a class so that we can instantiate for T.

+

Constructors

+ + + + + + + +
+<init> +SecureHashDeserializer() +

Implemented as a class so that we can instantiate for T.

+
+

Functions

+ + + + + + + +
+deserialize +fun deserialize(parser: JsonParser, context: DeserializationContext): T
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/index.html new file mode 100644 index 0000000000..5dcb52802c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.SecureHashSerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / SecureHashSerializer
+
+

SecureHashSerializer

+object SecureHashSerializer : JsonSerializer<SecureHash> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: SecureHash, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/serialize.html new file mode 100644 index 0000000000..8b968d3f3c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-secure-hash-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.SecureHashSerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / SecureHashSerializer / serialize
+
+

serialize

+ +fun serialize(obj: SecureHash, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/index.html new file mode 100644 index 0000000000..f29410b845 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/index.html @@ -0,0 +1,24 @@ + + + +JacksonSupport.ToStringSerializer - corda + + + +corda / net.corda.jackson / JacksonSupport / ToStringSerializer
+
+

ToStringSerializer

+object ToStringSerializer : JsonSerializer<Any> +

Functions

+ + + + + + + +
+serialize +fun serialize(obj: Any, generator: JsonGenerator, provider: SerializerProvider): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/serialize.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/serialize.html new file mode 100644 index 0000000000..a82f2cec5c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/-to-string-serializer/serialize.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.ToStringSerializer.serialize - corda + + + +corda / net.corda.jackson / JacksonSupport / ToStringSerializer / serialize
+
+

serialize

+ +fun serialize(obj: Any, generator: JsonGenerator, provider: SerializerProvider): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/corda-module.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/corda-module.html new file mode 100644 index 0000000000..de36e33feb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/corda-module.html @@ -0,0 +1,14 @@ + + + +JacksonSupport.cordaModule - corda + + + +corda / net.corda.jackson / JacksonSupport / cordaModule
+
+

cordaModule

+ +val cordaModule: Module + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-default-mapper.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-default-mapper.html new file mode 100644 index 0000000000..63a2d0f3ba --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-default-mapper.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.createDefaultMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / createDefaultMapper
+
+

createDefaultMapper

+ +@JvmStatic @JvmOverloads fun createDefaultMapper(rpc: CordaRPCOps, factory: JsonFactory = JsonFactory()): ObjectMapper +

Mapper requiring RPC support to deserialise parties from names

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-in-memory-mapper.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-in-memory-mapper.html new file mode 100644 index 0000000000..50eed070d4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-in-memory-mapper.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.createInMemoryMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / createInMemoryMapper
+
+

createInMemoryMapper

+ +@JvmStatic @JvmOverloads fun createInMemoryMapper(identityService: IdentityService, factory: JsonFactory = JsonFactory()): ObjectMapper +

For testing with an in memory identity service

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-non-rpc-mapper.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-non-rpc-mapper.html new file mode 100644 index 0000000000..472c9fe818 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/create-non-rpc-mapper.html @@ -0,0 +1,15 @@ + + + +JacksonSupport.createNonRpcMapper - corda + + + +corda / net.corda.jackson / JacksonSupport / createNonRpcMapper
+
+

createNonRpcMapper

+ +@JvmStatic @JvmOverloads fun createNonRpcMapper(factory: JsonFactory = JsonFactory()): ObjectMapper +

For testing or situations where deserialising parties is not required

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/index.html new file mode 100644 index 0000000000..4500b46e02 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-jackson-support/index.html @@ -0,0 +1,195 @@ + + + +JacksonSupport - corda + + + +corda / net.corda.jackson / JacksonSupport
+
+

JacksonSupport

+object JacksonSupport +

Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for +the java.time API, some core types, and Kotlin data classes.

+

Note that Jackson can also be used to serialise/deserialise other formats such as Yaml and XML.

+

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+AmountDeserializer +object AmountDeserializer : JsonDeserializer<Amount<*>>
+AmountSerializer +object AmountSerializer : JsonSerializer<Amount<*>>
+AnonymousPartyDeserializer +object AnonymousPartyDeserializer : JsonDeserializer<AnonymousParty>
+AnonymousPartySerializer +object AnonymousPartySerializer : JsonSerializer<AnonymousParty>
+CalendarDeserializer +object CalendarDeserializer : JsonDeserializer<BusinessCalendar>
+CompositeKeyDeserializer +object CompositeKeyDeserializer : JsonDeserializer<CompositeKey>
+CompositeKeySerializer +object CompositeKeySerializer : JsonSerializer<CompositeKey>
+IdentityObjectMapper +class IdentityObjectMapper : PartyObjectMapper, ObjectMapper
+NoPartyObjectMapper +class NoPartyObjectMapper : PartyObjectMapper, ObjectMapper
+NodeInfoDeserializer +object NodeInfoDeserializer : JsonDeserializer<NodeInfo>
+NodeInfoSerializer +object NodeInfoSerializer : JsonSerializer<NodeInfo>
+OpaqueBytesDeserializer +object OpaqueBytesDeserializer : JsonDeserializer<OpaqueBytes>
+OpaqueBytesSerializer +object OpaqueBytesSerializer : JsonSerializer<OpaqueBytes>
+PartyDeserializer +object PartyDeserializer : JsonDeserializer<Party>
+PartyObjectMapper +interface PartyObjectMapper
+PartySerializer +object PartySerializer : JsonSerializer<Party>
+PublicKeyDeserializer +object PublicKeyDeserializer : JsonDeserializer<EdDSAPublicKey>
+PublicKeySerializer +object PublicKeySerializer : JsonSerializer<EdDSAPublicKey>
+RpcObjectMapper +class RpcObjectMapper : PartyObjectMapper, ObjectMapper
+SecureHashDeserializer +class SecureHashDeserializer<T : SecureHash> : JsonDeserializer<T> +

Implemented as a class so that we can instantiate for T.

+
+SecureHashSerializer +object SecureHashSerializer : JsonSerializer<SecureHash>
+ToStringSerializer +object ToStringSerializer : JsonSerializer<Any>
+

Properties

+ + + + + + + +
+cordaModule +val cordaModule: Module
+

Functions

+ + + + + + + + + + + + + + + +
+createDefaultMapper +fun createDefaultMapper(rpc: CordaRPCOps, factory: JsonFactory = JsonFactory()): ObjectMapper +

Mapper requiring RPC support to deserialise parties from names

+
+createInMemoryMapper +fun createInMemoryMapper(identityService: IdentityService, factory: JsonFactory = JsonFactory()): ObjectMapper +

For testing with an in memory identity service

+
+createNonRpcMapper +fun createNonRpcMapper(factory: JsonFactory = JsonFactory()): ObjectMapper +

For testing or situations where deserialising parties is not required

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-init-.html new file mode 100644 index 0000000000..a1f944b6b1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-init-.html @@ -0,0 +1,54 @@ + + + +StringToMethodCallParser.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / <init>
+
+

<init>

+ +

StringToMethodCallParser(targetType: KClass<out T>) +

Same as the regular constructor but takes a Kotlin reflection KClass instead of a Java Class.

+ +

StringToMethodCallParser(targetType: Class<out T>, om: ObjectMapper = JacksonSupport.createNonRpcMapper(YAMLFactory())) +

This class parses strings in a format designed for human usability into ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

+

Syntax

+

The format of the string is as follows. The first word is the name of the method and must always be present. The rest, +which is optional, is wrapped in curly braces and parsed as if it were a Yaml object. The keys of this object are then +mapped to the parameters of the method via the usual Jackson mechanisms. The standard java.lang.Object methods are +excluded.

+

One convenient feature of Yaml is that barewords collapse into strings, thus you can write a call like the following:

+
    fun someCall(note: String, option: Boolean)

+
    someCall note: This is a really helpful feature, option: true
+

... and it will be parsed in the intuitive way. Quotes are only needed if you want to put a comma into the string.

+

There is an online Yaml parser which can be used to explore +the allowed syntax.

+

Usage

+

This class is thread safe. Multiple strings may be parsed in parallel, and the resulting ParsedMethodCall +objects may be reused multiple times and also invoked in parallel, as long as the underling target object is +thread safe itself.

+

You may pass in an alternative ObjectMapper to control what types can be parsed, but it must be configured +with the YAMLFactory for the class to work.

+

Limitations

+
  • The target class must be either a Kotlin class, or a Java class compiled with the -parameters command line +switch, as the class relies on knowing the names of parameters which isn't data provided by default by the +Java compiler.
    • +
  • Vararg methods are not supported, as the type information that'd be required is missing.
    • +
  • Method overloads that have identical parameter names but different types can't be handled, because often +a string could map to multiple types, so which one to use is ambiguous. If you want your interface to be +usable with this utility make sure the parameter and method names don't rely on type overloading.
    • +
+

Examples

+
    fun simple() = ...

+
    "simple"   -> runs the no-args function 'simple'

+
    fun attachmentExists(id: SecureHash): Boolean

+
    "attachmentExists id: b6d7e826e87"  -> parses the given ID as a SecureHash

+
    fun addNote(id: SecureHash, note: String)

+
    "addNote id: b6d7e826e8739ab2eb6e077fc4fba9b04fb880bb4cbd09bc618d30234a8827a4, note: Some note"
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/-init-.html new file mode 100644 index 0000000000..b12fc4f7f1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.ParsedMethodCall.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall / <init>
+
+

<init>

+ParsedMethodCall(target: T?, method: Method, args: Array<Any?>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/args.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/args.html new file mode 100644 index 0000000000..2abb0e6fc5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/args.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.ParsedMethodCall.args - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall / args
+
+

args

+ +val args: Array<Any?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/call.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/call.html new file mode 100644 index 0000000000..be4c84596a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/call.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.ParsedMethodCall.call - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall / call
+
+

call

+ +fun call(): Any? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/index.html new file mode 100644 index 0000000000..3cd13dbc8d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/index.html @@ -0,0 +1,58 @@ + + + +StringToMethodCallParser.ParsedMethodCall - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall
+
+

ParsedMethodCall

+inner class ParsedMethodCall<in T : Any> : Callable<Any?> +

Constructors

+ + + + + + + +
+<init> +ParsedMethodCall(target: T?, method: Method, args: Array<Any?>)
+

Properties

+ + + + + + + + + + + +
+args +val args: Array<Any?>
+method +val method: Method
+

Functions

+ + + + + + + + + + + +
+call +fun call(): Any?
+invoke +operator fun invoke(): Any?
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/invoke.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/invoke.html new file mode 100644 index 0000000000..14cd55a2bb --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/invoke.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.ParsedMethodCall.invoke - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall / invoke
+
+

invoke

+ +operator fun invoke(): Any? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/method.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/method.html new file mode 100644 index 0000000000..3c3f3e135d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-parsed-method-call/method.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.ParsedMethodCall.method - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / ParsedMethodCall / method
+
+

method

+ +val method: Method + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-init-.html new file mode 100644 index 0000000000..aae9625890 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.UnparseableCallException.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / <init>
+
+

<init>

+UnparseableCallException(command: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/-init-.html new file mode 100644 index 0000000000..de53649cb1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.UnparseableCallException.MissingParameter.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / MissingParameter / <init>
+
+

<init>

+MissingParameter(methodName: String, paramName: String, command: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/index.html new file mode 100644 index 0000000000..6428a7fa2e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/index.html @@ -0,0 +1,35 @@ + + + +StringToMethodCallParser.UnparseableCallException.MissingParameter - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / MissingParameter
+
+

MissingParameter

+class MissingParameter : UnparseableCallException +

Constructors

+ + + + + + + +
+<init> +MissingParameter(methodName: String, paramName: String, command: String)
+

Properties

+ + + + + + + +
+paramName +val paramName: String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/param-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/param-name.html new file mode 100644 index 0000000000..47897e3a9c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-missing-parameter/param-name.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.UnparseableCallException.MissingParameter.paramName - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / MissingParameter / paramName
+
+

paramName

+ +val paramName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/-init-.html new file mode 100644 index 0000000000..f77a4f4453 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.UnparseableCallException.ReflectionDataMissing.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / ReflectionDataMissing / <init>
+
+

<init>

+ReflectionDataMissing(methodName: String, argIndex: Int) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/index.html new file mode 100644 index 0000000000..d88a413949 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-reflection-data-missing/index.html @@ -0,0 +1,24 @@ + + + +StringToMethodCallParser.UnparseableCallException.ReflectionDataMissing - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / ReflectionDataMissing
+
+

ReflectionDataMissing

+class ReflectionDataMissing : UnparseableCallException +

Constructors

+ + + + + + + +
+<init> +ReflectionDataMissing(methodName: String, argIndex: Int)
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/-init-.html new file mode 100644 index 0000000000..f1b4113226 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.UnparseableCallException.TooManyParameters.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / TooManyParameters / <init>
+
+

<init>

+TooManyParameters(methodName: String, command: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/index.html new file mode 100644 index 0000000000..fa5168b646 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-too-many-parameters/index.html @@ -0,0 +1,24 @@ + + + +StringToMethodCallParser.UnparseableCallException.TooManyParameters - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / TooManyParameters
+
+

TooManyParameters

+class TooManyParameters : UnparseableCallException +

Constructors

+ + + + + + + +
+<init> +TooManyParameters(methodName: String, command: String)
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/-init-.html new file mode 100644 index 0000000000..30982bc61c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/-init-.html @@ -0,0 +1,13 @@ + + + +StringToMethodCallParser.UnparseableCallException.UnknownMethod.<init> - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / UnknownMethod / <init>
+
+

<init>

+UnknownMethod(methodName: String) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/index.html new file mode 100644 index 0000000000..c343c06b36 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/index.html @@ -0,0 +1,35 @@ + + + +StringToMethodCallParser.UnparseableCallException.UnknownMethod - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / UnknownMethod
+
+

UnknownMethod

+class UnknownMethod : UnparseableCallException +

Constructors

+ + + + + + + +
+<init> +UnknownMethod(methodName: String)
+

Properties

+ + + + + + + +
+methodName +val methodName: String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/method-name.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/method-name.html new file mode 100644 index 0000000000..848f3497ff --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/-unknown-method/method-name.html @@ -0,0 +1,14 @@ + + + +StringToMethodCallParser.UnparseableCallException.UnknownMethod.methodName - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException / UnknownMethod / methodName
+
+

methodName

+ +val methodName: String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/index.html new file mode 100644 index 0000000000..61ae3db462 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/-unparseable-call-exception/index.html @@ -0,0 +1,82 @@ + + + +StringToMethodCallParser.UnparseableCallException - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / UnparseableCallException
+
+

UnparseableCallException

+open class UnparseableCallException : Exception +

Exceptions

+ + + + + + + + + + + + + + + + + + + +
+MissingParameter +class MissingParameter : UnparseableCallException
+ReflectionDataMissing +class ReflectionDataMissing : UnparseableCallException
+TooManyParameters +class TooManyParameters : UnparseableCallException
+UnknownMethod +class UnknownMethod : UnparseableCallException
+

Constructors

+ + + + + + + +
+<init> +UnparseableCallException(command: String)
+

Inheritors

+ + + + + + + + + + + + + + + + + + + +
+MissingParameter +class MissingParameter : UnparseableCallException
+ReflectionDataMissing +class ReflectionDataMissing : UnparseableCallException
+TooManyParameters +class TooManyParameters : UnparseableCallException
+UnknownMethod +class UnknownMethod : UnparseableCallException
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/available-commands.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/available-commands.html new file mode 100644 index 0000000000..1c26adf9ee --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/available-commands.html @@ -0,0 +1,15 @@ + + + +StringToMethodCallParser.availableCommands - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / availableCommands
+
+

availableCommands

+ +val availableCommands: Map<String, String> +

Returns a string-to-string map of commands to a string describing available parameter types.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/index.html new file mode 100644 index 0000000000..65466a388a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/index.html @@ -0,0 +1,157 @@ + + + +StringToMethodCallParser - corda + + + +corda / net.corda.jackson / StringToMethodCallParser
+
+

StringToMethodCallParser

+@ThreadSafe open class StringToMethodCallParser<in T : Any> +

This class parses strings in a format designed for human usability into ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

+

Syntax

+

The format of the string is as follows. The first word is the name of the method and must always be present. The rest, +which is optional, is wrapped in curly braces and parsed as if it were a Yaml object. The keys of this object are then +mapped to the parameters of the method via the usual Jackson mechanisms. The standard java.lang.Object methods are +excluded.

+

One convenient feature of Yaml is that barewords collapse into strings, thus you can write a call like the following:

+
    fun someCall(note: String, option: Boolean)

+
    someCall note: This is a really helpful feature, option: true
+

... and it will be parsed in the intuitive way. Quotes are only needed if you want to put a comma into the string.

+

There is an online Yaml parser which can be used to explore +the allowed syntax.

+

Usage

+

This class is thread safe. Multiple strings may be parsed in parallel, and the resulting ParsedMethodCall +objects may be reused multiple times and also invoked in parallel, as long as the underling target object is +thread safe itself.

+

You may pass in an alternative ObjectMapper to control what types can be parsed, but it must be configured +with the YAMLFactory for the class to work.

+

Limitations

+
  • The target class must be either a Kotlin class, or a Java class compiled with the -parameters command line +switch, as the class relies on knowing the names of parameters which isn't data provided by default by the +Java compiler.
    • +
  • Vararg methods are not supported, as the type information that'd be required is missing.
    • +
  • Method overloads that have identical parameter names but different types can't be handled, because often +a string could map to multiple types, so which one to use is ambiguous. If you want your interface to be +usable with this utility make sure the parameter and method names don't rely on type overloading.
    • +
+

Examples

+
    fun simple() = ...

+
    "simple"   -> runs the no-args function 'simple'

+
    fun attachmentExists(id: SecureHash): Boolean

+
    "attachmentExists id: b6d7e826e87"  -> parses the given ID as a SecureHash

+
    fun addNote(id: SecureHash, note: String)

+
    "addNote id: b6d7e826e8739ab2eb6e077fc4fba9b04fb880bb4cbd09bc618d30234a8827a4, note: Some note"
+

Types

+ + + + + + + +
+ParsedMethodCall +inner class ParsedMethodCall<in T : Any> : Callable<Any?>
+

Exceptions

+ + + + + + + +
+UnparseableCallException +open class UnparseableCallException : Exception
+

Constructors

+ + + + + + + +
+<init> +StringToMethodCallParser(targetType: KClass<out T>) +

Same as the regular constructor but takes a Kotlin reflection KClass instead of a Java Class.

+StringToMethodCallParser(targetType: Class<out T>, om: ObjectMapper = JacksonSupport.createNonRpcMapper(YAMLFactory())) +

This class parses strings in a format designed for human usability into ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

+
+

Properties

+ + + + + + + + + + + + + + + +
+availableCommands +val availableCommands: Map<String, String> +

Returns a string-to-string map of commands to a string describing available parameter types.

+
+methodMap +val methodMap: Multimap<String, Method> +

The methods that can be invoked via this parser.

+
+methodParamNames +val methodParamNames: Map<String, List<String>> +

A map of method name to parameter names for the target type.

+
+

Functions

+ + + + + + + + + + + + + + + + + + + +
+paramNamesFromConstructor +open fun paramNamesFromConstructor(ctor: Constructor<*>): List<String> +

Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a constructor.

+
+paramNamesFromMethod +open fun paramNamesFromMethod(method: Method): List<String> +

Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a method.

+
+parse +fun parse(target: T?, command: String): ParsedMethodCall<T> +

Parses the given command as a call on the target type. The target should be specified, if it's null then +the resulting ParsedMethodCall can't be invoked, just inspected.

+
+parseArguments +fun parseArguments(methodNameHint: String, parameters: List<Pair<String, Class<*>>>, args: String): Array<Any?> +

Parses only the arguments string given the info about parameter names and types.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-map.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-map.html new file mode 100644 index 0000000000..f209580cb5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-map.html @@ -0,0 +1,15 @@ + + + +StringToMethodCallParser.methodMap - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / methodMap
+
+

methodMap

+ +protected val methodMap: Multimap<String, Method> +

The methods that can be invoked via this parser.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-param-names.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-param-names.html new file mode 100644 index 0000000000..c0a537e139 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/method-param-names.html @@ -0,0 +1,15 @@ + + + +StringToMethodCallParser.methodParamNames - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / methodParamNames
+
+

methodParamNames

+ +val methodParamNames: Map<String, List<String>> +

A map of method name to parameter names for the target type.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-constructor.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-constructor.html new file mode 100644 index 0000000000..0ec44d17de --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-constructor.html @@ -0,0 +1,15 @@ + + + +StringToMethodCallParser.paramNamesFromConstructor - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / paramNamesFromConstructor
+
+

paramNamesFromConstructor

+ +open fun paramNamesFromConstructor(ctor: Constructor<*>): List<String> +

Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a constructor.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-method.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-method.html new file mode 100644 index 0000000000..8c2fe32b19 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/param-names-from-method.html @@ -0,0 +1,15 @@ + + + +StringToMethodCallParser.paramNamesFromMethod - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / paramNamesFromMethod
+
+

paramNamesFromMethod

+ +open fun paramNamesFromMethod(method: Method): List<String> +

Uses either Kotlin or Java 8 reflection to learn the names of the parameters to a method.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse-arguments.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse-arguments.html new file mode 100644 index 0000000000..fdc15b613c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse-arguments.html @@ -0,0 +1,19 @@ + + + +StringToMethodCallParser.parseArguments - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / parseArguments
+
+

parseArguments

+ +fun parseArguments(methodNameHint: String, parameters: List<Pair<String, Class<*>>>, args: String): Array<Any?> +

Parses only the arguments string given the info about parameter names and types.

+

Parameters

+ +

+methodNameHint - A name that will be used in exceptions if thrown; not used for any other purpose. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse.html new file mode 100644 index 0000000000..a30ae0a349 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/-string-to-method-call-parser/parse.html @@ -0,0 +1,16 @@ + + + +StringToMethodCallParser.parse - corda + + + +corda / net.corda.jackson / StringToMethodCallParser / parse
+
+

parse

+ +fun parse(target: T?, command: String): ParsedMethodCall<T> +

Parses the given command as a call on the target type. The target should be specified, if it's null then +the resulting ParsedMethodCall can't be invoked, just inspected.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.jackson/index.html b/docs/build/html/api/kotlin/corda/net.corda.jackson/index.html new file mode 100644 index 0000000000..86ee629d13 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.jackson/index.html @@ -0,0 +1,37 @@ + + + +net.corda.jackson - corda + + + +corda / net.corda.jackson
+
+

Package net.corda.jackson

+

Types

+ + + + + + + + + + + +
+JacksonSupport +object JacksonSupport +

Utilities and serialisers for working with JSON representations of basic types. This adds Jackson support for +the java.time API, some core types, and Kotlin data classes.

+
+StringToMethodCallParser +open class StringToMethodCallParser<in T : Any> +

This class parses strings in a format designed for human usability into ParsedMethodCall objects representing a +ready-to-invoke call on the given target object. The strings accepted by this class are a minor variant of +Yaml and can be easily typed at a command line. Intended use cases include +things like the Corda shell, text-based RPC dispatch, simple scripting and so on.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l-exposed-interface/start-network-map-service.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l-exposed-interface/start-network-map-service.html new file mode 100644 index 0000000000..4818376851 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l-exposed-interface/start-network-map-service.html @@ -0,0 +1,16 @@ + + + +DriverDSLExposedInterface.startNetworkMapService - corda + + + +corda / net.corda.node.driver / DriverDSLExposedInterface / startNetworkMapService
+
+

startNetworkMapService

+ +abstract fun startNetworkMapService(): Unit +

Starts a network map service node. Note that only a single one should ever be running, so you will probably want +to set automaticallyStartNetworkMap to false in your driver call.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/-state/processes.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/-state/processes.html new file mode 100644 index 0000000000..76d4ef830e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/-state/processes.html @@ -0,0 +1,14 @@ + + + +DriverDSL.State.processes - corda + + + +corda / net.corda.node.driver / DriverDSL / State / processes
+
+

processes

+ +val processes: ArrayList<ListenableFuture<Process>> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/automatically-start-network-map.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/automatically-start-network-map.html new file mode 100644 index 0000000000..8e32f9ab10 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/automatically-start-network-map.html @@ -0,0 +1,14 @@ + + + +DriverDSL.automaticallyStartNetworkMap - corda + + + +corda / net.corda.node.driver / DriverDSL / automaticallyStartNetworkMap
+
+

automaticallyStartNetworkMap

+ +val automaticallyStartNetworkMap: Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/executor-service.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/executor-service.html new file mode 100644 index 0000000000..04058c0319 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/executor-service.html @@ -0,0 +1,14 @@ + + + +DriverDSL.executorService - corda + + + +corda / net.corda.node.driver / DriverDSL / executorService
+
+

executorService

+ +val executorService: ListeningScheduledExecutorService + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/shutdown-manager.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/shutdown-manager.html new file mode 100644 index 0000000000..15acfc464d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/shutdown-manager.html @@ -0,0 +1,14 @@ + + + +DriverDSL.shutdownManager - corda + + + +corda / net.corda.node.driver / DriverDSL / shutdownManager
+
+

shutdownManager

+ +val shutdownManager: ShutdownManager + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/sshd-port-allocation.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/sshd-port-allocation.html new file mode 100644 index 0000000000..4472341323 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/sshd-port-allocation.html @@ -0,0 +1,14 @@ + + + +DriverDSL.sshdPortAllocation - corda + + + +corda / net.corda.node.driver / DriverDSL / sshdPortAllocation
+
+

sshdPortAllocation

+ +val sshdPortAllocation: PortAllocation + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/start-network-map-service.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/start-network-map-service.html new file mode 100644 index 0000000000..a4dc56c7a7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/start-network-map-service.html @@ -0,0 +1,17 @@ + + + +DriverDSL.startNetworkMapService - corda + + + +corda / net.corda.node.driver / DriverDSL / startNetworkMapService
+
+

startNetworkMapService

+ +fun startNetworkMapService(): Unit +

Overrides DriverDSLExposedInterface.startNetworkMapService

+

Starts a network map service node. Note that only a single one should ever be running, so you will probably want +to set automaticallyStartNetworkMap to false in your driver call.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/system-properties.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/system-properties.html new file mode 100644 index 0000000000..2d6ea41354 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-driver-d-s-l/system-properties.html @@ -0,0 +1,14 @@ + + + +DriverDSL.systemProperties - corda + + + +corda / net.corda.node.driver / DriverDSL / systemProperties
+
+

systemProperties

+ +val systemProperties: Map<String, String> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/-init-.html new file mode 100644 index 0000000000..34d8c77379 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/-init-.html @@ -0,0 +1,13 @@ + + + +ShutdownManager.<init> - corda + + + +corda / net.corda.node.driver / ShutdownManager / <init>
+
+

<init>

+ShutdownManager(executorService: ExecutorService) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/index.html new file mode 100644 index 0000000000..6e3fb73a97 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/index.html @@ -0,0 +1,47 @@ + + + +ShutdownManager - corda + + + +corda / net.corda.node.driver / ShutdownManager
+
+

ShutdownManager

+class ShutdownManager +

Constructors

+ + + + + + + +
+<init> +ShutdownManager(executorService: ExecutorService)
+

Functions

+ + + + + + + + + + + + + + + +
+registerProcessShutdown +fun registerProcessShutdown(processFuture: ListenableFuture<Process>): Unit
+registerShutdown +fun registerShutdown(shutdown: ListenableFuture<() -> Unit>): Unit
+shutdown +fun shutdown(): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-process-shutdown.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-process-shutdown.html new file mode 100644 index 0000000000..260f1c7617 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-process-shutdown.html @@ -0,0 +1,14 @@ + + + +ShutdownManager.registerProcessShutdown - corda + + + +corda / net.corda.node.driver / ShutdownManager / registerProcessShutdown
+
+

registerProcessShutdown

+ +fun registerProcessShutdown(processFuture: ListenableFuture<Process>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-shutdown.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-shutdown.html new file mode 100644 index 0000000000..78c93797a7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/register-shutdown.html @@ -0,0 +1,14 @@ + + + +ShutdownManager.registerShutdown - corda + + + +corda / net.corda.node.driver / ShutdownManager / registerShutdown
+
+

registerShutdown

+ +fun registerShutdown(shutdown: ListenableFuture<() -> Unit>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/shutdown.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/shutdown.html new file mode 100644 index 0000000000..e65d2bcf6e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/-shutdown-manager/shutdown.html @@ -0,0 +1,14 @@ + + + +ShutdownManager.shutdown - corda + + + +corda / net.corda.node.driver / ShutdownManager / shutdown
+
+

shutdown

+ +fun shutdown(): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.driver/poll.html b/docs/build/html/api/kotlin/corda/net.corda.node.driver/poll.html new file mode 100644 index 0000000000..b9fd6d0c5b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.driver/poll.html @@ -0,0 +1,14 @@ + + + +poll - corda + + + +corda / net.corda.node.driver / poll
+
+

poll

+ +fun <A> poll(executorService: ScheduledExecutorService, pollName: String, pollIntervalMs: Long = 500, warnCount: Int = 120, check: () -> A?): ListenableFuture<A> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/rpc-ops.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/rpc-ops.html new file mode 100644 index 0000000000..b401cc5d49 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/rpc-ops.html @@ -0,0 +1,18 @@ + + + +AbstractNode.rpcOps - corda + + + +corda / net.corda.node.internal / AbstractNode / rpcOps
+
+

rpcOps

+ +open val rpcOps: CordaRPCOps +

The implementation of the CordaRPCOps interface used by this node.

+

Getter
+

The implementation of the CordaRPCOps interface used by this node.

+

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/version.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/version.html new file mode 100644 index 0000000000..eb26b51df6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-abstract-node/version.html @@ -0,0 +1,14 @@ + + + +AbstractNode.version - corda + + + +corda / net.corda.node.internal / AbstractNode / version
+
+

version

+ +protected abstract val version: Version + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-corda-r-p-c-ops-impl/registered-flows.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-corda-r-p-c-ops-impl/registered-flows.html new file mode 100644 index 0000000000..d8188a9ec5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-corda-r-p-c-ops-impl/registered-flows.html @@ -0,0 +1,16 @@ + + + +CordaRPCOpsImpl.registeredFlows - corda + + + +corda / net.corda.node.internal / CordaRPCOpsImpl / registeredFlows
+
+

registeredFlows

+ +fun registeredFlows(): List<String> +

Overrides CordaRPCOps.registeredFlows

+

Enumerates the class names of the flows that this node knows about.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/node-version-info.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/node-version-info.html new file mode 100644 index 0000000000..a044b28987 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/node-version-info.html @@ -0,0 +1,14 @@ + + + +Node.nodeVersionInfo - corda + + + +corda / net.corda.node.internal / Node / nodeVersionInfo
+
+

nodeVersionInfo

+ +val nodeVersionInfo: NodeVersionInfo + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/startup-complete.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/startup-complete.html new file mode 100644 index 0000000000..badbfd1f01 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/startup-complete.html @@ -0,0 +1,14 @@ + + + +Node.startupComplete - corda + + + +corda / net.corda.node.internal / Node / startupComplete
+
+

startupComplete

+ +val startupComplete: ListenableFuture<Unit> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/version.html b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/version.html new file mode 100644 index 0000000000..f372ad3b90 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.internal/-node/version.html @@ -0,0 +1,15 @@ + + + +Node.version - corda + + + +corda / net.corda.node.internal / Node / version
+
+

version

+ +protected val version: Version +

Overrides AbstractNode.version

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/notary-node-id.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/notary-node-id.html new file mode 100644 index 0000000000..0dc10b6aad --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/notary-node-id.html @@ -0,0 +1,14 @@ + + + +FullNodeConfiguration.notaryNodeId - corda + + + +corda / net.corda.node.services.config / FullNodeConfiguration / notaryNodeId
+
+

notaryNodeId

+ +val notaryNodeId: Int? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/p2p-address.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/p2p-address.html new file mode 100644 index 0000000000..72af2bd71f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/-full-node-configuration/p2p-address.html @@ -0,0 +1,14 @@ + + + +FullNodeConfiguration.p2pAddress - corda + + + +corda / net.corda.node.services.config / FullNodeConfiguration / p2pAddress
+
+

p2pAddress

+ +val p2pAddress: HostAndPort + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/configure-dev-key-and-trust-stores.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/configure-dev-key-and-trust-stores.html new file mode 100644 index 0000000000..44c190527b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/configure-dev-key-and-trust-stores.html @@ -0,0 +1,14 @@ + + + +configureDevKeyAndTrustStores - corda + + + +corda / net.corda.node.services.config / net.corda.nodeapi.config.SSLConfiguration / configureDevKeyAndTrustStores
+
+

configureDevKeyAndTrustStores

+ +fun SSLConfiguration.configureDevKeyAndTrustStores(myLegalName: String): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/index.html new file mode 100644 index 0000000000..3985c56dcf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.config/net.corda.nodeapi.config.-s-s-l-configuration/index.html @@ -0,0 +1,22 @@ + + + +net.corda.node.services.config.net.corda.nodeapi.config.SSLConfiguration - corda + + + +corda / net.corda.node.services.config / net.corda.nodeapi.config.SSLConfiguration
+
+

Extensions for net.corda.nodeapi.config.SSLConfiguration

+ + + + + + + +
+configureDevKeyAndTrustStores +fun SSLConfiguration.configureDevKeyAndTrustStores(myLegalName: String): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-artemis-messaging-server/p2p-host-port.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-artemis-messaging-server/p2p-host-port.html new file mode 100644 index 0000000000..2a36e89b3b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-artemis-messaging-server/p2p-host-port.html @@ -0,0 +1,14 @@ + + + +ArtemisMessagingServer.p2pHostPort - corda + + + +corda / net.corda.node.services.messaging / ArtemisMessagingServer / p2pHostPort
+
+

p2pHostPort

+ +val p2pHostPort: HostAndPort + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/-init-.html new file mode 100644 index 0000000000..3571d79051 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/-init-.html @@ -0,0 +1,13 @@ + + + +RPCDispatcher.ObservableSerializer.<init> - corda + + + +corda / net.corda.node.services.messaging / RPCDispatcher / ObservableSerializer / <init>
+
+

<init>

+ObservableSerializer() + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/index.html new file mode 100644 index 0000000000..1beda71f51 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/index.html @@ -0,0 +1,41 @@ + + + +RPCDispatcher.ObservableSerializer - corda + + + +corda / net.corda.node.services.messaging / RPCDispatcher / ObservableSerializer
+
+

ObservableSerializer

+class ObservableSerializer : Serializer<Observable<Any>> +

Constructors

+ + + + + + + +
+<init> +ObservableSerializer()
+

Functions

+ + + + + + + + + + + +
+read +fun read(kryo: Kryo, input: Input, type: Class<Observable<Any>>): Observable<Any>
+write +fun write(kryo: Kryo, output: Output, obj: Observable<Any>): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/read.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/read.html new file mode 100644 index 0000000000..7fa5f31646 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/read.html @@ -0,0 +1,14 @@ + + + +RPCDispatcher.ObservableSerializer.read - corda + + + +corda / net.corda.node.services.messaging / RPCDispatcher / ObservableSerializer / read
+
+

read

+ +fun read(kryo: Kryo, input: Input, type: Class<Observable<Any>>): Observable<Any> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/write.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/write.html new file mode 100644 index 0000000000..63e1cbd490 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/-r-p-c-dispatcher/-observable-serializer/write.html @@ -0,0 +1,14 @@ + + + +RPCDispatcher.ObservableSerializer.write - corda + + + +corda / net.corda.node.services.messaging / RPCDispatcher / ObservableSerializer / write
+
+

write

+ +fun write(kryo: Kryo, output: Output, obj: Observable<Any>): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/create-r-p-c-kryo-for-serialization.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/create-r-p-c-kryo-for-serialization.html new file mode 100644 index 0000000000..0973482f17 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/create-r-p-c-kryo-for-serialization.html @@ -0,0 +1,14 @@ + + + +createRPCKryoForSerialization - corda + + + +corda / net.corda.node.services.messaging / createRPCKryoForSerialization
+
+

createRPCKryoForSerialization

+ +fun createRPCKryoForSerialization(qName: String? = null, dispatcher: RPCDispatcher? = null): Kryo + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/release-r-p-c-kryo-for-serialization.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/release-r-p-c-kryo-for-serialization.html new file mode 100644 index 0000000000..b4a6f6610d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.messaging/release-r-p-c-kryo-for-serialization.html @@ -0,0 +1,14 @@ + + + +releaseRPCKryoForSerialization - corda + + + +corda / net.corda.node.services.messaging / releaseRPCKryoForSerialization
+
+

releaseRPCKryoForSerialization

+ +fun releaseRPCKryoForSerialization(kryo: Kryo): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-abstract-network-map-service/node-registrations.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-abstract-network-map-service/node-registrations.html new file mode 100644 index 0000000000..616fafe7ce --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-abstract-network-map-service/node-registrations.html @@ -0,0 +1,14 @@ + + + +AbstractNetworkMapService.nodeRegistrations - corda + + + +corda / net.corda.node.services.network / AbstractNetworkMapService / nodeRegistrations
+
+

nodeRegistrations

+ +protected abstract val nodeRegistrations: MutableMap<Party, NodeRegistrationInfo> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-in-memory-network-map-service/node-registrations.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-in-memory-network-map-service/node-registrations.html new file mode 100644 index 0000000000..3ae958aee7 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-in-memory-network-map-service/node-registrations.html @@ -0,0 +1,15 @@ + + + +InMemoryNetworkMapService.nodeRegistrations - corda + + + +corda / net.corda.node.services.network / InMemoryNetworkMapService / nodeRegistrations
+
+

nodeRegistrations

+ +protected val nodeRegistrations: MutableMap<Party, NodeRegistrationInfo> +

Overrides AbstractNetworkMapService.nodeRegistrations

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-network-map-service/-registration-response/error.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-network-map-service/-registration-response/error.html new file mode 100644 index 0000000000..1145f03e5b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-network-map-service/-registration-response/error.html @@ -0,0 +1,14 @@ + + + +NetworkMapService.RegistrationResponse.error - corda + + + +corda / net.corda.node.services.network / NetworkMapService / RegistrationResponse / error
+
+

error

+ +val error: String? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-persistent-network-map-service/node-registrations.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-persistent-network-map-service/node-registrations.html new file mode 100644 index 0000000000..ec43c2923d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.network/-persistent-network-map-service/node-registrations.html @@ -0,0 +1,15 @@ + + + +PersistentNetworkMapService.nodeRegistrations - corda + + + +corda / net.corda.node.services.network / PersistentNetworkMapService / nodeRegistrations
+
+

nodeRegistrations

+ +protected val nodeRegistrations: MutableMap<Party, NodeRegistrationInfo> +

Overrides AbstractNetworkMapService.nodeRegistrations

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/-init-.html new file mode 100644 index 0000000000..e1f1000eec --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/-init-.html @@ -0,0 +1,13 @@ + + + +NodeAttachmentService.HashMismatchException.<init> - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / HashMismatchException / <init>
+
+

<init>

+HashMismatchException(expected: SecureHash, actual: SecureHash) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/actual.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/actual.html new file mode 100644 index 0000000000..ecf3156481 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/actual.html @@ -0,0 +1,14 @@ + + + +NodeAttachmentService.HashMismatchException.actual - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / HashMismatchException / actual
+
+

actual

+ +val actual: SecureHash + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/expected.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/expected.html new file mode 100644 index 0000000000..7b2dc66d5a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/expected.html @@ -0,0 +1,14 @@ + + + +NodeAttachmentService.HashMismatchException.expected - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / HashMismatchException / expected
+
+

expected

+ +val expected: SecureHash + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/index.html new file mode 100644 index 0000000000..71aa5a4ece --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/index.html @@ -0,0 +1,52 @@ + + + +NodeAttachmentService.HashMismatchException - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / HashMismatchException
+
+

HashMismatchException

+class HashMismatchException : Exception +

Constructors

+ + + + + + + +
+<init> +HashMismatchException(expected: SecureHash, actual: SecureHash)
+

Properties

+ + + + + + + + + + + +
+actual +val actual: SecureHash
+expected +val expected: SecureHash
+

Functions

+ + + + + + + +
+toString +fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/to-string.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/to-string.html new file mode 100644 index 0000000000..f2c7cc4966 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/-hash-mismatch-exception/to-string.html @@ -0,0 +1,14 @@ + + + +NodeAttachmentService.HashMismatchException.toString - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / HashMismatchException / toString
+
+

toString

+ +fun toString(): String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/configuration.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/configuration.html new file mode 100644 index 0000000000..2eb6d23544 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/configuration.html @@ -0,0 +1,14 @@ + + + +NodeAttachmentService.configuration - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / configuration
+
+

configuration

+ +val configuration: RequeryConfiguration + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/session.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/session.html new file mode 100644 index 0000000000..a0892ad1a6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.persistence/-node-attachment-service/session.html @@ -0,0 +1,14 @@ + + + +NodeAttachmentService.session - corda + + + +corda / net.corda.node.services.persistence / NodeAttachmentService / session
+
+

session

+ +val session: KotlinEntityDataStore<Persistable> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-init-.html new file mode 100644 index 0000000000..a2d7be036a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-init-.html @@ -0,0 +1,15 @@ + + + +BFTNonValidatingNotaryService.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / <init>
+
+

<init>

+BFTNonValidatingNotaryService(services: ServiceHubInternal, timestampChecker: TimestampChecker, serverId: Int, db: Database, client: Client) +

A non-validating notary service operated by a group of parties that don't necessarily trust each other.

+

A transaction is notarised when the consensus is reached by the cluster on its uniqueness, and timestamp validity.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/-init-.html new file mode 100644 index 0000000000..0cdbf16923 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/-init-.html @@ -0,0 +1,13 @@ + + + +BFTNonValidatingNotaryService.Server.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / Server / <init>
+
+

<init>

+Server(id: Int, db: Database, tableName: String, services: ServiceHubInternal, timestampChecker: TimestampChecker) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/execute-command.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/execute-command.html new file mode 100644 index 0000000000..a171fa0413 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/execute-command.html @@ -0,0 +1,17 @@ + + + +BFTNonValidatingNotaryService.Server.executeCommand - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / Server / executeCommand
+
+

executeCommand

+ +fun executeCommand(command: ByteArray): ByteArray +

Overrides Server.executeCommand

+

Implement logic to execute the command and commit the transaction to the log. +Helper methods are provided for transaction processing: commitInputStates, validateTimestamp, and sign.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/index.html new file mode 100644 index 0000000000..6eda65d4b4 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/index.html @@ -0,0 +1,126 @@ + + + +BFTNonValidatingNotaryService.Server - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / Server
+
+

Server

+class Server : Server +

Constructors

+ + + + + + + +
+<init> +Server(id: Int, db: Database, tableName: String, services: ServiceHubInternal, timestampChecker: TimestampChecker)
+

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+commitLog +val commitLog: JDBCHashMap<StateRef, ConsumingTx>
+db +val db: Database
+id +val id: Int
+services +val services: ServiceHubInternal
+timestampChecker +val timestampChecker: TimestampChecker
+

Functions

+ + + + + + + + + + + +
+executeCommand +fun executeCommand(command: ByteArray): ByteArray +

Implement logic to execute the command and commit the transaction to the log. +Helper methods are provided for transaction processing: commitInputStates, validateTimestamp, and sign.

+
+verifyAndCommitTx +fun verifyAndCommitTx(ftx: FilteredTransaction, callerIdentity: Party): ReplicaResponse
+

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+appExecuteBatch +open fun appExecuteBatch(command: Array<ByteArray>, mcs: Array<MessageContext>): Array<ByteArray?>
+appExecuteUnordered +open fun appExecuteUnordered(command: ByteArray, msgCtx: MessageContext): ByteArray?
+commitInputStates +fun commitInputStates(states: List<StateRef>, txId: SecureHash, callerIdentity: Party): Unit
+getSnapshot +open fun getSnapshot(): ByteArray
+installSnapshot +open fun installSnapshot(bytes: ByteArray): Unit
+sign +fun sign(bytes: ByteArray): WithKey
+validateTimestamp +fun validateTimestamp(t: Timestamp?): Unit
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/verify-and-commit-tx.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/verify-and-commit-tx.html new file mode 100644 index 0000000000..8fffe38441 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-server/verify-and-commit-tx.html @@ -0,0 +1,14 @@ + + + +BFTNonValidatingNotaryService.Server.verifyAndCommitTx - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / Server / verifyAndCommitTx
+
+

verifyAndCommitTx

+ +fun verifyAndCommitTx(ftx: FilteredTransaction, callerIdentity: Party): ReplicaResponse + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/-init-.html new file mode 100644 index 0000000000..ae882314f0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/-init-.html @@ -0,0 +1,13 @@ + + + +BFTNonValidatingNotaryService.ServiceFlow.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / ServiceFlow / <init>
+
+

<init>

+ServiceFlow(otherSide: Party, client: Client) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/call.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/call.html new file mode 100644 index 0000000000..dc801ca3e6 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/call.html @@ -0,0 +1,17 @@ + + + +BFTNonValidatingNotaryService.ServiceFlow.call - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / ServiceFlow / call
+
+

call

+ +@Suspendable fun call(): Void? +

Overrides FlowLogic.call

+

This is where you fill out your business logic. The returned object will usually be ignored, but can be +helpful if this flow is meant to be used as a subflow.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/client.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/client.html new file mode 100644 index 0000000000..6c78d70054 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/client.html @@ -0,0 +1,14 @@ + + + +BFTNonValidatingNotaryService.ServiceFlow.client - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / ServiceFlow / client
+
+

client

+ +val client: Client + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/index.html new file mode 100644 index 0000000000..a69c5e22b0 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/index.html @@ -0,0 +1,183 @@ + + + +BFTNonValidatingNotaryService.ServiceFlow - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / ServiceFlow
+
+

ServiceFlow

+class ServiceFlow : FlowLogic<Void?> +

Constructors

+ + + + + + + +
+<init> +ServiceFlow(otherSide: Party, client: Client)
+

Properties

+ + + + + + + + + + + +
+client +val client: Client
+otherSide +val otherSide: Party
+

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+logger +val logger: Logger +

This is where you should log things to.

+
+progressTracker +open val progressTracker: ProgressTracker? +

Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something +helpful with the progress reports. If this flow is invoked as a subflow of another, then the +tracker will be made a child of the current step in the parent. If it's null, this flow doesn't track +progress.

+
+runId +val runId: StateMachineRunId +

Returns a wrapped UUID object that identifies this state machine run (i.e. subflows have the same identifier as their parents).

+
+serviceHub +val serviceHub: ServiceHub +

Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts. It is +only available once the flow has started, which means it cannnot be accessed in the constructor. Either +access this lazily or from inside call.

+
+stateMachine +var stateMachine: FlowStateMachine<*> +

Internal only. Reference to the Fiber instance that is the top level controller for the entire flow. When +inside a flow this is equivalent to Strand.currentStrand. This is public only because it must be accessed +across module boundaries.

+
+

Functions

+ + + + + + + +
+call +fun call(): Void? +

This is where you fill out your business logic. The returned object will usually be ignored, but can be +helpful if this flow is meant to be used as a subflow.

+
+

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+getCounterpartyMarker +open fun getCounterpartyMarker(party: Party): Class<*> +

Return the marker Class which party has used to register the counterparty flow that is to execute on the +other side. The default implementation returns the class object of this FlowLogic, but any Class instance +will do as long as the other side registers with it.

+
+receive +open fun <R : Any> receive(receiveType: Class<R>, otherParty: Party): UntrustworthyData<R> +

Suspends until the specified otherParty sends us a message of type receiveType.

+fun <R : Any> receive(otherParty: Party): UntrustworthyData<R> +

Suspends until the specified otherParty sends us a message of type R.

+
+send +open fun send(otherParty: Party, payload: Any): Unit +

Queues the given payload for sending to the otherParty and continues without suspending.

+
+sendAndReceive +fun <R : Any> sendAndReceive(otherParty: Party, payload: Any): UntrustworthyData<R> +

Serializes and queues the given payload object for sending to the otherParty. Suspends until a response +is received, which must be of the given R type.

+open fun <R : Any> sendAndReceive(receiveType: Class<R>, otherParty: Party, payload: Any): UntrustworthyData<R> +

Serializes and queues the given payload object for sending to the otherParty. Suspends until a response +is received, which must be of the given receiveType. Remember that when receiving data from other parties the data +should not be trusted until it's been thoroughly verified for consistency and that all expectations are +satisfied, as a malicious peer may send you subtly corrupted data in order to exploit your code.

+
+subFlow +open fun <R> subFlow(subLogic: FlowLogic<R>, shareParentSessions: Boolean = false): R +

Invokes the given subflow. This function returns once the subflow completes successfully with the result +returned by that subflows call method. If the subflow has a progress tracker, it is attached to the +current step in this flow's progress tracker.

+
+track +fun track(): Pair<String, Observable<String>>? +

Returns a pair of the current progress step, as a string, and an observable of stringified changes to the +progressTracker.

+
+waitForLedgerCommit +fun waitForLedgerCommit(hash: SecureHash): SignedTransaction +

Suspends the flow until the transaction with the specified ID is received, successfully verified and +sent to the vault for processing. Note that this call suspends until the transaction is considered +valid by the local node, but that doesn't imply the vault will consider it relevant.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/other-side.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/other-side.html new file mode 100644 index 0000000000..59d4293f15 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/-service-flow/other-side.html @@ -0,0 +1,14 @@ + + + +BFTNonValidatingNotaryService.ServiceFlow.otherSide - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / ServiceFlow / otherSide
+
+

otherSide

+ +val otherSide: Party + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/client.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/client.html new file mode 100644 index 0000000000..3830075b6e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/client.html @@ -0,0 +1,14 @@ + + + +BFTNonValidatingNotaryService.client - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / client
+
+

client

+ +val client: Client + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/create-flow.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/create-flow.html new file mode 100644 index 0000000000..8c3a79ad28 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/create-flow.html @@ -0,0 +1,16 @@ + + + +BFTNonValidatingNotaryService.createFlow - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / createFlow
+
+

createFlow

+ +fun createFlow(otherParty: Party): ServiceFlow +

Overrides NotaryService.createFlow

+

Implement a factory that specifies the transaction commit flow for the notary service to use

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/index.html new file mode 100644 index 0000000000..e8be05e2ac --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/index.html @@ -0,0 +1,80 @@ + + + +BFTNonValidatingNotaryService - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService
+
+

BFTNonValidatingNotaryService

+class BFTNonValidatingNotaryService : NotaryService +

A non-validating notary service operated by a group of parties that don't necessarily trust each other.

+

A transaction is notarised when the consensus is reached by the cluster on its uniqueness, and timestamp validity.

+

Types

+ + + + + + + + + + + +
+Server +class Server : Server
+ServiceFlow +class ServiceFlow : FlowLogic<Void?>
+

Constructors

+ + + + + + + +
+<init> +BFTNonValidatingNotaryService(services: ServiceHubInternal, timestampChecker: TimestampChecker, serverId: Int, db: Database, client: Client) +

A non-validating notary service operated by a group of parties that don't necessarily trust each other.

+
+

Properties

+ + + + + + + +
+client +val client: Client
+

Functions

+ + + + + + + +
+createFlow +fun createFlow(otherParty: Party): ServiceFlow +

Implement a factory that specifies the transaction commit flow for the notary service to use

+
+

Companion Object Properties

+ + + + + + + +
+type +val type: ServiceType
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/type.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/type.html new file mode 100644 index 0000000000..d89d8a42a5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-non-validating-notary-service/type.html @@ -0,0 +1,14 @@ + + + +BFTNonValidatingNotaryService.type - corda + + + +corda / net.corda.node.services.transactions / BFTNonValidatingNotaryService / type
+
+

type

+ +val type: ServiceType + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/-init-.html new file mode 100644 index 0000000000..20cb12345c --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/-init-.html @@ -0,0 +1,13 @@ + + + +BFTSMaRt.Client.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Client / <init>
+
+

<init>

+Client(id: Int) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/commit-transaction.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/commit-transaction.html new file mode 100644 index 0000000000..16e882c4db --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/commit-transaction.html @@ -0,0 +1,16 @@ + + + +BFTSMaRt.Client.commitTransaction - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Client / commitTransaction
+
+

commitTransaction

+ +fun commitTransaction(transaction: Any, otherSide: Party): ClusterResponse +

Sends a transaction commit request to the BFT cluster. The proxy will deliver the request to every +replica, and block until a sufficient number of replies are received.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/id.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/id.html new file mode 100644 index 0000000000..1dad034c2d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/id.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Client.id - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Client / id
+
+

id

+ +val id: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/index.html new file mode 100644 index 0000000000..d41c14ba85 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-client/index.html @@ -0,0 +1,60 @@ + + + +BFTSMaRt.Client - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Client
+
+

Client

+class Client : SingletonSerializeAsToken +

Constructors

+ + + + + + + +
+<init> +Client(id: Int)
+

Properties

+ + + + + + + +
+id +val id: Int
+

Functions

+ + + + + + + +
+commitTransaction +fun commitTransaction(transaction: Any, otherSide: Party): ClusterResponse +

Sends a transaction commit request to the BFT cluster. The proxy will deliver the request to every +replica, and block until a sufficient number of replies are received.

+
+

Inherited Functions

+ + + + + + + +
+toToken +open fun toToken(context: SerializeAsTokenContext): SerializationToken
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/-init-.html new file mode 100644 index 0000000000..b340d5d6f2 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/-init-.html @@ -0,0 +1,13 @@ + + + +BFTSMaRt.ClusterResponse.Error.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Error / <init>
+
+

<init>

+Error(error: NotaryError) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/error.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/error.html new file mode 100644 index 0000000000..92395f8266 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/error.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.ClusterResponse.Error.error - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Error / error
+
+

error

+ +val error: NotaryError + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/index.html new file mode 100644 index 0000000000..ddb09e1916 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-error/index.html @@ -0,0 +1,35 @@ + + + +BFTSMaRt.ClusterResponse.Error - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Error
+
+

Error

+class Error : ClusterResponse +

Constructors

+ + + + + + + +
+<init> +Error(error: NotaryError)
+

Properties

+ + + + + + + +
+error +val error: NotaryError
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/-init-.html new file mode 100644 index 0000000000..5a04171bbe --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/-init-.html @@ -0,0 +1,13 @@ + + + +BFTSMaRt.ClusterResponse.Signatures.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Signatures / <init>
+
+

<init>

+Signatures(txSignatures: List<DigitalSignature>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/index.html new file mode 100644 index 0000000000..09413a1956 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/index.html @@ -0,0 +1,35 @@ + + + +BFTSMaRt.ClusterResponse.Signatures - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Signatures
+
+

Signatures

+class Signatures : ClusterResponse +

Constructors

+ + + + + + + +
+<init> +Signatures(txSignatures: List<DigitalSignature>)
+

Properties

+ + + + + + + +
+txSignatures +val txSignatures: List<DigitalSignature>
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/tx-signatures.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/tx-signatures.html new file mode 100644 index 0000000000..acc17de27d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/-signatures/tx-signatures.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.ClusterResponse.Signatures.txSignatures - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse / Signatures / txSignatures
+
+

txSignatures

+ +val txSignatures: List<DigitalSignature> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/index.html new file mode 100644 index 0000000000..dc3bbcdc92 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-cluster-response/index.html @@ -0,0 +1,48 @@ + + + +BFTSMaRt.ClusterResponse - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ClusterResponse
+
+

ClusterResponse

+sealed class ClusterResponse +

An aggregate response from all replica (Server) replies sent from Client back to the calling application.

+

Types

+ + + + + + + + + + + +
+Error +class Error : ClusterResponse
+Signatures +class Signatures : ClusterResponse
+

Inheritors

+ + + + + + + + + + + +
+Error +class Error : ClusterResponse
+Signatures +class Signatures : ClusterResponse
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/-init-.html new file mode 100644 index 0000000000..31268fb3fd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/-init-.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.CommitRequest.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / CommitRequest / <init>
+
+

<init>

+CommitRequest(tx: Any, callerIdentity: Party) +

Sent from Client to Server.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/caller-identity.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/caller-identity.html new file mode 100644 index 0000000000..6665d78cd3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/caller-identity.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.CommitRequest.callerIdentity - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / CommitRequest / callerIdentity
+
+

callerIdentity

+ +val callerIdentity: Party + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/index.html new file mode 100644 index 0000000000..4780b94b9b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/index.html @@ -0,0 +1,44 @@ + + + +BFTSMaRt.CommitRequest - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / CommitRequest
+
+

CommitRequest

+data class CommitRequest +

Sent from Client to Server.

+

Constructors

+ + + + + + + +
+<init> +CommitRequest(tx: Any, callerIdentity: Party) +

Sent from Client to Server.

+
+

Properties

+ + + + + + + + + + + +
+callerIdentity +val callerIdentity: Party
+tx +val tx: Any
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/tx.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/tx.html new file mode 100644 index 0000000000..1d036f54c8 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-commit-request/tx.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.CommitRequest.tx - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / CommitRequest / tx
+
+

tx

+ +val tx: Any + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/-init-.html new file mode 100644 index 0000000000..a17c493782 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/-init-.html @@ -0,0 +1,13 @@ + + + +BFTSMaRt.ReplicaResponse.Error.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Error / <init>
+
+

<init>

+Error(error: NotaryError) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/error.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/error.html new file mode 100644 index 0000000000..6d09eb0330 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/error.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.ReplicaResponse.Error.error - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Error / error
+
+

error

+ +val error: NotaryError + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/index.html new file mode 100644 index 0000000000..9d98476fda --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-error/index.html @@ -0,0 +1,35 @@ + + + +BFTSMaRt.ReplicaResponse.Error - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Error
+
+

Error

+class Error : ReplicaResponse +

Constructors

+ + + + + + + +
+<init> +Error(error: NotaryError)
+

Properties

+ + + + + + + +
+error +val error: NotaryError
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/-init-.html new file mode 100644 index 0000000000..d4f6bee923 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/-init-.html @@ -0,0 +1,13 @@ + + + +BFTSMaRt.ReplicaResponse.Signature.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Signature / <init>
+
+

<init>

+Signature(txSignature: DigitalSignature) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/index.html new file mode 100644 index 0000000000..ab905b6790 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/index.html @@ -0,0 +1,35 @@ + + + +BFTSMaRt.ReplicaResponse.Signature - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Signature
+
+

Signature

+class Signature : ReplicaResponse +

Constructors

+ + + + + + + +
+<init> +Signature(txSignature: DigitalSignature)
+

Properties

+ + + + + + + +
+txSignature +val txSignature: DigitalSignature
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/tx-signature.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/tx-signature.html new file mode 100644 index 0000000000..bf22d50124 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/-signature/tx-signature.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.ReplicaResponse.Signature.txSignature - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse / Signature / txSignature
+
+

txSignature

+ +val txSignature: DigitalSignature + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/index.html new file mode 100644 index 0000000000..64f88e3ec5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-replica-response/index.html @@ -0,0 +1,48 @@ + + + +BFTSMaRt.ReplicaResponse - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / ReplicaResponse
+
+

ReplicaResponse

+sealed class ReplicaResponse +

Sent from Server to Client.

+

Types

+ + + + + + + + + + + +
+Error +class Error : ReplicaResponse
+Signature +class Signature : ReplicaResponse
+

Inheritors

+ + + + + + + + + + + +
+Error +class Error : ReplicaResponse
+Signature +class Signature : ReplicaResponse
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/-init-.html new file mode 100644 index 0000000000..9076e10f78 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/-init-.html @@ -0,0 +1,15 @@ + + + +BFTSMaRt.Server.<init> - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / <init>
+
+

<init>

+Server(id: Int, db: Database, tableName: String, services: ServiceHubInternal, timestampChecker: TimestampChecker) +

Maintains the commit log and executes commit commands received from the Client.

+

The validation logic can be specified by implementing the executeCommand method.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-batch.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-batch.html new file mode 100644 index 0000000000..5236ecffdf --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-batch.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.appExecuteBatch - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / appExecuteBatch
+
+

appExecuteBatch

+ +open fun appExecuteBatch(command: Array<ByteArray>, mcs: Array<MessageContext>): Array<ByteArray?> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-unordered.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-unordered.html new file mode 100644 index 0000000000..f1106708cc --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/app-execute-unordered.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.appExecuteUnordered - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / appExecuteUnordered
+
+

appExecuteUnordered

+ +open fun appExecuteUnordered(command: ByteArray, msgCtx: MessageContext): ByteArray? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-input-states.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-input-states.html new file mode 100644 index 0000000000..28493bd299 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-input-states.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.commitInputStates - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / commitInputStates
+
+

commitInputStates

+ +protected fun commitInputStates(states: List<StateRef>, txId: SecureHash, callerIdentity: Party): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-log.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-log.html new file mode 100644 index 0000000000..f77db51053 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/commit-log.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.commitLog - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / commitLog
+
+

commitLog

+ +val commitLog: JDBCHashMap<StateRef, ConsumingTx> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/db.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/db.html new file mode 100644 index 0000000000..d4c39edf9e --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/db.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.db - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / db
+
+

db

+ +val db: Database + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/execute-command.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/execute-command.html new file mode 100644 index 0000000000..7e9eed3a76 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/execute-command.html @@ -0,0 +1,16 @@ + + + +BFTSMaRt.Server.executeCommand - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / executeCommand
+
+

executeCommand

+ +abstract fun executeCommand(command: ByteArray): ByteArray? +

Implement logic to execute the command and commit the transaction to the log. +Helper methods are provided for transaction processing: commitInputStates, validateTimestamp, and sign.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/get-snapshot.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/get-snapshot.html new file mode 100644 index 0000000000..5fd7494741 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/get-snapshot.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.getSnapshot - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / getSnapshot
+
+

getSnapshot

+ +open fun getSnapshot(): ByteArray + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/id.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/id.html new file mode 100644 index 0000000000..138a2ba164 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/id.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.id - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / id
+
+

id

+ +val id: Int + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/index.html new file mode 100644 index 0000000000..0fcc0ddc77 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/index.html @@ -0,0 +1,130 @@ + + + +BFTSMaRt.Server - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server
+
+

Server

+abstract class Server : DefaultRecoverable +

Maintains the commit log and executes commit commands received from the Client.

+

The validation logic can be specified by implementing the executeCommand method.

+

Constructors

+ + + + + + + +
+<init> +Server(id: Int, db: Database, tableName: String, services: ServiceHubInternal, timestampChecker: TimestampChecker) +

Maintains the commit log and executes commit commands received from the Client.

+
+

Properties

+ + + + + + + + + + + + + + + + + + + + + + + +
+commitLog +val commitLog: JDBCHashMap<StateRef, ConsumingTx>
+db +val db: Database
+id +val id: Int
+services +val services: ServiceHubInternal
+timestampChecker +val timestampChecker: TimestampChecker
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+appExecuteBatch +open fun appExecuteBatch(command: Array<ByteArray>, mcs: Array<MessageContext>): Array<ByteArray?>
+appExecuteUnordered +open fun appExecuteUnordered(command: ByteArray, msgCtx: MessageContext): ByteArray?
+commitInputStates +fun commitInputStates(states: List<StateRef>, txId: SecureHash, callerIdentity: Party): Unit
+executeCommand +abstract fun executeCommand(command: ByteArray): ByteArray? +

Implement logic to execute the command and commit the transaction to the log. +Helper methods are provided for transaction processing: commitInputStates, validateTimestamp, and sign.

+
+getSnapshot +open fun getSnapshot(): ByteArray
+installSnapshot +open fun installSnapshot(bytes: ByteArray): Unit
+sign +fun sign(bytes: ByteArray): WithKey
+validateTimestamp +fun validateTimestamp(t: Timestamp?): Unit
+

Inheritors

+ + + + + + + +
+Server +class Server : Server
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/install-snapshot.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/install-snapshot.html new file mode 100644 index 0000000000..a792c0ad12 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/install-snapshot.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.installSnapshot - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / installSnapshot
+
+

installSnapshot

+ +open fun installSnapshot(bytes: ByteArray): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/services.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/services.html new file mode 100644 index 0000000000..9e9e53f4c5 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/services.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.services - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / services
+
+

services

+ +val services: ServiceHubInternal + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/sign.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/sign.html new file mode 100644 index 0000000000..3055bb07dd --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/sign.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.sign - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / sign
+
+

sign

+ +protected fun sign(bytes: ByteArray): WithKey + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/timestamp-checker.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/timestamp-checker.html new file mode 100644 index 0000000000..e8d8b52230 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/timestamp-checker.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.timestampChecker - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / timestampChecker
+
+

timestampChecker

+ +val timestampChecker: TimestampChecker + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/validate-timestamp.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/validate-timestamp.html new file mode 100644 index 0000000000..da3bf9d8b3 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/-server/validate-timestamp.html @@ -0,0 +1,14 @@ + + + +BFTSMaRt.Server.validateTimestamp - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt / Server / validateTimestamp
+
+

validateTimestamp

+ +protected fun validateTimestamp(t: Timestamp?): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/index.html new file mode 100644 index 0000000000..b94eb71b0b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.services.transactions/-b-f-t-s-ma-rt/index.html @@ -0,0 +1,59 @@ + + + +BFTSMaRt - corda + + + +corda / net.corda.node.services.transactions / BFTSMaRt
+
+

BFTSMaRt

+object BFTSMaRt +

Implements a replicated transaction commit log based on the BFT-SMaRt +consensus algorithm. Every replica in the cluster is running a Server maintaining the state, and aClient is used +to to relay state modification requests to all Servers.

+

Types

+ + + + + + + + + + + + + + + + + + + + + + + +
+Client +class Client : SingletonSerializeAsToken
+ClusterResponse +sealed class ClusterResponse +

An aggregate response from all replica (Server) replies sent from Client back to the calling application.

+
+CommitRequest +data class CommitRequest +

Sent from Client to Server.

+
+ReplicaResponse +sealed class ReplicaResponse +

Sent from Server to Client.

+
+Server +abstract class Server : DefaultRecoverable +

Maintains the commit log and executes commit commands received from the Client.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-a-n-s-i-progress-renderer/on-done.html b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-a-n-s-i-progress-renderer/on-done.html new file mode 100644 index 0000000000..fe7e53a371 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-a-n-s-i-progress-renderer/on-done.html @@ -0,0 +1,14 @@ + + + +ANSIProgressRenderer.onDone - corda + + + +corda / net.corda.node.utilities / ANSIProgressRenderer / onDone
+
+

onDone

+ +var onDone: () -> Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/index.html b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/index.html new file mode 100644 index 0000000000..36e3c6056f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/index.html @@ -0,0 +1,34 @@ + + + +AddressUtils - corda + + + +corda / net.corda.node.utilities / AddressUtils
+
+

AddressUtils

+object AddressUtils +

Functions

+ + + + + + + + + + + +
+isPublic +fun isPublic(address: InetAddress): Boolean +

Returns true if the provided address is a public IP address or hostname.

+fun isPublic(hostText: String): Boolean
+tryDetectPublicIP +fun tryDetectPublicIP(): InetAddress? +

Returns the first public IP address found on any of the network interfaces, or null if none found.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/is-public.html b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/is-public.html new file mode 100644 index 0000000000..288906cc40 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/is-public.html @@ -0,0 +1,19 @@ + + + +AddressUtils.isPublic - corda + + + +corda / net.corda.node.utilities / AddressUtils / isPublic
+
+

isPublic

+ +

+fun isPublic(address: InetAddress): Boolean +

Returns true if the provided address is a public IP address or hostname.

+ +

+fun isPublic(hostText: String): Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/try-detect-public-i-p.html b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/try-detect-public-i-p.html new file mode 100644 index 0000000000..c83a29dd13 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node.utilities/-address-utils/try-detect-public-i-p.html @@ -0,0 +1,15 @@ + + + +AddressUtils.tryDetectPublicIP - corda + + + +corda / net.corda.node.utilities / AddressUtils / tryDetectPublicIP
+
+

tryDetectPublicIP

+ +fun tryDetectPublicIP(): InetAddress? +

Returns the first public IP address found on any of the network interfaces, or null if none found.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/is-version.html b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/is-version.html new file mode 100644 index 0000000000..691832b26f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/is-version.html @@ -0,0 +1,14 @@ + + + +CmdLineOptions.isVersion - corda + + + +corda / net.corda.node / CmdLineOptions / isVersion
+
+

isVersion

+ +val isVersion: Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/no-local-shell.html b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/no-local-shell.html new file mode 100644 index 0000000000..6895813a3f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/no-local-shell.html @@ -0,0 +1,14 @@ + + + +CmdLineOptions.noLocalShell - corda + + + +corda / net.corda.node / CmdLineOptions / noLocalShell
+
+

noLocalShell

+ +val noLocalShell: Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/sshd-server.html b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/sshd-server.html new file mode 100644 index 0000000000..d878bcffda --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-cmd-line-options/sshd-server.html @@ -0,0 +1,14 @@ + + + +CmdLineOptions.sshdServer - corda + + + +corda / net.corda.node / CmdLineOptions / sshdServer
+
+

sshdServer

+ +val sshdServer: Boolean + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/-init-.html new file mode 100644 index 0000000000..b1f5bcd69f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/-init-.html @@ -0,0 +1,14 @@ + + + +InteractiveShellCommand.<init> - corda + + + +corda / net.corda.node / InteractiveShellCommand / <init>
+
+

<init>

+InteractiveShellCommand() +

Simply extends CRaSH BaseCommand to add easy access to the RPC ops class.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/index.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/index.html new file mode 100644 index 0000000000..df674077f1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/index.html @@ -0,0 +1,50 @@ + + + +InteractiveShellCommand - corda + + + +corda / net.corda.node / InteractiveShellCommand
+
+

InteractiveShellCommand

+open class InteractiveShellCommand : BaseCommand +

Simply extends CRaSH BaseCommand to add easy access to the RPC ops class.

+

Constructors

+ + + + + + + +
+<init> +InteractiveShellCommand() +

Simply extends CRaSH BaseCommand to add easy access to the RPC ops class.

+
+

Functions

+ + + + + + + + + + + + + + + +
+objectMapper +fun objectMapper(): ObjectMapper
+ops +fun ops(): CordaRPCOps
+services +fun services(): ServiceHubInternal
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/object-mapper.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/object-mapper.html new file mode 100644 index 0000000000..9fcb644123 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/object-mapper.html @@ -0,0 +1,14 @@ + + + +InteractiveShellCommand.objectMapper - corda + + + +corda / net.corda.node / InteractiveShellCommand / objectMapper
+
+

objectMapper

+ +fun objectMapper(): ObjectMapper + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/ops.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/ops.html new file mode 100644 index 0000000000..900cfe7430 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/ops.html @@ -0,0 +1,14 @@ + + + +InteractiveShellCommand.ops - corda + + + +corda / net.corda.node / InteractiveShellCommand / ops
+
+

ops

+ +fun ops(): CordaRPCOps + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/services.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/services.html new file mode 100644 index 0000000000..48cce0e998 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell-command/services.html @@ -0,0 +1,14 @@ + + + +InteractiveShellCommand.services - corda + + + +corda / net.corda.node / InteractiveShellCommand / services
+
+

services

+ +fun services(): ServiceHubInternal + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/close-all.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/close-all.html new file mode 100644 index 0000000000..96372f95fe --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/close-all.html @@ -0,0 +1,14 @@ + + + +InteractiveShell.InputStreamDeserializer.closeAll - corda + + + +corda / net.corda.node / InteractiveShell / InputStreamDeserializer / closeAll
+
+

closeAll

+ +fun closeAll(): Unit + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/deserialize.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/deserialize.html new file mode 100644 index 0000000000..949d6da809 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/deserialize.html @@ -0,0 +1,14 @@ + + + +InteractiveShell.InputStreamDeserializer.deserialize - corda + + + +corda / net.corda.node / InteractiveShell / InputStreamDeserializer / deserialize
+
+

deserialize

+ +fun deserialize(p: JsonParser, ctxt: DeserializationContext): InputStream + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/index.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/index.html new file mode 100644 index 0000000000..608d2b3242 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-input-stream-deserializer/index.html @@ -0,0 +1,30 @@ + + + +InteractiveShell.InputStreamDeserializer - corda + + + +corda / net.corda.node / InteractiveShell / InputStreamDeserializer
+
+

InputStreamDeserializer

+object InputStreamDeserializer : JsonDeserializer<InputStream> +

Functions

+ + + + + + + + + + + +
+closeAll +fun closeAll(): Unit
+deserialize +fun deserialize(p: JsonParser, ctxt: DeserializationContext): InputStream
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/-init-.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/-init-.html new file mode 100644 index 0000000000..820c44bb0a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/-init-.html @@ -0,0 +1,13 @@ + + + +InteractiveShell.NoApplicableConstructor.<init> - corda + + + +corda / net.corda.node / InteractiveShell / NoApplicableConstructor / <init>
+
+

<init>

+NoApplicableConstructor(errors: List<String>) + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/errors.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/errors.html new file mode 100644 index 0000000000..a5774763da --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/errors.html @@ -0,0 +1,14 @@ + + + +InteractiveShell.NoApplicableConstructor.errors - corda + + + +corda / net.corda.node / InteractiveShell / NoApplicableConstructor / errors
+
+

errors

+ +val errors: List<String> + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/index.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/index.html new file mode 100644 index 0000000000..9158ce0b49 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/index.html @@ -0,0 +1,46 @@ + + + +InteractiveShell.NoApplicableConstructor - corda + + + +corda / net.corda.node / InteractiveShell / NoApplicableConstructor
+
+

NoApplicableConstructor

+class NoApplicableConstructor : Exception +

Constructors

+ + + + + + + +
+<init> +NoApplicableConstructor(errors: List<String>)
+

Properties

+ + + + + + + +
+errors +val errors: List<String>
+

Functions

+ + + + + + + +
+toString +fun toString(): String
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/to-string.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/to-string.html new file mode 100644 index 0000000000..22ad68562b --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/-no-applicable-constructor/to-string.html @@ -0,0 +1,14 @@ + + + +InteractiveShell.NoApplicableConstructor.toString - corda + + + +corda / net.corda.node / InteractiveShell / NoApplicableConstructor / toString
+
+

toString

+ +fun toString(): String + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/index.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/index.html new file mode 100644 index 0000000000..709e63fb3d --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/index.html @@ -0,0 +1,76 @@ + + + +InteractiveShell - corda + + + +corda / net.corda.node / InteractiveShell
+
+

InteractiveShell

+object InteractiveShell +

Types

+ + + + + + + +
+InputStreamDeserializer +object InputStreamDeserializer : JsonDeserializer<InputStream>
+

Exceptions

+ + + + + + + +
+NoApplicableConstructor +class NoApplicableConstructor : Exception
+

Functions

+ + + + + + + + + + + + + + + + + + + +
+runFlowByNameFragment +fun runFlowByNameFragment(nameFragment: String, inputData: String, output: RenderPrintWriter): Unit +

Called from the 'flow' shell command. Takes a name fragment and finds a matching flow, or prints out +the list of options if the request is ambiguous. Then parses inputData as constructor arguments using +the runFlowFromString method and starts the requested flow using the ANSIProgressRenderer to draw +the progress tracker. Ctrl-C can be used to cancel.

+
+runFlowFromString +fun runFlowFromString(invoke: (FlowLogic<*>) -> FlowStateMachine<*>, inputData: String, clazz: Class<out FlowLogic<*>>, om: ObjectMapper = yamlInputMapper): FlowStateMachine<*> +

Given a FlowLogic class and a string in one-line Yaml form, finds an applicable constructor and starts +the flow, returning the created flow logic. Useful for lightweight invocation where text is preferable +to statically typed, compiled code.

+
+runRPCFromString +fun runRPCFromString(input: List<String>, out: RenderPrintWriter, context: InvocationContext<out Any>): Any?
+startShell +fun startShell(dir: Path, runLocalShell: Boolean, runSSHServer: Boolean, node: Node): Unit +

Starts an interactive shell connected to the local terminal. This shell gives administrator access to the node +internals.

+
+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-by-name-fragment.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-by-name-fragment.html new file mode 100644 index 0000000000..5d0f55ec17 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-by-name-fragment.html @@ -0,0 +1,18 @@ + + + +InteractiveShell.runFlowByNameFragment - corda + + + +corda / net.corda.node / InteractiveShell / runFlowByNameFragment
+
+

runFlowByNameFragment

+ +@JvmStatic fun runFlowByNameFragment(nameFragment: String, inputData: String, output: RenderPrintWriter): Unit +

Called from the 'flow' shell command. Takes a name fragment and finds a matching flow, or prints out +the list of options if the request is ambiguous. Then parses inputData as constructor arguments using +the runFlowFromString method and starts the requested flow using the ANSIProgressRenderer to draw +the progress tracker. Ctrl-C can be used to cancel.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-from-string.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-from-string.html new file mode 100644 index 0000000000..a1318094e9 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-flow-from-string.html @@ -0,0 +1,22 @@ + + + +InteractiveShell.runFlowFromString - corda + + + +corda / net.corda.node / InteractiveShell / runFlowFromString
+
+

runFlowFromString

+ +fun runFlowFromString(invoke: (FlowLogic<*>) -> FlowStateMachine<*>, inputData: String, clazz: Class<out FlowLogic<*>>, om: ObjectMapper = yamlInputMapper): FlowStateMachine<*> +

Given a FlowLogic class and a string in one-line Yaml form, finds an applicable constructor and starts +the flow, returning the created flow logic. Useful for lightweight invocation where text is preferable +to statically typed, compiled code.

+

See the StringToMethodCallParser class to learn more about limitations and acceptable syntax.

+

Exceptions

+ +

+NoApplicableConstructor - if no constructor could be found for the given set of types. + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-r-p-c-from-string.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-r-p-c-from-string.html new file mode 100644 index 0000000000..d451323b6a --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/run-r-p-c-from-string.html @@ -0,0 +1,14 @@ + + + +InteractiveShell.runRPCFromString - corda + + + +corda / net.corda.node / InteractiveShell / runRPCFromString
+
+

runRPCFromString

+ +@JvmStatic fun runRPCFromString(input: List<String>, out: RenderPrintWriter, context: InvocationContext<out Any>): Any? + + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/start-shell.html b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/start-shell.html new file mode 100644 index 0000000000..66cc9b4a0f --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-interactive-shell/start-shell.html @@ -0,0 +1,16 @@ + + + +InteractiveShell.startShell - corda + + + +corda / net.corda.node / InteractiveShell / startShell
+
+

startShell

+ +fun startShell(dir: Path, runLocalShell: Boolean, runSSHServer: Boolean, node: Node): Unit +

Starts an interactive shell connected to the local terminal. This shell gives administrator access to the node +internals.

+ + diff --git a/docs/build/html/api/kotlin/corda/net.corda.node/-l-o-g-s_-d-i-r-e-c-t-o-r-y_-n-a-m-e.html b/docs/build/html/api/kotlin/corda/net.corda.node/-l-o-g-s_-d-i-r-e-c-t-o-r-y_-n-a-m-e.html new file mode 100644 index 0000000000..ad58b6d4a1 --- /dev/null +++ b/docs/build/html/api/kotlin/corda/net.corda.node/-l-o-g-s_-d-i-r-e-c-t-o-r-y_-n-a-m-e.html @@ -0,0 +1,14 @@ + + + +LOGS_DIRECTORY_NAME - corda + + + +corda / net.corda.node / LOGS_DIRECTORY_NAME
+
+

LOGS_DIRECTORY_NAME

+ +val LOGS_DIRECTORY_NAME: String + +