com.marklogic.hub

Interface DataHub

All Known Implementing Classes:

DataHubImpl

public interface DataHub

Handles creation and orchastration of DHF with a MarkLogic server. Includes installs, version validation, updates, and the init of a DHF project.

Method Summary

Modifier and Type	Method and Description
void	clearUserModules() Removes user's modules from the modules db
FlowRunner	getFlowRunner() Creates and returns the FlowRunner object using the datahub's autowired hubconfig
java.lang.String	getPortInUseBy(com.marklogic.hub.DatabaseKind kind) Returns name of what is using the port
java.lang.String	getServerVersion() Returns the string presentation of the server version, eg: "9.03-1"
void	initProject() Initializes the project on disk, creates scaffold project code
void	install() Installs the data hub configuration and server-side config files into MarkLogic Must be run as a user with sufficient privileges to install a data hub.
InstallInfo	isInstalled() Determines if the data hub is installed in MarkLogic
boolean	isPortInUse(com.marklogic.hub.DatabaseKind kind) Checks to see if the port is in use
boolean	isSafeToInstall() Checks to make sure all the versions and database in a valid configuration with version check Must be run as a user with sufficient privileges to install a data hub.
boolean	isServerVersionOk() Checks to see if the datahub and server versions are compatible
boolean	isServerVersionValid(java.lang.String versionString) Validates the MarkLogic server to ensure compatibility with the hub
java.util.Map<java.lang.String,java.lang.Object>	runPreInstallCheck() Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
void	updateIndexes() Updates the indexes in the database based on the project Must be run as a user with flow-developer-role or equivalent
boolean	upgradeHub() Upgrades the installed datahub on the server to this version of the DataHub Must be run as a user with sufficient privileges to install a data hub.

Method Detail

isInstalled

InstallInfo isInstalled()

Determines if the data hub is installed in MarkLogic

Returns:

true if installed, false otherwise

isServerVersionValid

boolean isServerVersionValid(java.lang.String versionString)

Validates the MarkLogic server to ensure compatibility with the hub

Parameters:

versionString - - the version of the server to validate

Returns:

true if valid, false otherwise

Throws:

ServerValidationException - if the server is not compatible

initProject

void initProject()

Initializes the project on disk, creates scaffold project code

clearUserModules

void clearUserModules()

Removes user's modules from the modules db

runPreInstallCheck

java.util.Map<java.lang.String,java.lang.Object> runPreInstallCheck()

Runs the pre-install check for the datahub populating the object with variables necessary to perform the install. This is used for running install. Must be run as a user with sufficient privileges to install a data hub.

Returns:

- a hashmap of the results of the preinstall check

install

void install()

Installs the data hub configuration and server-side config files into MarkLogic Must be run as a user with sufficient privileges to install a data hub.

updateIndexes

void updateIndexes()

Updates the indexes in the database based on the project Must be run as a user with flow-developer-role or equivalent

isSafeToInstall

boolean isSafeToInstall()

Checks to make sure all the versions and database in a valid configuration with version check Must be run as a user with sufficient privileges to install a data hub.

Returns:

boolean - if not, returns false, if safe to proceed ahead returns true

isPortInUse

boolean isPortInUse(com.marklogic.hub.DatabaseKind kind)

Checks to see if the port is in use

Parameters:

kind - - the DatabaseKind enum value (ex STAGING or JOB)

Returns:

true if the port is in use, false if it is not

getPortInUseBy

java.lang.String getPortInUseBy(com.marklogic.hub.DatabaseKind kind)

Returns name of what is using the port

Parameters:

kind - - the DatabaseKind enum value (ex STAGING or JOB)

Returns:

name of who using the port

isServerVersionOk

boolean isServerVersionOk()

Checks to see if the datahub and server versions are compatible

Returns:

true if the server version matches, false if it does not

getServerVersion

java.lang.String getServerVersion()

Returns the string presentation of the server version, eg: "9.03-1"

Returns:

server version as a string, eg: "9.03-1"

upgradeHub

boolean upgradeHub()

Upgrades the installed datahub on the server to this version of the DataHub Must be run as a user with sufficient privileges to install a data hub.

Returns:

true or false based on success of the upgrade

getFlowRunner

FlowRunner getFlowRunner()

Creates and returns the FlowRunner object using the datahub's autowired hubconfig

Returns:

FlowRunner object with current hubconfig already set