DriverDSL - corda

corda / net.corda.testing.driver / DriverDSL

# DriverDSL

`@DoNotImplement interface DriverDSL`

Underlying interface for the driver DSL. Do not instantiate directly, instead use the driver function.

### Properties

#### defaultNotaryHandle | Returns the NotaryHandle for the single notary on the network. Throws if there are none or more than one. `open val defaultNotaryHandle: NotaryHandle`
#### defaultNotaryIdentity | Returns the identity of the single notary on the network. Throws if there are none or more than one. `open val defaultNotaryIdentity: Party`
#### defaultNotaryNode | Returns a CordaFuture on the NodeHandle for the single-node notary on the network. Throws if there are no notaries or more than one, or if the notary is a distributed cluster. `open val defaultNotaryNode: CordaFuture<NodeHandle>`
#### notaryHandles | Returns a list of NotaryHandles matching the list of NotarySpecs passed into driver. `abstract val notaryHandles: List<NotaryHandle>`

### Functions

#### baseDirectory | Returns the base directory for a node with the given CordaX500Name. This method is useful if the base directory is needed before the node is started. `abstract fun baseDirectory(nodeName: CordaX500Name): Path`
#### nextPort | Returns the next port to use when instantiating test processes that must not conflict on the same machine `open fun nextPort(): Int`
#### startNode | Start a node using the default values of NodeParameters. `open fun startNode(): CordaFuture<NodeHandle>` Start a node using the parameter values of the given NodeParameters. `abstract fun startNode(parameters: NodeParameters): CordaFuture<NodeHandle>` Start a node. `open fun startNode(defaultParameters: NodeParameters = NodeParameters(), providedName: CordaX500Name? = defaultParameters.providedName, rpcUsers: List<User> = defaultParameters.rpcUsers, verifierType: VerifierType = defaultParameters.verifierType, customOverrides: Map<String, Any?> = defaultParameters.customOverrides, startInSameProcess: Boolean? = defaultParameters.startInSameProcess, maximumHeapSize: String = defaultParameters.maximumHeapSize, logLevelOverride: String? = defaultParameters.logLevelOverride): CordaFuture<NodeHandle>` `open fun startNode(defaultParameters: NodeParameters = NodeParameters(), providedName: CordaX500Name? = defaultParameters.providedName, rpcUsers: List<User> = defaultParameters.rpcUsers, verifierType: VerifierType = defaultParameters.verifierType, customOverrides: Map<String, Any?> = defaultParameters.customOverrides, startInSameProcess: Boolean? = defaultParameters.startInSameProcess, maximumHeapSize: String = defaultParameters.maximumHeapSize): CordaFuture<NodeHandle>`
#### startWebserver | Call startWebserver with a default maximumHeapSize. `open fun startWebserver(handle: NodeHandle): CordaFuture<WebserverHandle>` Starts a web server for a node `abstract fun startWebserver(handle: NodeHandle, maximumHeapSize: String): CordaFuture<WebserverHandle>`