NodeParameters - corda

corda / net.corda.testing.driver / NodeParameters

# NodeParameters

`data class NodeParameters`

Parameters for creating a node for DriverDSL.startNode.

### Constructors

#### <init> | 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. `NodeParameters()``NodeParameters(providedName: CordaX500Name?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String)` `NodeParameters(providedName: CordaX500Name?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String, additionalCordapps: Collection<TestCordapp> = emptySet(), flowOverrides: Map<out Class<out FlowLogic<*>>, Class<out FlowLogic<*>>>)` Parameters for creating a node for DriverDSL.startNode. `NodeParameters(providedName: CordaX500Name? = 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 FlowLogic<*>>, Class<out FlowLogic<*>>> = emptyMap(), logLevelOverride: String? = null, rpcAddress: NetworkHostAndPort? = null)`

### Properties

#### additionalCordapps | Additional TestCordapps that this node will have available, in addition to the ones common to all nodes managed by the DriverDSL. `val additionalCordapps: Collection<TestCordapp>`
#### customOverrides | A map of custom node configuration overrides. `val customOverrides: Map<String, Any?>`
#### flowOverrides | `val flowOverrides: Map<out Class<out FlowLogic<*>>, Class<out FlowLogic<*>>>`
#### logLevelOverride | 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. `val logLevelOverride: String?`
#### maximumHeapSize | The maximum JVM heap size to use for the node. Defaults to 512 MB. `val maximumHeapSize: String`
#### providedName | 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! `val providedName: CordaX500Name?`
#### rpcAddress | optional override for RPC address on which node will be accepting RPC connections from the clients. Port provided must be vacant. `val rpcAddress: NetworkHostAndPort?`
#### rpcUsers | List of users who are authorised to use the RPC system. Defaults to a single user with all permissions. `val rpcUsers: List<User>`
#### startInSameProcess | 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. `val startInSameProcess: Boolean?`
#### verifierType | The type of transaction verifier to use. See: VerifierType `val verifierType: VerifierType`

### Functions

#### copy | `fun copy(providedName: CordaX500Name?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String): NodeParameters` `fun copy(providedName: CordaX500Name?, rpcUsers: List<User>, verifierType: VerifierType, customOverrides: Map<String, Any?>, startInSameProcess: Boolean?, maximumHeapSize: String, additionalCordapps: Collection<TestCordapp> = emptySet(), flowOverrides: Map<out Class<out FlowLogic<*>>, Class<out FlowLogic<*>>>): NodeParameters`
#### withAdditionalCordapps | `fun withAdditionalCordapps(additionalCordapps: Set<TestCordapp>): NodeParameters`
#### withCustomOverrides | `fun withCustomOverrides(customOverrides: Map<String, Any?>): NodeParameters`
#### withFlowOverrides | `fun withFlowOverrides(flowOverrides: Map<Class<out FlowLogic<*>>, Class<out FlowLogic<*>>>): NodeParameters`
#### withLogLevelOverride | `fun withLogLevelOverride(logLevelOverride: String?): NodeParameters`
#### withMaximumHeapSize | `fun withMaximumHeapSize(maximumHeapSize: String): NodeParameters`
#### withProvidedName | `fun withProvidedName(providedName: CordaX500Name?): NodeParameters`
#### withRpcUsers | `fun withRpcUsers(rpcUsers: List<User>): NodeParameters`
#### withStartInSameProcess | `fun withStartInSameProcess(startInSameProcess: Boolean?): NodeParameters`
#### withVerifierType | `fun withVerifierType(verifierType: VerifierType): NodeParameters`