ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-05 10:27:11 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-1572 - Create marker file to track initial registration status. (#3621) (#3883)

Browse Source 
[CORDA-1572] Create marker file to track initial registration status.
This commit is contained in:
Florian Friemel 2018-09-13 13:47:52 +01:00 committed by Katelyn Baker
parent cb4db31b3b
commit 8f2977eac2
1 changed files with 64 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
node/src/main/kotlin/net/corda/node/internal/NodeStartup.kt
View File

@ -3,6 +3,8 @@ package net.corda.node.internal
import com.jcabi.manifests.Manifests
import io.netty.channel.unix.Errors
import joptsimple.OptionException
import joptsimple.OptionParser
import joptsimple.util.PathConverter
import net.corda.core.internal.Emoji
import net.corda.core.internal.concurrent.thenMatch
import net.corda.core.internal.createDirectories
@ -23,6 +25,7 @@ import org.fusesource.jansi.Ansi
import org.fusesource.jansi.AnsiConsole
import org.slf4j.bridge.SLF4JBridgeHandler
import sun.misc.VMSupport
import java.io.File
import java.io.RandomAccessFile
import java.lang.management.ManagementFactory
import java.net.InetAddress
@ -37,6 +40,7 @@ open class NodeStartup(val args: Array<String>) {
private val logger by lazy { loggerFor<Node>() } // I guess this is lazy to allow for logging init, but why Node?
val LOGS_DIRECTORY_NAME = "logs"
val LOGS_CAN_BE_FOUND_IN_STRING = "Logs can be found in"
private val INITIAL_REGISTRATION_MARKER = ".initialregistration"
}
/**
@ -49,8 +53,8 @@ open class NodeStartup(val args: Array<String>) {
println("Corda will now exit...")
return false
}
val (argsParser, cmdlineOptions) = parseArguments()
val registrationMode = checkRegistrationMode()
val (argsParser, cmdlineOptions) = parseArguments(registrationMode)
// We do the single node check before we initialise logging so that in case of a double-node start it
// doesn't mess with the running node's logs.
enforceSingleNodeIsRunning(cmdlineOptions.baseDirectory)
@ -104,6 +108,8 @@ open class NodeStartup(val args: Array<String>) {
if (cmdlineOptions.nodeRegistrationConfig != null) {
// Null checks for [compatibilityZoneURL], [rootTruststorePath] and [rootTruststorePassword] has been done in [CmdLineOptions.loadConfig]
registerWithNetwork(conf, cmdlineOptions.nodeRegistrationConfig)
// At this point the node registration was succesfull. We can delete the marker file.
deleteNodeRegistrationMarker(cmdlineOptions.baseDirectory)
return true
}
logStartupInfo(versionInfo, cmdlineOptions, conf)
@ -140,6 +146,49 @@ open class NodeStartup(val args: Array<String>) {
return true
}
private fun checkRegistrationMode(): Boolean {
// Parse the command line args just to get the base directory. The base directory is needed to determine
// if the node registration marker file exists, _before_ we call NodeArgsParser.parse().
// If it does exist, we call NodeArgsParser with `--initial-registration` added to the argument list. This way
// we make sure that the initial registration is completed, even if the node was restarted before the first
// attempt to register succeeded and the node administrator forgets to specify `--initial-registration` upon
// restart.
val optionParser = OptionParser()
optionParser.allowsUnrecognizedOptions()
val baseDirectoryArg = optionParser
.accepts("base-directory", "The node working directory where all the files are kept")
.withRequiredArg()
.withValuesConvertedBy(PathConverter())
.defaultsTo(Paths.get("."))
val isRegistrationArg =
optionParser.accepts("initial-registration", "Start initial node registration with Corda network to obtain certificate from the permissioning server.")
val optionSet = optionParser.parse(*args)
val baseDirectory = optionSet.valueOf(baseDirectoryArg).normalize().toAbsolutePath()
// If the node was started with `--initial-registration`, create marker file.
// We do this here to ensure the marker is created even if parsing the args with NodeArgsParser fails.
val marker = File((baseDirectory / INITIAL_REGISTRATION_MARKER).toUri())
if (!optionSet.has(isRegistrationArg) && !marker.exists()) {
return false
}
try {
marker.createNewFile()
} catch (e: Exception) {
logger.warn("Could not create marker file for `--initial-registration`.", e)
}
return true
}
private fun deleteNodeRegistrationMarker(baseDir: Path) {
try {
val marker = File((baseDir / INITIAL_REGISTRATION_MARKER).toUri())
if (marker.exists()) {
marker.delete()
}
} catch (e: Exception) {
logger.warn("Could not delete the marker file that was created for `--initial-registration`.", e)
}
}
open protected fun preNetworkRegistration(conf: NodeConfiguration) = Unit
open protected fun createNode(conf: NodeConfiguration, versionInfo: VersionInfo): Node = Node(conf, versionInfo)
@ -251,16 +300,25 @@ open class NodeStartup(val args: Array<String>) {
pidFileRw.write(ourProcessID.toByteArray())
}
private fun parseArguments(): Pair<ArgsParser, CmdLineOptions> {
private fun parseArguments(registrationMode: Boolean): Pair<ArgsParser, CmdLineOptions> {
val argsParser = ArgsParser()
val cmdlineOptions = try {
argsParser.parse(*args)
val cmdLineOptions = try {
if (registrationMode && !args.contains("--initial-registration")) {
"Node was started before with `--initial-registration`, but the registration was not completed.\nResuming registration.".let {
println(it)
logger.info(it)
}
// Pretend that the node was started with `--initial-registration` to help prevent user error.
argsParser.parse(*args.plus("--initial-registration"))
} else {
argsParser.parse(*args)
}
} catch (ex: OptionException) {
println("Invalid command line arguments: ${ex.message}")
argsParser.printHelp(System.out)
exitProcess(1)
}
return Pair(argsParser, cmdlineOptions)
return Pair(argsParser, cmdLineOptions)
}
open protected fun initLogging(cmdlineOptions: CmdLineOptions) {