com.marklogic.hub.impl

Class DataHubImpl

java.lang.Object

com.marklogic.hub.impl.DataHubImpl

All Implemented Interfaces:

DataHub, org.springframework.beans.factory.InitializingBean

@Component
public class DataHubImpl
extends java.lang.Object
implements DataHub, org.springframework.beans.factory.InitializingBean

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
DataHubImpl()
DataHubImpl(com.marklogic.hub.HubClient hubClient) Only use this constructor for the clearUserData operation, which does not depend on a HubConfig.
DataHubImpl(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
java.util.Map<java.lang.String,java.util.List<com.marklogic.appdeployer.command.Command>>	buildCommandMap()
java.util.List<com.marklogic.appdeployer.command.Command>	buildListOfCommands()
protected java.util.regex.Pattern	buildPatternForDatabasesToUpdateIndexesFor() In a provisioned environment, only the databases defined by this pattern can be updated.
void	clearDatabase(java.lang.String database) Clears the database of all documents
void	clearUserArtifacts()
void	clearUserData() Clear "user data", which is anything that's not a user or hub artifact.
void	clearUserModules() Removes user's modules from the modules db
void	clearUserModules(java.util.List<java.lang.String> resourceNamesToNotDelete)
protected com.marklogic.mgmt.resource.appservers.ServerManager	constructServerManager(HubConfig hubConfig) Need to account for the group name in case the user has overridden the name of the "Default" group.
void	deleteDocument(java.lang.String uri, com.marklogic.hub.DatabaseKind databaseKind) Deletes document based on supplied doc uri in supplied database
protected void	disableSomeCmaUsage(com.marklogic.appdeployer.AppConfig appConfig) Turns off CMA for some resources that have bbugs in ML 9.0-7/8.
FlowRunner	getFlowRunner() Creates and returns the FlowRunner object using the datahub's autowired hubconfig
HubConfig	getHubConfig()
java.lang.String	getPortInUseBy(com.marklogic.hub.DatabaseKind kind) Returns name of what is using the port
java.util.List<com.marklogic.appdeployer.command.Command>	getSecurityCommandList()
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(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
protected void	prepareProjectBeforeUpgrading(HubProject hubProject, java.lang.String newDataHubVersion) The expectation is that a user has upgraded build.gradle to use a newer version of DHF but has not yet updated mlDHFVersion in gradle.properties.
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.
protected java.util.Map<java.lang.String,java.lang.Object>	runPreInstallCheck(com.marklogic.mgmt.resource.appservers.ServerManager serverManager) This overloaded version was added to facilitate mock testing - i.e.
void	setHubConfig(HubConfigImpl hubConfig)
void	setPortInUseBy(com.marklogic.hub.DatabaseKind kind, java.lang.String usedBy) Sets what appserver name is using the port
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	setVersions(Versions versions)
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() Note that this differs from how "mlUpdateIndexes" works in ml-gradle.
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.
protected void	verifyLocalProjectIs430OrGreater() Per DHFPROD-4912, instead of depending on mlDHFVersion, this logic takes advantage of the fact that the hub-internal-config triggers - including ml-dh-entity-create.json - had their permissions modified in the 4.3.0 release.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

DataHubImpl

public DataHubImpl()

DataHubImpl

public DataHubImpl(HubConfig hubConfig)

DataHubImpl

public DataHubImpl(com.marklogic.hub.HubClient hubClient)

Only use this constructor for the clearUserData operation, which does not depend on a HubConfig.

Parameters:

hubClient -

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

constructServerManager

protected com.marklogic.mgmt.resource.appservers.ServerManager constructServerManager(HubConfig hubConfig)

Need to account for the group name in case the user has overridden the name of the "Default" group.

Parameters:

hubConfig - hubConfig object

Returns:

constructed ServerManager object

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

getFlowRunner

public FlowRunner getFlowRunner()

Description copied from interface: DataHub

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

Specified by:

getFlowRunner in interface DataHub

Returns:

FlowRunner object with current hubconfig already set

isInstalled

public InstallInfo isInstalled()
                        throws org.springframework.web.client.ResourceAccessException

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

Throws:

org.springframework.web.client.ResourceAccessException

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

clearUserModules

public void clearUserModules(java.util.List<java.lang.String> resourceNamesToNotDelete)

Parameters:

resourceNamesToNotDelete - optional list of names of resources that should not be deleted; can be null; introduced for the sake of DHF tests so that marklogic-unit-test will not be deleted

clearUserArtifacts

public void clearUserArtifacts()

deleteDocument

public void deleteDocument(java.lang.String uri,
                           com.marklogic.hub.DatabaseKind databaseKind)

Description copied from interface: DataHub

Deletes document based on supplied doc uri in supplied database

Specified by:

deleteDocument in interface DataHub

Parameters:

uri - - document uri

databaseKind - - database type

buildListOfCommands

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

getSecurityCommandList

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

runPreInstallCheck

public java.util.Map<java.lang.String,java.lang.Object> 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. Must be run as a user with sufficient privileges to install a data hub.

Specified by:

runPreInstallCheck in interface DataHub

Returns:

- a hashmap of the results of the preinstall check

runPreInstallCheck

protected java.util.Map<java.lang.String,java.lang.Object> runPreInstallCheck(com.marklogic.mgmt.resource.appservers.ServerManager serverManager)

This overloaded version was added to facilitate mock testing - i.e. to be able to mock which ports are available.

Parameters:

serverManager -

Returns:

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

disableSomeCmaUsage

protected void disableSomeCmaUsage(com.marklogic.appdeployer.AppConfig appConfig)

Turns off CMA for some resources that have bbugs in ML 9.0-7/8.

Parameters:

appConfig -

updateIndexes

public void updateIndexes()

Note that this differs from how "mlUpdateIndexes" works in ml-gradle. This is not stripping out any "non-index" properties from each payload - it's just updating every database. This does however disable forest creation which speeds up the process so that the only calls made are to update the databases.

Specified by:

updateIndexes in interface DataHub

buildPatternForDatabasesToUpdateIndexesFor

protected java.util.regex.Pattern buildPatternForDatabasesToUpdateIndexesFor()

In a provisioned environment, only the databases defined by this pattern can be updated.

Returns:

database name pattern

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

buildCommandMap

public java.util.Map<java.lang.String,java.util.List<com.marklogic.appdeployer.command.Command>> buildCommandMap()

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 Must be run as a user with sufficient privileges to install a data hub.

Specified by:

isSafeToInstall in interface DataHub

Returns:

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

isPortInUse

public boolean isPortInUse(com.marklogic.hub.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(com.marklogic.hub.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(com.marklogic.hub.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()

Description copied from interface: DataHub

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.

Specified by:

upgradeHub in interface DataHub

Returns:

true or false based on success of the upgrade

verifyLocalProjectIs430OrGreater

protected void verifyLocalProjectIs430OrGreater()

Per DHFPROD-4912, instead of depending on mlDHFVersion, this logic takes advantage of the fact that the hub-internal-config triggers - including ml-dh-entity-create.json - had their permissions modified in the 4.3.0 release.

prepareProjectBeforeUpgrading

protected void prepareProjectBeforeUpgrading(HubProject hubProject,
                                             java.lang.String newDataHubVersion)
                                      throws java.io.IOException

The expectation is that a user has upgraded build.gradle to use a newer version of DHF but has not yet updated mlDHFVersion in gradle.properties. Thus, the value of mlDHFVersion is expected to be passed in here so that the backup path of hub-internal-config has the current version of DHF in its name.

Parameters:

hubProject -

newDataHubVersion -

Throws:

java.io.IOException

setHubConfig

public void setHubConfig(HubConfigImpl hubConfig)

getHubConfig

public HubConfig getHubConfig()

setVersions

public void setVersions(Versions versions)

clearUserData

public void clearUserData()

Clear "user data", which is anything that's not a user or hub artifact. Depends on the ability to clear the staging, final, and job databases. An error will be thrown if a user doesn't have the privilege to perform any of those operations. This is intentionally not exposed in the DataHub interface, as there's no use case yet for a client of this library to perform this operation. It can instead be accessed via Hub Central and Gradle.