Vault Query API design (#522)

* Added queryBy(QueryCriteria) Vault API and Junit tests.

* Minor fix following rebase.

* Spit out Vault Query tests into separate source file.

* WIP

* Enable composition of QueryCriteria specifications.
Additional JUnit test cases to validate API.

* Added Deprecating annotations.
Added QueryCriteria for set of contractStateTypes

* Minor tweaks and additional JUnit test cases (chain of linear id)

* Added Java Junit tests and QueryCriteria builder support.

* Added API documentation (including coding snippets and examples).

* Added @JvmOverloads to QueryCriteria classes for easy of use from Java.

* Refactored QueryCriteria API to use composition via sealed data classes.

* Enable infix notation.

* Fixed typo.

* Clarified future work to enforce DB level permissioning.

* Moved PageSpec and Order from QueryCriteria to become parameters of Query itself.

* Moved PageSpec and Order from QueryCriteria to become parameters of Query itself.

* TokenType now specified as set of <Class> (was non extensible enum).

* Exposed new Vault Query API functions via RPC.

* Fixed compiler error in java test.

* Addressed a couple of minor PR review scomments from MH.

* Major updates following PR discussion and recommendations.

* All pagination and sorting arguments are optional (and constructed with sensible defaults).
Added Java helper functions for queryBy and trackBy interfaces.
Added Java trackBy unit tests.
Miscellaneous cleanup.

* Added Generic Index schema mapping and query support.

* Query criteria referencing Party now references a String (until Identity framework built out).
Added participants attribute to general query criteria.

* Fleshed our IndexCriteria including PR recommendation to define column aliases for index mappings.

* Removed all directly exposed API dependencies on requery.

* Updated documentation.

* Provide sensible defaults for all Query arguments.
Add RPC Java helpers and increase range of Vault Service helpers.

* Further improvements (upgrading notes) and updates to documentation.

* RST documentation updates.

* Updates to address RP latest set of review comments.

* Updates to address MH latest set of review comments.

* Updated to highlight use of VaultIndexQueryCriteria to directly reference a JPA-annotated entity (versus the indirect, explicitly mapped attribute to GenericIndexSchema approach)

* Aesthetic updates requested by MH

* Reverted Indexing approach: removed all references to VaultIndexedQueryCriteria and GenericVaultIndexSchemaV1 scheme.

* Final clean-up and minor updates prior to merge.

* Fixed compiler warnings (except deprecation warnings)

* Reverted all changes to Vault Schemas (except simple illustrative VaultLinearState used in VaultQueryTests)

* Reverted all changes to Vault Schemas (except simple illustrative VaultLinearState used in VaultQueryTests)

* Commented out @Deprecated annotations (as a hedge against us releasing M12 with the work half-done)

* Renamed RPC JavaHelper functions as RPCDispatcher does not allow more than one method with same name.

node-schemas/build.gradle

@@ -9,6 +9,7 @@ dependencies {
     compile project(':core')
     testCompile "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
     testCompile "junit:junit:$junit_version"
+    testCompile project(':test-utils')
 
     // Requery: SQL based query & persistence for Kotlin
     kapt "io.requery:requery-processor:$requery_version"

node-schemas/src/main/kotlin/net/corda/node/services/vault/schemas/VaultSchema.kt

@@ -4,6 +4,7 @@ import io.requery.*
 import net.corda.core.node.services.Vault
 import net.corda.core.schemas.requery.Requery
 import java.time.Instant
+import java.util.*
 
 object VaultSchema {
 
@@ -73,4 +74,20 @@ object VaultSchema {
         @get:Column(name = "lock_timestamp", nullable = true)
         var lockUpdateTime: Instant?
     }
+
+    /**
+     * The following entity is for illustration purposes only as used by VaultQueryTests
+     */
+    @Table(name = "vault_linear_states")
+    @Entity(model = "vault")
+    interface VaultLinearState : Persistable {
+
+        @get:Index("external_id_index")
+        @get:Column(name = "external_id")
+        var externalId: String
+
+        @get:Index("uuid_index")
+        @get:Column(name = "uuid", unique = true, nullable = false)
+        var uuid: UUID
+    }
 }

node-schemas/src/test/kotlin/net/corda/node/services/vault/schemas/VaultSchemaTest.kt

@@ -29,7 +29,6 @@ import org.junit.Before
 import org.junit.Test
 import rx.Observable
 import java.security.PublicKey
-import sun.misc.MessageUtils.where
 import java.time.Instant
 import java.util.*
 import java.util.concurrent.CountDownLatch