docs/net.corda.testing.driver/NodeParameters

NodeParameters

data class NodeParameters(val providedName: <Error class: unknown class>? = null, val rpcUsers: List<User> = emptyList(), val verifierType: VerifierType = VerifierType.InMemory, val customOverrides: Map<String, Any?> = emptyMap(), val startInSameProcess: Boolean? = null, val maximumHeapSize: String = System.getenv("DRIVER_NODE_MEMORY") ?: "512m", val additionalCordapps: Collection<TestCordapp> = emptySet(), val flowOverrides: Map<out Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>> = emptyMap(), val logLevelOverride: String? = null, val rpcAddress: <Error class: unknown class>? = null, val runMigration: Boolean = true, val systemProperties: Map<String, String> = emptyMap(), val legacyContracts: Collection<TestCordapp> = emptySet())

Parameters for creating a node for DriverDSL.startNode.

Constructors

NodeParameters

constructor()

Create a new node parameters object with default values. Each parameter can be specified with its wither method which returns a copy with that value.

constructor(providedName: <Error class: unknown class>?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String)

constructor(providedName: <Error class: unknown class>?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String, additionalCordapps: Collection<TestCordapp> = emptySet(), flowOverrides: Map<out Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>>)

constructor(providedName: <Error class: unknown class>? = null, rpcUsers: List<User> = emptyList(), verifierType: VerifierType = VerifierType.InMemory, customOverrides: Map<String, Any?> = emptyMap(), startInSameProcess: Boolean? = null, maximumHeapSize: String = System.getenv("DRIVER_NODE_MEMORY") ?: "512m", additionalCordapps: Collection<TestCordapp> = emptySet(), flowOverrides: Map<out Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>> = emptyMap(), logLevelOverride: String? = null, rpcAddress: <Error class: unknown class>? = null, runMigration: Boolean = true, systemProperties: Map<String, String> = emptyMap(), legacyContracts: Collection<TestCordapp> = emptySet())

Properties

additionalCordapps

val additionalCordapps: Collection<TestCordapp>

Additional TestCordapps that this node will have available, in addition to the ones common to all nodes managed by the DriverDSL.

customOverrides

val customOverrides: Map<String, Any?>

A map of custom node configuration overrides.

flowOverrides

val flowOverrides: Map<out Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>>

legacyContracts

val legacyContracts: Collection<TestCordapp>

logLevelOverride

val logLevelOverride: String? = null

log level to be passed as parameter to an out of process node. ERROR, WARN, INFO, DEBUG, TRACE. This overrides debug port log level argument.

maximumHeapSize

val maximumHeapSize: String

The maximum JVM heap size to use for the node. Defaults to 512 MB.

providedName

val providedName: <Error class: unknown class>? = null

Optional name of the node, which will be its legal name in Party. Defaults to something random. Note that this must be unique as the driver uses it as a primary key!

rpcAddress

val rpcAddress: <Error class: unknown class>? = null

optional override for RPC address on which node will be accepting RPC connections from the clients. Port provided must be vacant.

rpcUsers

val rpcUsers: List<User>

List of users who are authorised to use the RPC system. Defaults to a single user with all permissions.

runMigration

val runMigration: Boolean = true

startInSameProcess

val startInSameProcess: Boolean? = null

Determines if the node should be started inside the same process the Driver is running in. If null the Driver-level value will be used.

systemProperties

val systemProperties: Map<String, String>

verifierType

val verifierType: VerifierType

The type of transaction verifier to use. See: VerifierType

Functions

copy

fun copy(providedName: <Error class: unknown class>?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String, additionalCordapps: Collection<TestCordapp> = emptySet(), flowOverrides: Map<out Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>>): NodeParameters

withAdditionalCordapps

fun withAdditionalCordapps(additionalCordapps: Set<TestCordapp>): NodeParameters

withCustomOverrides

fun withCustomOverrides(customOverrides: Map<String, Any?>): NodeParameters

withFlowOverrides

fun withFlowOverrides(flowOverrides: Map<Class<out <Error class: unknown class><out <Error class: unknown class>>>, Class<out <Error class: unknown class><out <Error class: unknown class>>>>): NodeParameters

withLegacyContracts