com.marklogic.hub.impl

Class DataHubImpl

java.lang.Object

com.marklogic.hub.impl.DataHubImpl

All Implemented Interfaces:

DataHub

public class DataHubImpl
extends java.lang.Object
implements DataHub

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
static java.lang.String	MIN_UPGRADE_VERSION

Constructor Summary

Constructors

Constructor and Description
DataHubImpl(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
void	clearDatabase(java.lang.String database) Clears the database of all documents
void	clearUserModules() Removes user's modules from the modules db
java.util.List<com.marklogic.appdeployer.command.Command>	getCommandList()
java.lang.String	getPortInUseBy(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
void	install(HubDeployStatusListener listener) Installs the data hub configuration and server-side config files into MarkLogic
InstallInfo	isInstalled() Determines if the data hub is installed in MarkLogic
boolean	isPortInUse(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
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.HashMap	runPreInstallCheck() Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
java.util.HashMap	runPreInstallCheck(Versions versions) Runs the pre-install check for the datahub populating the object with variables necessary to perform the install.
void	setPortInUseBy(DatabaseKind kind, java.lang.String usedBy) Sets what appserver name is using the port
void	setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)
void	setServerVersion(java.lang.String serverVersion) Sets the server version holder on the datahub object - currently unused
void	setServerVersionOk(boolean serverVersionOk) Sets true or false if the server version is okay with this version of DHF
void	uninstall() Uninstalls the data hub configuration and server-side config files from MarkLogic
void	uninstall(HubDeployStatusListener listener) Uninstalls the data hub configuration and server-side config files from MarkLogic
void	updateIndexes() Updates the indexes in the database based on the project
boolean	upgradeHub() Upgrades the installed datahub on the server to this version of the DataHub
boolean	upgradeHub(java.util.List<java.lang.String> updatedFlows) Upgrades the hub based on list of provided updated flows.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.hub.DataHub

create

Field Detail

logger

protected final org.slf4j.Logger logger

MIN_UPGRADE_VERSION

public static java.lang.String MIN_UPGRADE_VERSION

Constructor Detail

DataHubImpl

public DataHubImpl(HubConfig hubConfig)

Method Detail

clearDatabase

public void clearDatabase(java.lang.String database)

Description copied from interface: DataHub

Clears the database of all documents

Specified by:

clearDatabase in interface DataHub

Parameters:

database - - the name of the database in string form

setServerManager

public void setServerManager(com.marklogic.mgmt.resource.appservers.ServerManager manager)

isInstalled

public InstallInfo isInstalled()

Description copied from interface: DataHub

Determines if the data hub is installed in MarkLogic

Specified by:

isInstalled in interface DataHub

Returns:

true if installed, false otherwise

isServerVersionValid

public boolean isServerVersionValid(java.lang.String versionString)

Description copied from interface: DataHub

Validates the MarkLogic server to ensure compatibility with the hub

Specified by:

isServerVersionValid in interface DataHub

Parameters:

versionString - - the version of the server to validate

Returns:

true if valid, false otherwise

initProject

public void initProject()

Description copied from interface: DataHub

Initializes the project on disk, creates scaffold project code

Specified by:

initProject in interface DataHub

clearUserModules

public void clearUserModules()

Description copied from interface: DataHub

Removes user's modules from the modules db

Specified by:

clearUserModules in interface DataHub

getCommandList

public java.util.List<com.marklogic.appdeployer.command.Command> getCommandList()

runPreInstallCheck

public java.util.HashMap runPreInstallCheck()

Description copied from interface: DataHub

Runs the pre-install check for the datahub populating the object with variables necessary to perform the install. This is used for running install.

Specified by:

runPreInstallCheck in interface DataHub

runPreInstallCheck

public java.util.HashMap runPreInstallCheck(Versions versions)

Description copied from interface: DataHub

Runs the pre-install check for the datahub populating the object with variables necessary to perform the install. This is used for running install.

Specified by:

runPreInstallCheck in interface DataHub

Parameters:

versions - - the versions that the check is to be run against

install

public void install()

Installs the data hub configuration and server-side config files into MarkLogic

Specified by:

install in interface DataHub

install

public void install(HubDeployStatusListener listener)

Installs the data hub configuration and server-side config files into MarkLogic

Specified by:

install in interface DataHub

Parameters:

listener - - the callback method to receive status updates

updateIndexes

public void updateIndexes()

Description copied from interface: DataHub

Updates the indexes in the database based on the project

Specified by:

updateIndexes in interface DataHub

uninstall

public void uninstall()

Uninstalls the data hub configuration and server-side config files from MarkLogic

Specified by:

uninstall in interface DataHub

uninstall

public void uninstall(HubDeployStatusListener listener)

Uninstalls the data hub configuration and server-side config files from MarkLogic

Specified by:

uninstall in interface DataHub

Parameters:

listener - - the callback method to receive status updates

isSafeToInstall

public boolean isSafeToInstall()

Description copied from interface: DataHub

Checks to make sure all the versions and database in a valid configuration with version check

Specified by:

isSafeToInstall in interface DataHub

Returns:

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

isPortInUse

public boolean isPortInUse(DatabaseKind kind)

Description copied from interface: DataHub

Checks to see if the port is in use

Specified by:

isPortInUse in interface DataHub

Parameters:

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

Returns:

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

setPortInUseBy

public void setPortInUseBy(DatabaseKind kind,
                           java.lang.String usedBy)

Description copied from interface: DataHub

Sets what appserver name is using the port

Specified by:

setPortInUseBy in interface DataHub

Parameters:

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

usedBy - - string name of what is using the port

getPortInUseBy

public java.lang.String getPortInUseBy(DatabaseKind kind)

Description copied from interface: DataHub

Returns name of what is using the port

Specified by:

getPortInUseBy in interface DataHub

Parameters:

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

Returns:

name of who using the port

isServerVersionOk

public boolean isServerVersionOk()

Description copied from interface: DataHub

Checks to see if the datahub and server versions are compatible

Specified by:

isServerVersionOk in interface DataHub

Returns:

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

setServerVersionOk

public void setServerVersionOk(boolean serverVersionOk)

Description copied from interface: DataHub

Sets true or false if the server version is okay with this version of DHF

Specified by:

setServerVersionOk in interface DataHub

Parameters:

serverVersionOk - - true if it compatible or false if it is not

getServerVersion

public java.lang.String getServerVersion()

Description copied from interface: DataHub

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

Specified by:

getServerVersion in interface DataHub

Returns:

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

setServerVersion

public void setServerVersion(java.lang.String serverVersion)

Description copied from interface: DataHub

Sets the server version holder on the datahub object - currently unused

Specified by:

setServerVersion in interface DataHub

Parameters:

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

upgradeHub

public boolean upgradeHub()
                   throws CantUpgradeException

Description copied from interface: DataHub

Upgrades the installed datahub on the server to this version of the DataHub

Specified by:

upgradeHub in interface DataHub

Returns:

true or false based on success of the upgrade

Throws:

CantUpgradeException - - exception thrown when an upgrade can't happen

upgradeHub

public boolean upgradeHub(java.util.List<java.lang.String> updatedFlows)
                   throws CantUpgradeException

Description copied from interface: DataHub

Upgrades the hub based on list of provided updated flows. All flows SHOULD be provided. The method without params will handle this automatically.

Specified by:

upgradeHub in interface DataHub

Returns:

boolean - false if upgrade fails for a reason other than an upgrade exception

Throws:

CantUpgradeException - - should the hub fail to upgrade for incompatibility reasons