com.marklogic.hub.deploy

Class HubDeployer

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.hub.deploy.HubDeployer

public class HubDeployer
extends com.marklogic.client.ext.helper.LoggingObject

Handles additional hub deployment scenarios beyond what "mlDeploy" is used for.

Field Summary

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

logger

Constructor Summary

Constructors

Constructor and Description
HubDeployer()

Method Summary

Modifier and Type	Method and Description
protected void	addEntityConfigToConfigDirs(HubProject hubProject, com.marklogic.appdeployer.AppConfig appConfig) Because the hub-internal-config directory is excluded, the staging database won't be updated unless the user has a staging-database.json file in their ml-config directory.
protected java.util.List<com.marklogic.appdeployer.command.Command>	buildCommandsForDeveloper(HubConfig hubConfig)
protected java.util.List<com.marklogic.appdeployer.command.Command>	buildCommandsForReplica(HubConfig hubConfig)
protected java.util.List<com.marklogic.appdeployer.command.Command>	buildCommandsForSecurityAdmin()
protected java.util.regex.Pattern	buildPatternForDatabasesToUpdateIndexesFor() In a provisioned environment, only the databases defined by this pattern can be updated.
void	deployAsDeveloper(HubConfigImpl hubConfig) Deploys the portions of a DHF app that a data-hub-developer is permitted to deploy.
void	deployAsSecurityAdmin(HubConfigImpl hubConfig) Deploys the portions of a DHF app that a data-hub-security-admin is permitted to deploy.
void	deployToReplica(HubConfig hubConfig)
protected void	prepareAppConfigForDeployingToDhs(HubConfig hubConfig) The AppConfig object belonging to HubConfig can be configured based on known DHS environment settings.
protected void	removeHubInternalConfigFromConfigDirs(com.marklogic.appdeployer.AppConfig appConfig) The contents of hub-internal-config should have been deployed to DHS already via the DHF installer.
protected void	setKnownValuesForDhsDeployment(HubConfig hubConfig) Per DHFPROD-2897, these are known values in a DHS installation that can be set so that they override any changes the user may have made for their on-premise installation.
void	throwExceptionIfMarkLogicVersionIsInvalid(HubConfig hubConfig)

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

format

Methods inherited from class java.lang.Object

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

Constructor Detail

HubDeployer

public HubDeployer()

Method Detail

deployAsDeveloper

public void deployAsDeveloper(HubConfigImpl hubConfig)

Deploys the portions of a DHF app that a data-hub-developer is permitted to deploy.

Parameters:

hubConfig -

deployAsSecurityAdmin

public void deployAsSecurityAdmin(HubConfigImpl hubConfig)

Deploys the portions of a DHF app that a data-hub-security-admin is permitted to deploy.

Parameters:

hubConfig -

deployToReplica

public void deployToReplica(HubConfig hubConfig)

throwExceptionIfMarkLogicVersionIsInvalid

public void throwExceptionIfMarkLogicVersionIsInvalid(HubConfig hubConfig)

prepareAppConfigForDeployingToDhs

protected void prepareAppConfigForDeployingToDhs(HubConfig hubConfig)

The AppConfig object belonging to HubConfig can be configured based on known DHS environment settings. This minimizes the number of properties that a user needs to specify themselves - i.e. the user shouldn't be expected to configure all the properties that are known to be true about a DHS instance.

Parameters:

hubConfig -

removeHubInternalConfigFromConfigDirs

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

The contents of hub-internal-config should have been deployed to DHS already via the DHF installer. And it is expected that a user will have permission to deploy all of the resources in this directory.

Parameters:

appConfig -

addEntityConfigToConfigDirs

protected void addEntityConfigToConfigDirs(HubProject hubProject,
                                           com.marklogic.appdeployer.AppConfig appConfig)

Because the hub-internal-config directory is excluded, the staging database won't be updated unless the user has a staging-database.json file in their ml-config directory. That means that the indexes in entity-config won't be applied. To avoid this, the entity-config directory is added as a configDir.

Parameters:

hubProject -

appConfig -

setKnownValuesForDhsDeployment

protected void setKnownValuesForDhsDeployment(HubConfig hubConfig)

Per DHFPROD-2897, these are known values in a DHS installation that can be set so that they override any changes the user may have made for their on-premise installation.

Parameters:

hubConfig -

buildCommandsForSecurityAdmin

protected java.util.List<com.marklogic.appdeployer.command.Command> buildCommandsForSecurityAdmin()

buildCommandsForReplica

protected java.util.List<com.marklogic.appdeployer.command.Command> buildCommandsForReplica(HubConfig hubConfig)

buildCommandsForDeveloper

protected java.util.List<com.marklogic.appdeployer.command.Command> buildCommandsForDeveloper(HubConfig hubConfig)

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