net.corda.node.internal

Class AbstractNode

SingletonSerializeAsToken

net.corda.node.internal.AbstractNode

All Implemented Interfaces:

SerializeAsToken

Direct Known Subclasses:

Node

public class AbstractNode
extends SingletonSerializeAsToken

A base node implementation that can be customised either for production (with real implementations that do real I/O), or a mock implementation suitable for unit test environments.

Marked as SingletonSerializeAsToken to prevent the invisible reference to AbstractNode in the ServiceHub accidentally sweeping up the Node into the Kryo checkpoint serialization via any flows holding a reference to ServiceHub.

Field Summary

Fields

Modifier and Type	Field and Description
NodeAttachmentService	attachments
CheckpointStorage	checkpointStorage
CordaPersistence	database
NodeInfo	info
MessagingService	network
StateMachineManager	smm

Constructor Summary

Constructors

Constructor and Description
AbstractNode(NodeConfiguration configuration, java.util.Set<net.corda.core.node.services.ServiceInfo> advertisedServices, java.time.Clock platformClock, org.apache.activemq.artemis.utils.ReusableLatch busyNodeLatch) A base node implementation that can be customised either for production (with real implementations that do real I/O), or a mock implementation suitable for unit test environments.

Method Summary

Modifier and Type	Method and Description
int	acceptableLiveFiberCountOnStop()
WorldMapLocation	findMyLocation()
java.security.KeyPair	generateKeyPair()
java.util.Set<net.corda.core.node.services.ServiceInfo>	getAdvertisedServices()
NodeAttachmentService	getAttachments()
org.apache.activemq.artemis.utils.ReusableLatch	getBusyNodeLatch()
CheckpointStorage	getCheckpointStorage()
NodeConfiguration	getConfiguration()
CordaPersistence	getDatabase()
kotlin.jvm.functions.Function0<java.lang.Object>	getDbCloser()
NetworkMapService	getInNodeNetworkMapService()
NodeInfo	getInfo()
org.slf4j.Logger	getLog()
MessagingService	getNetwork()
SingleMessageRecipient	getNetworkMapAddress()
com.google.common.util.concurrent.ListenableFuture<kotlin.Unit>	getNetworkMapRegistrationFuture() Completes once the node has successfully registered with the network map service
long	getNetworkMapSeq() Sequence number of changes sent to the network map service, when registering/de-registering this node.
java.util.Set<java.security.KeyPair>	getPartyKeys()
java.time.Clock	getPlatformClock()
int	getPlatformVersion()
java.util.List<net.corda.core.node.CordaPluginRegistry>	getPluginRegistries() Fetch CordaPluginRegistry classes registered in META-INF/services/net.corda.core.node.CordaPluginRegistry files that exist in the classpath
CordaRPCOps	getRpcOps() The implementation of the interface CordaRPCOps interface used by this node.
java.util.ArrayList<kotlin.jvm.functions.Function0>	getRunOnStop()
AffinityExecutor	getServerThread()
ServiceHubInternal	getServices()
StateMachineManager	getSmm()
boolean	getStarted() Set to true once AbstractNode.start has been successfully called.
com.google.common.util.concurrent.SettableFuture<kotlin.Unit>	get_networkMapRegistrationFuture()
void	initialiseDatabasePersistence(kotlin.jvm.functions.Function0<kotlin.Unit> insideTransaction)
<T extends SerializeAsToken> T	installCordaService(java.lang.Class<T> serviceClass) Use this method to install your Corda services in your tests. This is automatically done by the node when it starts up for all classes it finds which are annotated with interface CordaService.
<F extends FlowLogic<?>> rx.Observable<F>	internalRegisterFlowFactory(java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> initiatingFlowClass, InitiatedFlowFactory<? extends F> flowFactory, java.lang.Class<F> initiatedFlowClass, boolean track)
boolean	isPreviousCheckpointsPresent()
void	makeCoreNotaryService(ServiceType type, java.util.List<java.lang.Object> tokenizableServices)
IdentityService	makeIdentityService(java.security.cert.X509Certificate trustRoot, CertificateAndKeyPair clientCa, PartyAndCertificate legalIdentity)
KeyManagementService	makeKeyManagementService(IdentityService identityService)
MessagingService	makeMessagingService()
void	makeNetworkMapService()
java.util.List<net.corda.core.node.ServiceEntry>	makeServiceEntries() A service entry contains the advertised class ServiceInfo along with the service identity. The identity name is taken from the configuration or, if non specified, generated by combining the node's legal name and the service id.
WritableTransactionStorage	makeTransactionStorage()
TransactionVerifierService	makeTransactionVerifierService()
java.util.List<net.corda.core.utilities.NetworkHostAndPort>	myAddresses() Return list of node's addresses. It's overridden in MockNetwork as we don't have real addresses for MockNodes.
com.google.common.util.concurrent.ListenableFuture<kotlin.Unit>	noNetworkMapConfigured() This is overriden by the mock node implementation to enable operation without any network map service
PartyAndCertificate	obtainLegalIdentity()
java.security.KeyPair	obtainLegalIdentityKey()
<T extends FlowLogic<?>> rx.Observable<T>	registerInitiatedFlow(java.lang.Class<T> initiatedFlowClass) Use this method to register your initiated flows in your tests. This is automatically done by the node when it starts up for all class FlowLogic classes it finds which are annotated with interface InitiatedBy.
com.google.common.util.concurrent.ListenableFuture<kotlin.Unit>	registerWithNetworkMap() Register this node with the network map cache, and load network map from a remote service (and register for updates) if one has been supplied.
void	setAttachments(NodeAttachmentService p)
void	setCheckpointStorage(CheckpointStorage p)
void	setDatabase(CordaPersistence p)
void	setDbCloser(kotlin.jvm.functions.Function0<? extends java.lang.Object> p)
void	setInNodeNetworkMapService(NetworkMapService p)
void	setInfo(NodeInfo p)
void	setNetwork(MessagingService p)
void	setNetworkMapSeq(long p) Sequence number of changes sent to the network map service, when registering/de-registering this node.
void	setSmm(StateMachineManager p)
void	start()
void	startMessagingService(RPCOps rpcOps)
void	stop()

Methods inherited from class net.corda.core.serialization.SingletonSerializeAsToken

toToken

Methods inherited from interface net.corda.core.serialization.SerializeAsToken

toToken

Field Detail

info

public NodeInfo info

checkpointStorage

public CheckpointStorage checkpointStorage

smm

public StateMachineManager smm

attachments

public NodeAttachmentService attachments

network

public MessagingService network

database

public CordaPersistence database

Constructor Detail

AbstractNode

public AbstractNode(NodeConfiguration configuration,
                    java.util.Set<net.corda.core.node.services.ServiceInfo> advertisedServices,
                    java.time.Clock platformClock,
                    org.apache.activemq.artemis.utils.ReusableLatch busyNodeLatch)

A base node implementation that can be customised either for production (with real implementations that do real I/O), or a mock implementation suitable for unit test environments.

Marked as SingletonSerializeAsToken to prevent the invisible reference to AbstractNode in the ServiceHub accidentally sweeping up the Node into the Kryo checkpoint serialization via any flows holding a reference to ServiceHub.

Method Detail

getNetworkMapSeq

public long getNetworkMapSeq()

Sequence number of changes sent to the network map service, when registering/de-registering this node.

setNetworkMapSeq

public void setNetworkMapSeq(long p)

Sequence number of changes sent to the network map service, when registering/de-registering this node.

getLog

public org.slf4j.Logger getLog()

getNetworkMapAddress

public SingleMessageRecipient getNetworkMapAddress()

getPlatformVersion

public int getPlatformVersion()

getServerThread

public AffinityExecutor getServerThread()

getPartyKeys

public java.util.Set<java.security.KeyPair> getPartyKeys()

getServices

public ServiceHubInternal getServices()

getInfo

public NodeInfo getInfo()

setInfo

public void setInfo(NodeInfo p)

getCheckpointStorage

public CheckpointStorage getCheckpointStorage()

setCheckpointStorage

public void setCheckpointStorage(CheckpointStorage p)

getSmm

public StateMachineManager getSmm()

setSmm

public void setSmm(StateMachineManager p)

getAttachments

public NodeAttachmentService getAttachments()

setAttachments

public void setAttachments(NodeAttachmentService p)

getInNodeNetworkMapService

public NetworkMapService getInNodeNetworkMapService()

setInNodeNetworkMapService

public void setInNodeNetworkMapService(NetworkMapService p)

getNetwork

public MessagingService getNetwork()

setNetwork

public void setNetwork(MessagingService p)

getRunOnStop

public java.util.ArrayList<kotlin.jvm.functions.Function0> getRunOnStop()

getDatabase

public CordaPersistence getDatabase()

setDatabase

public void setDatabase(CordaPersistence p)

getDbCloser

public kotlin.jvm.functions.Function0<java.lang.Object> getDbCloser()

setDbCloser

public void setDbCloser(kotlin.jvm.functions.Function0<? extends java.lang.Object> p)

isPreviousCheckpointsPresent

public boolean isPreviousCheckpointsPresent()

get_networkMapRegistrationFuture

public com.google.common.util.concurrent.SettableFuture<kotlin.Unit> get_networkMapRegistrationFuture()

getNetworkMapRegistrationFuture

public com.google.common.util.concurrent.ListenableFuture<kotlin.Unit> getNetworkMapRegistrationFuture()

Completes once the node has successfully registered with the network map service

getPluginRegistries

public java.util.List<net.corda.core.node.CordaPluginRegistry> getPluginRegistries()

Fetch CordaPluginRegistry classes registered in META-INF/services/net.corda.core.node.CordaPluginRegistry files that exist in the classpath

getStarted

public boolean getStarted()

Set to true once AbstractNode.start has been successfully called.

See Also:

AbstractNode.start

getRpcOps

public CordaRPCOps getRpcOps()

The implementation of the interface CordaRPCOps interface used by this node.

See Also:

interface CordaRPCOps

findMyLocation

public WorldMapLocation findMyLocation()

start

public void start()

installCordaService

public <T extends SerializeAsToken> T installCordaService(java.lang.Class<T> serviceClass)

Use this method to install your Corda services in your tests. This is automatically done by the node when it starts up for all classes it finds which are annotated with interface CordaService.

See Also:

interface CordaService

registerInitiatedFlow

public <T extends FlowLogic<?>> rx.Observable<T> registerInitiatedFlow(java.lang.Class<T> initiatedFlowClass)

Use this method to register your initiated flows in your tests. This is automatically done by the node when it starts up for all class FlowLogic classes it finds which are annotated with interface InitiatedBy.

Returns:

An Observable of the initiated flows started by counter-parties.

See Also:

class FlowLogic, interface InitiatedBy

internalRegisterFlowFactory

public <F extends FlowLogic<?>> rx.Observable<F> internalRegisterFlowFactory(java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> initiatingFlowClass,
                                                                             InitiatedFlowFactory<? extends F> flowFactory,
                                                                             java.lang.Class<F> initiatedFlowClass,
                                                                             boolean track)

makeTransactionStorage

public WritableTransactionStorage makeTransactionStorage()

makeServiceEntries

public java.util.List<net.corda.core.node.ServiceEntry> makeServiceEntries()

A service entry contains the advertised class ServiceInfo along with the service identity. The identity name is taken from the configuration or, if non specified, generated by combining the node's legal name and the service id.

See Also:

class ServiceInfo

acceptableLiveFiberCountOnStop

public int acceptableLiveFiberCountOnStop()

initialiseDatabasePersistence

public void initialiseDatabasePersistence(kotlin.jvm.functions.Function0<kotlin.Unit> insideTransaction)

registerWithNetworkMap

public com.google.common.util.concurrent.ListenableFuture<kotlin.Unit> registerWithNetworkMap()

Register this node with the network map cache, and load network map from a remote service (and register for updates) if one has been supplied.

myAddresses

public java.util.List<net.corda.core.utilities.NetworkHostAndPort> myAddresses()

Return list of node's addresses. It's overridden in MockNetwork as we don't have real addresses for MockNodes.

noNetworkMapConfigured

public com.google.common.util.concurrent.ListenableFuture<kotlin.Unit> noNetworkMapConfigured()

This is overriden by the mock node implementation to enable operation without any network map service

makeKeyManagementService

public KeyManagementService makeKeyManagementService(IdentityService identityService)

makeNetworkMapService

public void makeNetworkMapService()

makeCoreNotaryService

public void makeCoreNotaryService(ServiceType type,
                                  java.util.List<java.lang.Object> tokenizableServices)

makeIdentityService

public IdentityService makeIdentityService(java.security.cert.X509Certificate trustRoot,
                                           CertificateAndKeyPair clientCa,
                                           PartyAndCertificate legalIdentity)

makeTransactionVerifierService

public TransactionVerifierService makeTransactionVerifierService()

stop

public void stop()

makeMessagingService

public MessagingService makeMessagingService()

startMessagingService

public void startMessagingService(RPCOps rpcOps)

obtainLegalIdentity

public PartyAndCertificate obtainLegalIdentity()

obtainLegalIdentityKey

public java.security.KeyPair obtainLegalIdentityKey()

generateKeyPair

public java.security.KeyPair generateKeyPair()

getConfiguration

public NodeConfiguration getConfiguration()

getAdvertisedServices

public java.util.Set<net.corda.core.node.services.ServiceInfo> getAdvertisedServices()

getPlatformClock

public java.time.Clock getPlatformClock()

getBusyNodeLatch

public org.apache.activemq.artemis.utils.ReusableLatch getBusyNodeLatch()