com.marklogic.hub.cli

Class Installer

java.lang.Object

com.marklogic.hub.cli.Installer

public class Installer
extends java.lang.Object

Intended for installing and upgrading DHF via a command-line interface. It is expected to be run as the main class of the jar produced by the "bootJar" Gradle task.

To mimic how DHF is installed locally, this installer will first initialize a DHF project in the directory in which the installer is run. Properties will then be read from the gradle.properties and gradle-local.properties files that are generated.

Because those properties are not intended to suffice for installation - specifically, mlUsername and mlPassword are not expected to be set - a client can override any DHF property via JVM props when running the installer. For example:

java -DmlUsername=someuser -PmlPassword=somepassword -jar marklogic-data-hub-(version).jar

Constructor Summary

Constructors

Constructor and Description
Installer(DataHub dataHub, HubConfigImpl hubConfig)

Method Summary

Modifier and Type	Method and Description
protected void	initializeProject(java.io.File projectDir) The intended use case is that an executable DHF jar can be run from any directory, which means we need to first initialize a DHF project (specifically, generating the gradle.properties file) and then refresh HubConfig based on those properties and anything a client passed in via JVM props.
void	install(java.io.File projectDir)
static void	main(java.lang.String[] args)
protected com.fasterxml.jackson.databind.node.ObjectNode	readJsonFromFile(java.io.File file)
protected void	removeEmptyRangeIndexArrayFromFinalDatabaseFile(java.io.File projectDir) This is needed until DHFPROD-2547 is fixed.
protected void	removePasswordsFromUserFiles(java.io.File projectDir, HubConfigImpl hubConfig) If a user already exists, we don't want to overwrite its password.
protected void	writeJsonToFile(com.fasterxml.jackson.databind.node.ObjectNode node, java.io.File file)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Installer

public Installer(DataHub dataHub,
                 HubConfigImpl hubConfig)

Method Detail

main

public static void main(java.lang.String[] args)

install

public void install(java.io.File projectDir)

initializeProject

protected void initializeProject(java.io.File projectDir)

The intended use case is that an executable DHF jar can be run from any directory, which means we need to first initialize a DHF project (specifically, generating the gradle.properties file) and then refresh HubConfig based on those properties and anything a client passed in via JVM props.

Parameters:

projectDir -

removeEmptyRangeIndexArrayFromFinalDatabaseFile

protected void removeEmptyRangeIndexArrayFromFinalDatabaseFile(java.io.File projectDir)

This is needed until DHFPROD-2547 is fixed. The empty range index array will remove any user-defined range indexes, which will also cause a reindex.

removePasswordsFromUserFiles

protected void removePasswordsFromUserFiles(java.io.File projectDir,
                                            HubConfigImpl hubConfig)

If a user already exists, we don't want to overwrite its password.

readJsonFromFile

protected com.fasterxml.jackson.databind.node.ObjectNode readJsonFromFile(java.io.File file)

writeJsonToFile

protected void writeJsonToFile(com.fasterxml.jackson.databind.node.ObjectNode node,
                               java.io.File file)