com.marklogic.hub.deploy.commands

Class DeployDatabaseFieldCommand

java.lang.Object

com.marklogic.client.ext.helper.LoggingObject

com.marklogic.appdeployer.command.AbstractCommand

com.marklogic.appdeployer.command.AbstractUndoableCommand

com.marklogic.appdeployer.command.AbstractResourceCommand

com.marklogic.hub.deploy.commands.DeployDatabaseFieldCommand

All Implemented Interfaces:

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

public class DeployDatabaseFieldCommand
extends com.marklogic.appdeployer.command.AbstractResourceCommand

Per DHFPROD-2554, this command ensures that when it adds DHF-specific fields and range field indexes to the staging, final, and jobs databases, it will not drop any existing fields or range field indexes.

The reason that these fields are applied via an XML file is to avoid a bug specific to JSON files and the Manage API that is not yet fixed in ML 9.0-9.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployDatabaseFieldCommand.HubDatabaseManager

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
DeployDatabaseFieldCommand()

Method Summary

Modifier and Type	Method and Description
protected void	addExistingFields(com.marklogic.rest.util.Fragment newProps, com.marklogic.rest.util.Fragment existingProps)
protected java.lang.String	addExistingFieldsAndRangeFieldIndexes(java.lang.String payload, com.marklogic.mgmt.resource.ResourceManager dbManager)
protected void	addExistingRangeFieldIndexes(com.marklogic.rest.util.Fragment newProps, com.marklogic.rest.util.Fragment existingProps)
protected void	addExistingRangePathIndexes(com.marklogic.rest.util.Fragment newProps, com.marklogic.rest.util.Fragment existingProps)
protected java.lang.String	adjustPayloadBeforeSavingResource(com.marklogic.appdeployer.command.CommandContext context, java.io.File f, java.lang.String payload)
protected java.io.File[]	getResourceDirs(com.marklogic.appdeployer.command.CommandContext context)
protected com.marklogic.mgmt.resource.ResourceManager	getResourceManager(com.marklogic.appdeployer.command.CommandContext commandContext)
void	undo(com.marklogic.appdeployer.command.CommandContext context)

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

adjustPayloadBeforeDeletingResource, deleteResource, deployResourcesViaCma, execute, findResourceDirs, findResourceDirs, isDeleteResourcesOnUndo, isRestartAfterDelete, listFilesInDirectory, processExecuteOnResourceDir, processUndoOnResourceDir, saveMergedResourcesViaCma, setCatchExceptionOnDeleteFailure, setDeleteResourcesOnUndo, setRestartAfterDelete, useCmaForDeployingResources

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

getUndoSortOrder, setUndoSortOrder

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

adjustResourceManagerForPayload, afterResourceSaved, cmaEndpointExists, convertPayloadToObjectNode, convertXmlPayloadToJsonIfNecessary, copyFileToString, copyFileToString, deployConfiguration, determineDatabaseNameForDatabaseResourceDirectory, getBiPredicateForMergingResources, getContextKeyForResourcesToSave, getExecuteSortOrder, 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, toString, wait, wait, wait

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

getExecuteSortOrder

Constructor Detail

DeployDatabaseFieldCommand

public DeployDatabaseFieldCommand()

Method Detail

getResourceDirs

protected java.io.File[] getResourceDirs(com.marklogic.appdeployer.command.CommandContext context)

Specified by:

getResourceDirs in class com.marklogic.appdeployer.command.AbstractResourceCommand

getResourceManager

protected com.marklogic.mgmt.resource.ResourceManager getResourceManager(com.marklogic.appdeployer.command.CommandContext commandContext)

Specified by:

getResourceManager in class com.marklogic.appdeployer.command.AbstractResourceCommand

adjustPayloadBeforeSavingResource

protected java.lang.String adjustPayloadBeforeSavingResource(com.marklogic.appdeployer.command.CommandContext context,
                                                             java.io.File f,
                                                             java.lang.String payload)

Overrides:

adjustPayloadBeforeSavingResource in class com.marklogic.appdeployer.command.AbstractCommand

undo

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

Specified by:

undo in interface com.marklogic.appdeployer.command.UndoableCommand

Overrides:

undo in class com.marklogic.appdeployer.command.AbstractResourceCommand

addExistingFieldsAndRangeFieldIndexes

protected java.lang.String addExistingFieldsAndRangeFieldIndexes(java.lang.String payload,
                                                                 com.marklogic.mgmt.resource.ResourceManager dbManager)

addExistingFields

protected void addExistingFields(com.marklogic.rest.util.Fragment newProps,
                                 com.marklogic.rest.util.Fragment existingProps)

addExistingRangeFieldIndexes

protected void addExistingRangeFieldIndexes(com.marklogic.rest.util.Fragment newProps,
                                            com.marklogic.rest.util.Fragment existingProps)

addExistingRangePathIndexes

protected void addExistingRangePathIndexes(com.marklogic.rest.util.Fragment newProps,
                                           com.marklogic.rest.util.Fragment existingProps)