com.marklogic.hub.deploy.commands

Class DeployHubDatabaseCommand

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.appdeployer.command.AbstractCommand

com.marklogic.appdeployer.command.databases.DeployDatabaseCommand

com.marklogic.hub.deploy.commands.DeployHubDatabaseCommand

All Implemented Interfaces:

com.marklogic.appdeployer.command.Command, com.marklogic.appdeployer.command.UndoableCommand

public class DeployHubDatabaseCommand
extends com.marklogic.appdeployer.command.databases.DeployDatabaseCommand

Extends ml-app-deployer's standard command for deploying a single database and adds DHF-specific functionality.

Field Summary

Fields inherited from class com.marklogic.appdeployer.command.AbstractCommand

payloadTokenReplacer

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

logger

Constructor Summary

Constructors

Constructor and Description
DeployHubDatabaseCommand(HubConfig hubConfig, java.io.File databaseFile, java.lang.String databaseFilename) In order for sorting to work correctly via DeployDatabaseCommandComparator, must call setDatabaseFile so that the parent getPayload method is able to find the correct File to read from.

Method Summary

Modifier and Type	Method and Description
void	execute(com.marklogic.appdeployer.command.CommandContext context)
protected java.lang.String	getPayload(com.marklogic.appdeployer.command.CommandContext context)
boolean	isRemoveSchemaAndTriggersDatabaseSettings()
protected com.fasterxml.jackson.databind.node.ObjectNode	mergePayloadWithEntityConfigFileIfItExists(com.marklogic.appdeployer.command.CommandContext context, com.fasterxml.jackson.databind.node.ObjectNode payloadNode) When either staging-database.json or final-database.json is processed (and in the case of staging-database.json, it could be under the hub config or user config directory), need to check to see if a same-named file is in the entity config directory, where entity-specific database configuration is written.
protected java.lang.String	preparePayloadBeforeSubmitting(com.marklogic.appdeployer.command.CommandContext context, java.lang.String payload)
void	setMergeEntityConfigFiles(boolean mergeEntityConfigFiles)
void	setMergeExistingArrayProperties(boolean mergeExistingArrayProperties)
void	setRemoveSchemaAndTriggersDatabaseSettings(boolean removeSchemaAndTriggersDatabaseSettings)

Methods inherited from class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand

buildDefaultDatabasePayload, buildDeployForestsCommand, buildPayload, buildPayloadForSaving, customForestsExist, deploySubDatabases, getDatabaseFilename, getDatabaseName, getDatabasesToNotUndeploy, getDeployForestsCommand, getForestDeleteLevel, getForestFilename, getForestsPerHost, getSuperDatabaseName, getUndoSortOrder, isCheckForCustomForests, isCreateDatabaseWithoutFile, isCreateForestsOnEachHost, isPostponeForestCreation, isSubDatabase, newDatabaseManageForDeleting, setCheckForCustomForests, setCreateDatabaseWithoutFile, setCreateForestsOnEachHost, setDatabaseFile, setDatabaseFilename, setDatabaseName, setDatabasesToNotUndeploy, setDeployDatabaseCommandFactory, setForestFilename, setForestsPerHost, setPayload, setPostponeForestCreation, setSubDatabase, setSuperDatabaseName, setUndoSortOrder, shouldCreateForests, toString, undo

Methods inherited from class com.marklogic.appdeployer.command.AbstractCommand

adjustPayloadBeforeSavingResource, adjustResourceManagerForPayload, afterResourceSaved, cmaEndpointExists, convertPayloadToObjectNode, convertXmlPayloadToJsonIfNecessary, copyFileToString, copyFileToString, deployConfiguration, determineDatabaseNameForDatabaseResourceDirectory, getBiPredicateForMergingResources, getContextKeyForResourcesToSave, getExecuteSortOrder, getPayloadParser, getResourceClassType, getResourceFilenameFilter, getResourceIdPropertyName, isStoreResourceIdsAsCustomTokens, isSupportsResourceMerging, listFilesInDirectory, logResourceDirectoryNotFound, mergeResources, readResourceFromFile, resourceMergingIsSupported, saveMergedResources, saveResource, saveResource, setExecuteSortOrder, setFilenamesToIgnore, setIncrementalMode, setPayloadTokenReplacer, setResourceClassType, setResourceFilenameFilter, setResourceFilenamesExcludePattern, setResourceFilenamesIncludePattern, setResourceIdPropertyName, setStoreResourceIdsAsCustomTokens, setSupportsResourceMerging, storeResourceInCommandContextMap, storeTokenForResourceId

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, wait, wait, wait

Methods inherited from interface com.marklogic.appdeployer.command.Command

getExecuteSortOrder

Constructor Detail

DeployHubDatabaseCommand

public DeployHubDatabaseCommand(HubConfig hubConfig,
                                java.io.File databaseFile,
                                java.lang.String databaseFilename)

In order for sorting to work correctly via DeployDatabaseCommandComparator, must call setDatabaseFile so that the parent getPayload method is able to find the correct File to read from.

Otherwise, if this class only has a filename, the parent getPayload method will check every ConfigDir to find a match, with the last one winning. In the case of DHF, that means the user config directory. This can be a problem, as a user is not likely to define schema-database/triggers-database in e.g. a staging-database.json file in the user config directory. That will then cause the ordering of database commands to be incorrect, which will likely cause an error when databases are deployed and they don't yet exist.

Parameters:

hubConfig - a hubConfig object

databaseFile - database file object

databaseFilename - name of the database file

Method Detail

execute

public void execute(com.marklogic.appdeployer.command.CommandContext context)

Specified by:

execute in interface com.marklogic.appdeployer.command.Command

Overrides:

execute in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand

getPayload

protected java.lang.String getPayload(com.marklogic.appdeployer.command.CommandContext context)

Overrides:

getPayload in class com.marklogic.appdeployer.command.databases.DeployDatabaseCommand

preparePayloadBeforeSubmitting

protected java.lang.String preparePayloadBeforeSubmitting(com.marklogic.appdeployer.command.CommandContext context,
                                                          java.lang.String payload)

mergePayloadWithEntityConfigFileIfItExists

protected com.fasterxml.jackson.databind.node.ObjectNode mergePayloadWithEntityConfigFileIfItExists(com.marklogic.appdeployer.command.CommandContext context,
                                                                                                    com.fasterxml.jackson.databind.node.ObjectNode payloadNode)
                                                                                             throws java.io.IOException

When either staging-database.json or final-database.json is processed (and in the case of staging-database.json, it could be under the hub config or user config directory), need to check to see if a same-named file is in the entity config directory, where entity-specific database configuration is written. If so, it needs to be merged in with the file being processed so that none of the entity configuration is lost.

Parameters:

payloadNode -

Returns:

Throws:

java.io.IOException

setMergeEntityConfigFiles

public void setMergeEntityConfigFiles(boolean mergeEntityConfigFiles)

setRemoveSchemaAndTriggersDatabaseSettings

public void setRemoveSchemaAndTriggersDatabaseSettings(boolean removeSchemaAndTriggersDatabaseSettings)

isRemoveSchemaAndTriggersDatabaseSettings

public boolean isRemoveSchemaAndTriggersDatabaseSettings()

setMergeExistingArrayProperties

public void setMergeExistingArrayProperties(boolean mergeExistingArrayProperties)