Updated vault query API to address bugs.

Author: MrMatthewLayton

build.gradle

@@ -42,7 +42,7 @@ buildscript {
 }
 
 group 'io.onixlabs'
-version '2.0.0-rc4'
+version '2.0.0-rc5'
 
 subprojects {
     repositories {

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/Extensions.CordaRPCOps.kt

@@ -19,12 +19,23 @@ package io.onixlabs.corda.core.services
 import net.corda.core.contracts.ContractState
 import net.corda.core.messaging.CordaRPCOps
 
+/**
+ * Creates a vault service, bound to the specified [ContractState] type.
+ *
+ * @param T The underlying [ContractState] type to bind the vault service to.
+ * @param contractStateType The [Class] of the [ContractState] type to bind the vault service to.
+ * @return Returns a [VaultService] instance bound to the underlying [ContractState] type.
+ */
+fun <T : ContractState> CordaRPCOps.vaultServiceFor(contractStateType: Class<T>): VaultService<T> {
+    return VaultService.create(this, contractStateType)
+}
+
 /**
  * Creates a vault service, bound to the specified [ContractState] type.
  *
  * @param T The underlying [ContractState] type to bind the vault service to.
  * @return Returns a [VaultService] instance bound to the underlying [ContractState] type.
  */
 inline fun <reified T : ContractState> CordaRPCOps.vaultServiceFor(): VaultService<T> {
-    return VaultService.create(this)
+    return vaultServiceFor(T::class.java)
 }

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/Extensions.QueryDsl.kt

@@ -33,6 +33,7 @@ import net.corda.core.node.services.vault.Sort
  * @param sort The sorting which will be applied to the query.
  * @return Returns the [QueryCriteria] that was created using the Query DSL.
  */
+@QueryDslContext
 fun <T : ContractState> vaultQuery(
     contractStateType: Class<T>,
     stateStatus: Vault.StateStatus = Vault.StateStatus.UNCONSUMED,
@@ -60,6 +61,7 @@ fun <T : ContractState> vaultQuery(
  * @param sort The sorting which will be applied to the query.
  * @return Returns the [QueryCriteria] that was created using the Query DSL.
  */
+@QueryDslContext
 inline fun <reified T : ContractState> vaultQuery(
     stateStatus: Vault.StateStatus = Vault.StateStatus.UNCONSUMED,
     relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.RELEVANT,

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/Extensions.ServiceHub.kt

@@ -19,12 +19,23 @@ package io.onixlabs.corda.core.services
 import net.corda.core.contracts.ContractState
 import net.corda.core.node.ServiceHub
 
+/**
+ * Creates a vault service, bound to the specified [ContractState] type.
+ *
+ * @param T The underlying [ContractState] type to bind the vault service to.
+ * @param contractStateType The [Class] of the [ContractState] type to bind the vault service to.
+ * @return Returns a [VaultService] instance bound to the underlying [ContractState] type.
+ */
+fun <T : ContractState> ServiceHub.vaultServiceFor(contractStateType: Class<T>): VaultService<T> {
+    return VaultService.create(this, contractStateType)
+}
+
 /**
  * Creates a vault service, bound to the specified [ContractState] type.
  *
  * @param T The underlying [ContractState] type to bind the vault service to.
  * @return Returns a [VaultService] instance bound to the underlying [ContractState] type.
  */
 inline fun <reified T : ContractState> ServiceHub.vaultServiceFor(): VaultService<T> {
-    return VaultService.create(this)
+    return vaultServiceFor(T::class.java)
 }

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/QueryDsl.kt

@@ -30,7 +30,6 @@ import net.corda.core.node.services.vault.SortAttribute
 import net.corda.core.schemas.StatePersistable
 import kotlin.reflect.KProperty1
 import kotlin.reflect.jvm.javaType
-import kotlin.reflect.jvm.jvmErasure
 
 /**
  * Represents a DSL for building vault queries.
@@ -48,15 +47,16 @@ class QueryDsl<T : ContractState> internal constructor(
     val criteria: QueryCriteria get() = queryCriteria
     val paging: PageSpecification get() = page
     val sorting: Sort get() = sort
+    private val vaultCriteria: VaultQueryCriteria get() = queryCriteria as VaultQueryCriteria
 
     /**
      * Specifies the state status of the query.
      *
      * @param status The status of the [ContractState] instances to apply to the query.
      */
     @QueryDslContext
-    fun status(status: Vault.StateStatus) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withStatus(status)
+    fun stateStatus(status: Vault.StateStatus) {
+        queryCriteria = vaultCriteria.withStatus(status)
     }
 
     /**
@@ -66,7 +66,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun contractStateTypes(contractStateTypes: Set<Class<out T>>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withContractStateTypes(contractStateTypes)
+        queryCriteria = vaultCriteria.withContractStateTypes(contractStateTypes)
     }
 
     /**
@@ -86,7 +86,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun stateRefs(stateRefs: List<StateRef>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withStateRefs(stateRefs)
+        queryCriteria = vaultCriteria.withStateRefs(stateRefs)
     }
 
     /**
@@ -106,7 +106,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun notaries(notaries: List<AbstractParty>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withNotary(notaries)
+        queryCriteria = vaultCriteria.withNotary(notaries)
     }
 
     /**
@@ -126,7 +126,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun softLockingCondition(softLockingCondition: SoftLockingCondition) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withSoftLockingCondition(softLockingCondition)
+        queryCriteria = vaultCriteria.withSoftLockingCondition(softLockingCondition)
     }
 
     /**
@@ -136,7 +136,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun timeCondition(timeCondition: TimeCondition) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withTimeCondition(timeCondition)
+        queryCriteria = vaultCriteria.withTimeCondition(timeCondition)
     }
 
     /**
@@ -146,7 +146,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun relevancyStatus(relevancyStatus: Vault.RelevancyStatus) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withRelevancyStatus(relevancyStatus)
+        queryCriteria = vaultCriteria.withRelevancyStatus(relevancyStatus)
     }
 
     /**
@@ -156,7 +156,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun constraintTypes(constraintTypes: Set<Vault.ConstraintInfo.Type>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withConstraintTypes(constraintTypes)
+        queryCriteria = vaultCriteria.withConstraintTypes(constraintTypes)
     }
 
     /**
@@ -176,7 +176,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun constraints(constraints: Set<Vault.ConstraintInfo>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withConstraints(constraints)
+        queryCriteria = vaultCriteria.withConstraints(constraints)
     }
 
     /**
@@ -196,7 +196,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun participants(participants: List<AbstractParty>) {
-        queryCriteria = (queryCriteria as VaultQueryCriteria).withParticipants(participants)
+        queryCriteria = vaultCriteria.withParticipants(participants)
     }
 
     /**
@@ -216,7 +216,7 @@ class QueryDsl<T : ContractState> internal constructor(
      */
     @QueryDslContext
     fun linearIds(linearIds: List<UniqueIdentifier>) {
-        queryCriteria = queryCriteria.and(LinearStateQueryCriteria(linearId = linearIds))
+        queryCriteria = queryCriteria.and(LinearStateQueryCriteria(linearId = linearIds).withRootCriteria())
     }
 
     /**
@@ -229,14 +229,34 @@ class QueryDsl<T : ContractState> internal constructor(
         linearIds(linearIds.toList())
     }
 
+    /**
+     * Specifies the external identifiers to apply to the query criteria.
+     *
+     * @param externalIds The [String] instances to apply to the query criteria.
+     */
+    @QueryDslContext
+    fun externalIds(externalIds: List<String?>) {
+        queryCriteria = queryCriteria.and(LinearStateQueryCriteria(externalId = externalIds.filterNotNull()))
+    }
+
+    /**
+     * Specifies the external identifiers to apply to the query criteria.
+     *
+     * @param externalIds The [String] instances to apply to the query criteria.
+     */
+    @QueryDslContext
+    fun externalIds(vararg externalIds: String?) {
+        externalIds(externalIds.toList())
+    }
+
     /**
      * Specifies custom query criteria to apply to the parent query criteria.
      *
      * @param criteria The custom criteria to apply to the parent query criteria.
      */
     @QueryDslContext
     fun where(criteria: QueryCriteria) {
-        queryCriteria = queryCriteria.and(criteria)
+        queryCriteria = queryCriteria.and(criteria.withRootCriteria())
     }
 
     /**
@@ -248,7 +268,7 @@ class QueryDsl<T : ContractState> internal constructor(
     fun and(action: QueryDsl<T>.() -> Unit) {
         val queryDsl = QueryDsl<T>()
         action(queryDsl)
-        queryCriteria = queryCriteria.and(queryDsl.criteria)
+        queryCriteria = queryCriteria.and(queryDsl.criteria.withRootCriteria())
     }
 
     /**
@@ -260,7 +280,7 @@ class QueryDsl<T : ContractState> internal constructor(
     fun or(action: QueryDsl<T>.() -> Unit) {
         val queryDsl = QueryDsl<T>()
         action(queryDsl)
-        queryCriteria = queryCriteria.or(queryDsl.criteria)
+        queryCriteria = queryCriteria.or(queryDsl.criteria.withRootCriteria())
     }
 
     /**
@@ -327,4 +347,26 @@ class QueryDsl<T : ContractState> internal constructor(
     fun sortByDescending(property: KProperty1<out StatePersistable, *>) {
         sortBy(property, Sort.Direction.DESC)
     }
+
+    /**
+     * Copies properties of the root criteria to any sub-criteria.
+     */
+    private fun QueryCriteria.withRootCriteria(): QueryCriteria = when (this) {
+        is VaultQueryCriteria -> copy(
+            contractStateTypes = vaultCriteria.contractStateTypes,
+            relevancyStatus = vaultCriteria.relevancyStatus,
+            status = vaultCriteria.status
+        )
+        is LinearStateQueryCriteria -> copy(
+            contractStateTypes = vaultCriteria.contractStateTypes,
+            relevancyStatus = vaultCriteria.relevancyStatus,
+            status = vaultCriteria.status
+        )
+        is VaultCustomQueryCriteria<*> -> copy(
+            contractStateTypes = vaultCriteria.contractStateTypes,
+            relevancyStatus = vaultCriteria.relevancyStatus,
+            status = vaultCriteria.status
+        )
+        else -> this
+    }
 }

onixlabs-corda-core-workflow/src/main/kotlin/io/onixlabs/corda/core/services/VaultService.kt

@@ -44,10 +44,10 @@ class VaultService<T : ContractState> private constructor(
          * Creates a vault service from a [CordaRPCOps] instance.
          *
          * @param cordaRPCOps The [CordaRPCOps] instance from which to create a [VaultService] instance.
-         * @param contractStateClass The [Class] of the [ContractState] type to bind the vault service to.
+         * @param contractStateType The [Class] of the [ContractState] type to bind the vault service to.
          */
-        fun <T : ContractState> create(cordaRPCOps: CordaRPCOps, contractStateClass: Class<T>): VaultService<T> {
-            return VaultService(VaultAdapterCordaRPCOps(cordaRPCOps, contractStateClass), contractStateClass)
+        fun <T : ContractState> create(cordaRPCOps: CordaRPCOps, contractStateType: Class<T>): VaultService<T> {
+            return VaultService(VaultAdapterCordaRPCOps(cordaRPCOps, contractStateType), contractStateType)
         }
 
         /**
@@ -64,10 +64,10 @@ class VaultService<T : ContractState> private constructor(
          * Creates a vault service from a [ServiceHub] instance.
          *
          * @param serviceHub The [ServiceHub] instance from which to create a [VaultService] instance.
-         * @param contractStateClass The [Class] of the [ContractState] type to bind the vault service to.
+         * @param contractStateType The [Class] of the [ContractState] type to bind the vault service to.
          */
-        fun <T : ContractState> create(serviceHub: ServiceHub, contractStateClass: Class<T>): VaultService<T> {
-            return VaultService(VaultAdapterServiceHub(serviceHub, contractStateClass), contractStateClass)
+        fun <T : ContractState> create(serviceHub: ServiceHub, contractStateType: Class<T>): VaultService<T> {
+            return VaultService(VaultAdapterServiceHub(serviceHub, contractStateType), contractStateType)
         }
 
         /**