docs/net.corda.testing.node.internal/InternalDriverDSL

InternalDriverDSL

interface InternalDriverDSL : DriverDSL

Inheritors

Properties

Link copied to clipboard
Link copied to clipboard
open val defaultNotaryHandle: NotaryHandle

Returns the NotaryHandle for the single notary on the network. Throws if there are none or more than one.

Link copied to clipboard
open val defaultNotaryIdentity: Party

Returns the identity of the single notary on the network. Throws if there are none or more than one.

Link copied to clipboard
open val defaultNotaryNode: CordaFuture<NodeHandle>

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.

Link copied to clipboard
abstract val notaryHandles: List<NotaryHandle>

Returns a list of NotaryHandles matching the list of NotarySpecs passed into driver.

Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
abstract fun baseDirectory(nodeName: CordaX500Name): Path

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.

open fun baseDirectory(nodeName: String): Path
Link copied to clipboard
open fun nextPort(): Int

Returns the next port to use when instantiating test processes that must not conflict on the same machine

Link copied to clipboard
abstract fun <A> pollUntilNonNull(pollName: String, pollInterval: Duration = DEFAULT_POLL_INTERVAL, warnCount: Int = DEFAULT_WARN_COUNT, check: () -> A?): CordaFuture<A>

Polls a function until it returns a non-null value. Note that there is no timeout on the polling.

Link copied to clipboard
open fun pollUntilTrue(pollName: String, pollInterval: Duration = DEFAULT_POLL_INTERVAL, warnCount: Int = DEFAULT_WARN_COUNT, check: () -> Boolean): CordaFuture<Unit>

Polls the given function until it returns true.

Link copied to clipboard
abstract fun shutdown()
Link copied to clipboard
abstract fun start()
Link copied to clipboard
open fun startNode(): CordaFuture<NodeHandle>

Start a node using the default values of NodeParameters.

abstract fun startNode(parameters: NodeParameters): CordaFuture<NodeHandle>

Start a node using the parameter values of the given NodeParameters.

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>
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>

Start a node.

abstract fun startNode(parameters: NodeParameters = NodeParameters(), bytemanPort: Int? = null): CordaFuture<NodeHandle>
Link copied to clipboard
fun DriverDSL.startNode(providedName: CordaX500Name, devMode: Boolean, parameters: NodeParameters = NodeParameters()): CordaFuture<NodeHandle>
Link copied to clipboard
open fun startWebserver(handle: NodeHandle): CordaFuture<WebserverHandle>

Call startWebserver with a default maximumHeapSize.

abstract fun startWebserver(handle: NodeHandle, maximumHeapSize: String): CordaFuture<WebserverHandle>

Starts a web server for a node