ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-07 19:34:41 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Minor: improve javadocs in NodeInfo

Browse Source
This commit is contained in:
Mike Hearn 2017-09-26 17:17:58 +02:00
parent 8a842d1d53
commit d3e1a8e1c0
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
core/src/main/kotlin/net/corda/core/node/NodeInfo.kt
View File

@ -6,21 +6,34 @@ import net.corda.core.serialization.CordaSerializable
import net.corda.core.utilities.NetworkHostAndPort
/**
* Info about a network node that acts on behalf of some form of contract party.
* @param legalIdentitiesAndCerts is a non-empty list, where the first identity is assumed to be the default identity of the node.
* Information about a network node that acts on behalf of some party. NodeInfos can be found via the network map
* cache, accessible from a [net.corda.core.node.services.NetworkMapCache].
*
* @property addresses An ordered list of IP addresses/hostnames where the node can be contacted.
* @property legalIdentitiesAndCerts A non-empty list, where the first identity is assumed to be the default identity of the node.
* @property platformVersion An integer representing the set of protocol features the node supports. See the docsite
* for information on how the platform is versioned.
* @property serial An arbitrary number incremented each time the NodeInfo is changed. This is analogous to the same
* concept in DNS.
*/
// TODO We currently don't support multi-IP/multi-identity nodes, we only left slots in the data structures.
@CordaSerializable
data class NodeInfo(val addresses: List<NetworkHostAndPort>,
val legalIdentitiesAndCerts: List<PartyAndCertificate>,
val platformVersion: Int,
val serial: Long
) {
// TODO We currently don't support multi-IP/multi-identity nodes, we only left slots in the data structures.
init {
require(legalIdentitiesAndCerts.isNotEmpty()) { "Node should have at least one legal identity" }
}
@Transient private var _legalIdentities: List<Party>? = null
/**
* An ordered list of legal identities supported by this node. The node will always have at least one, so if you
* are porting code from earlier versions of Corda that expected a single party per node, just use the first item
* in the returned list.
*/
val legalIdentities: List<Party> get() {
return _legalIdentities ?: legalIdentitiesAndCerts.map { it.party }.also { _legalIdentities = it }
}