A

AbstractConfirmableTask - Class in com.marklogic.gradle.task

Parent class for tasks that benefit from some confirmation in the way of requiring a property named "confirm" to be set to "true".

addCollections() - Method in AddCollectionsTask

AddCollectionsTask - Class in com.marklogic.gradle.task.datamovement

addHost() - Method in AddHostTask

AddHostTask - Class in com.marklogic.gradle.task.cluster

addPermissions() - Method in AddPermissionsTask

AddPermissionsTask - Class in com.marklogic.gradle.task.datamovement

apply(Project) - Method in MarkLogicPlugin

applyOnCollections(QueryBatchListener, String) - Method in DataMovementTask

Use runQueryBatcherJob instead.

applyOnUriPattern(QueryBatchListener, String) - Method in DataMovementTask

Use runQueryBatcherJob instead.

applyWithQueryBatcherBuilder(QueryBatchListener, QueryBatcherBuilder) - Method in DataMovementTask

Use runQueryBatcherJob instead.

assignHostsToGroups() - Method in AssignHostsToGroupsTask

AssignHostsToGroupsTask - Class in com.marklogic.gradle.task.hosts

B

buildCorbOptions() - Method in CorbTask

Construct CoRB2 options from the following sources: task variables - lowerCamelCase names that correspond to their CoRB2 option (i.e. optionsFile => OPTIONS-FILE) project properties - Project properties with the naming convention of a 'corb' prefix and CamelCased CoRB2 option name (i.e. corbOptionsFile => OPTIONS-FILE) System properties - Any System property with a CoRB2 option name

buildCreationXquery(String, String) - Method in CreateTriggersTask

buildMapOfRoxyProperties() - Method in RoxyMigratePropertiesTask

BuildStep - Class in com.marklogic.gradle.task.roxy

C

ClearContentDatabaseTask - Class in com.marklogic.gradle.task.databases

ClearDatabaseTask - Class in com.marklogic.gradle.task.databases

clearModules() - Method in ClearModulesDatabaseTask

clearModules() - Method in ClearTriggersDatabaseTask

clearModules() - Method in SetContentUpdatesAllowedTask

ClearModulesDatabaseTask - Class in com.marklogic.gradle.task.databases

clearSchemasDatabase() - Method in ClearSchemasDatabaseTask

ClearSchemasDatabaseTask - Class in com.marklogic.gradle.task.databases

ClearTriggersDatabaseTask - Class in com.marklogic.gradle.task.databases

collectCorbProjectProperties() - Method in CorbTask

For each of project properties specified with the convention corbXxxYyy, construct a CoRB2 option

collectMemberVariables() - Method in CorbTask

Inspect the Task member variables and convert into CoRB2 options

collectNormalizedOptions() - Method in CorbTask

Normalize corb task properties

collectSystemProperties() - Method in CorbTask

Collect all System.properties.

configureForestReplicas() - Method in ConfigureForestReplicasTask

ConfigureForestReplicasTask - Class in com.marklogic.gradle.task.forests

Task for executing an instance of ConfigureForestReplicasCommand.

constructText(Map) - Method in RoxyMigratePropertiesTask

First write the Roxy properties that can be mapped to ml-gradle properties.

copyBuildSteps() - Method in RoxyMigrateBuildStepsTask

copyBuildStepsToGradleFile(def) - Method in RoxyMigrateBuildStepsTask

copyGradlePropertiesToCustomTokensIfRequested(Project) - Method in MarkLogicPlugin

New in 3.2.0 - if mlPropsAsTokens is set to true, then all Gradle properties will be added to the AppConfig customTokens map with "%%" as a default prefix and suffix.

copyProperties() - Method in RoxyMigratePropertiesTask

copyRoxyFiles() - Method in RoxyMigrateFilesTask

CorbTask - Class in com.marklogic.gradle.task

CorbTask() - Constructor in CorbTask

createResource() - Method in CreateResourceTask

createResource() - Method in CreateTransformTask

createResourceFile(TemplateBuilder) - Method in NewResourceTask

Only properties starting with "ml-" are passed to the TemplateBuilder.

CreateResourceTask - Class in com.marklogic.gradle.task.client

CreateTransformTask - Class in com.marklogic.gradle.task.client

createTrigger(XccHelper, String, String) - Method in CreateTriggersTask

createTriggers() - Method in CreateTriggersTask

CreateTriggersTask - Class in com.marklogic.gradle.task.trigger

This is only needed for MarkLogic 8.0-3 and earlier - 8.0-4 supports triggers via the Management API.

D

DataMovementTask - Class in com.marklogic.gradle.task.datamovement

deleteAlertConfigs() - Method in DeleteAllAlertConfigsTask

DeleteAllAlertConfigsTask - Class in com.marklogic.gradle.task.alert

DeleteAllFlexrepConfigsTask - Class in com.marklogic.gradle.task.flexrep

deleteAllTasks() - Method in DeleteAllTasksTask

DeleteAllTasksTask - Class in com.marklogic.gradle.task.tasks

deleteCollection() - Method in DeleteCollectionTask

deleteCollections() - Method in DeleteCollectionsTask

DeleteCollectionsTask - Class in com.marklogic.gradle.task.datamovement

DeleteCollectionTask - Class in com.marklogic.gradle.task.databases

deleteFile() - Method in DeleteModuleTimestampsFileTask

deleteFlexrepConfigs() - Method in DeleteAllFlexrepConfigsTask

deleteForestReplicas() - Method in DeleteForestReplicasTask

DeleteForestReplicasTask - Class in com.marklogic.gradle.task.forests

Task for invoking "undo" on an instance of ConfigureForestReplicasCommand.

DeleteModuleTimestampsFileTask - Class in com.marklogic.gradle.task

deployAlerting() - Method in DeployAlertingTask

DeployAlertingTask - Class in com.marklogic.gradle.task.alert

deployAmps() - Method in DeployAmpsTask

DeployAmpsTask - Class in com.marklogic.gradle.task.security

deployApp() - Method in DeployAppTask

Use "-Pignore" to specify the short class names of ml-app-deployer commands to ignore.

DeployAppTask - Class in com.marklogic.gradle.task

deployCertificateAuthorities() - Method in DeployCertificateAuthoritiesTask

DeployCertificateAuthoritiesTask - Class in com.marklogic.gradle.task.security

deployCertificateTemplates() - Method in DeployCertificateTemplatesTask

DeployCertificateTemplatesTask - Class in com.marklogic.gradle.task.security

deployConfigurations() - Method in DeployConfigurationsTask

DeployConfigurationsTask - Class in com.marklogic.gradle.task.configuration

deployCpf() - Method in DeployCpfTask

deployCpf() - Method in DeployTemporalTask

DeployCpfTask - Class in com.marklogic.gradle.task.cpf

deployCustomForests() - Method in DeployCustomForestsTask

DeployCustomForestsTask - Class in com.marklogic.gradle.task.forests

deployDatabases() - Method in DeployDatabasesTask

DeployDatabasesTask - Class in com.marklogic.gradle.task.databases

deployExternalSecurity() - Method in DeployExternalSecurityTask

DeployExternalSecurityTask - Class in com.marklogic.gradle.task.security

deployFlexrep() - Method in DeployFlexrepTask

deployFlexrepAtPath() - Method in DeployFlexrepAtPathTask

DeployFlexrepAtPathTask - Class in com.marklogic.gradle.task.flexrep

DeployFlexrepTask - Class in com.marklogic.gradle.task.flexrep

deployForestReplicas() - Method in DeployForestReplicasTask

DeployForestReplicasTask - Class in com.marklogic.gradle.task.forests

deployGroups() - Method in DeployGroupsTask

DeployGroupsTask - Class in com.marklogic.gradle.task.groups

deployMimetypes() - Method in DeployMimetypesTask

DeployMimetypesTask - Class in com.marklogic.gradle.task.mimetypes

deployPrivileges() - Method in DeployPrivilegesTask

DeployPrivilegesTask - Class in com.marklogic.gradle.task.security

deployProtectedCollections() - Method in DeployProtectedCollectionsTask

DeployProtectedCollectionsTask - Class in com.marklogic.gradle.task.security

deployProtectedPaths() - Method in DeployProtectedPathsTask

DeployProtectedPathsTask - Class in com.marklogic.gradle.task.security

deployQueryRolesets() - Method in DeployQueryRolesetsTask

DeployQueryRolesetsTask - Class in com.marklogic.gradle.task.security

deployRoles() - Method in DeployRolesTask

DeployRolesTask - Class in com.marklogic.gradle.task.security

deploySecurity() - Method in DeploySecurityTask

DeploySecurityTask - Class in com.marklogic.gradle.task.security

deployServers() - Method in DeployServersTask

DeployServersTask - Class in com.marklogic.gradle.task.servers

deployTasks() - Method in DeployTasksTask

DeployTasksTask - Class in com.marklogic.gradle.task.tasks

DeployTemporalTask - Class in com.marklogic.gradle.task.temporal

deployTriggers() - Method in DeployTriggersTask

DeployTriggersTask - Class in com.marklogic.gradle.task.trigger

deployUsers() - Method in DeployUsersTask

DeployUsersTask - Class in com.marklogic.gradle.task.security

deployViewSchemas() - Method in DeployViewSchemasTask

DeployViewSchemasTask - Class in com.marklogic.gradle.task.viewschemas

deployWithCommandListProperty(String) - Method in MarkLogicTask

deployWithCommands(List<Command>) - Method in MarkLogicTask

disableAllFlexrepTargets() - Method in DisableAllFlexrepTargetsTask

DisableAllFlexrepTargetsTask - Class in com.marklogic.gradle.task.flexrep

disableAllTasks() - Method in DisableAllTasksTask

DisableAllTasksTask - Class in com.marklogic.gradle.task.tasks

disableSslFips() - Method in DisableSslFipsTask

disableSslFips() - Method in EnableSslFipsTask

DisableSslFipsTask - Class in com.marklogic.gradle.task.cluster

E

enableAllFlexrepTargets() - Method in EnableAllFlexrepTargetsTask

EnableAllFlexrepTargetsTask - Class in com.marklogic.gradle.task.flexrep

enableAllTasks() - Method in EnableAllTasksTask

EnableAllTasksTask - Class in com.marklogic.gradle.task.tasks

EnableSslFipsTask - Class in com.marklogic.gradle.task.cluster

exec() - Method in CorbTask

exec() - Method in MlcpTask

exec() - Method in ShellTask

executeIfConfirmed() - Method in AbstractConfirmableTask

executeIfConfirmed() - Method in ClearContentDatabaseTask

executeIfConfirmed() - Method in ClearDatabaseTask

executeIfConfirmed() - Method in UndeployAppTask

executeTask() - Method in AbstractConfirmableTask

executeXcc() - Method in XccTask

executeXquery(String) - Method in XccHelper

export(ResourceSelector) - Method in ExportResourcesTask

exportBatchesToDirectory() - Method in ExportBatchesToDirectoryTask

ExportBatchesToDirectoryTask - Class in com.marklogic.gradle.task.datamovement

exportBatchesToZips() - Method in ExportBatchesToZipsTask

ExportBatchesToZipsTask - Class in com.marklogic.gradle.task.datamovement

exportModules() - Method in ExportModulesTask

ExportModulesTask - Class in com.marklogic.gradle.task.datamovement

exportResources() - Method in ExportResourcesTask

ExportResourcesTask - Class in com.marklogic.gradle.task.export

exportToFile() - Method in ExportToFileTask

ExportToFileTask - Class in com.marklogic.gradle.task.datamovement

exportToZip() - Method in ExportToZipTask

ExportToZipTask - Class in com.marklogic.gradle.task.datamovement

exportWorkspaces() - Method in ExportWorkspacesTask

ExportWorkspacesTask - Class in com.marklogic.gradle.task.qconsole

extractBuildStepName(String) - Method in RoxyMigrateBuildStepsTask

Assumes e.g.

extractBuildSteps(String) - Method in RoxyMigrateBuildStepsTask

extractLogMessage(String) - Method in RoxyMigrateBuildStepsTask

We ignore the log message if it appears to do string concatenation, as odds are we can't resolve the variables.

F

G

generateModelArtifacts() - Method in GenerateModelArtifactsTask

GenerateModelArtifactsTask - Class in com.marklogic.gradle.task.es

generateScaffold() - Method in GenerateScaffoldTask

GenerateScaffoldTask - Class in com.marklogic.gradle.task.scaffold

generateTestSuite() - Method in GenerateUnitTestSuiteTask

GenerateUnitTestSuiteTask - Class in com.marklogic.gradle.task.test

GenerateUnitTestSuiteTask.CommandLineArguments - Class in com.marklogic.gradle.task.test

GenerateUnitTestSuiteTask.CommandLineArguments() - Constructor in GenerateUnitTestSuiteTask.CommandLineArguments

getAdminManager() - Method in MarkLogicTask

getAdminPassword() - Method in MarkLogicTask

getAdminUsername() - Method in MarkLogicTask

getAppConfig() - Method in MarkLogicTask

getAppDeployer() - Method in MarkLogicTask

getCommandContext() - Method in MarkLogicTask

getLogger() - Method in MlcpTask

getManageClient() - Method in MarkLogicTask

getProperties() - Method in ProjectPropertySource

Build the Properties instance each time this is called, ensuring we get the latest set of properties from the Gradle Project.

getProperty(String) - Method in ProjectPropertySource

getRoxyProjectPath() - Method in RoxyTask

getSampleTestsXqy() - Method in GenerateUnitTestSuiteTask

getSetupXqy() - Method in GenerateUnitTestSuiteTask

getSuiteSetupXqy() - Method in GenerateUnitTestSuiteTask

getSuiteTeardownXqy() - Method in GenerateUnitTestSuiteTask

getTeardownXqy() - Method in GenerateUnitTestSuiteTask

H

I

importWorkspaces() - Method in ImportWorkspacesTask

ImportWorkspacesTask - Class in com.marklogic.gradle.task.qconsole

initializeAppDeployerObjects(Project) - Method in MarkLogicPlugin

initializeMarkLogic() - Method in InitTask

InitTask - Class in com.marklogic.gradle.task.admin

installAdmin() - Method in InstallAdminTask

InstallAdminTask - Class in com.marklogic.gradle.task.admin

invokeDeployerCommandWithClassName(String) - Method in MarkLogicTask

J

K

L

loadDefaultPipelines() - Method in LoadDefaultPipelinesTask

LoadDefaultPipelinesTask - Class in com.marklogic.gradle.task.cpf

loadModules() - Method in LoadModulesTask

LoadModulesTask - Class in com.marklogic.gradle.task.client

loadSchemas() - Method in LoadSchemasTask

LoadSchemasTask - Class in com.marklogic.gradle.task.schemas

M

makeDirectory(String) - Method in NewProjectTask

MarkLogicPlugin - Class in com.marklogic.gradle

MarkLogicTask - Class in com.marklogic.gradle.task

Base class that provides easy access to all of the resources setup by MarkLogicPlugin.

mergeContentDatabase() - Method in MergeContentDatabaseTask

MergeContentDatabaseTask - Class in com.marklogic.gradle.task.databases

mergeDatabase() - Method in MergeDatabaseTask

MergeDatabaseTask - Class in com.marklogic.gradle.task.databases

MlcpTask - Class in com.marklogic.gradle.task

Delegates properties to an instance of MlcpBean, which has properties for all MLCP arguments (and if it's out of date and missing one, you can pass them via this class's args property that's inherited from JavaExec).

modifyCluster() - Method in ModifyClusterTask

ModifyClusterTask - Class in com.marklogic.gradle.task.cluster

N

NewAmpTask - Class in com.marklogic.gradle.task.scaffold

newAppDeployer(Project, CommandContext) - Method in MarkLogicPlugin

Creates an AppDeployer with a default set of commands.

newClient() - Method in MarkLogicTask

If the "database" property is set, then the DatabaseClient that's returned will use the App-Services port (defaults to 8000) to connect to the given database.

NewDatabaseTask - Class in com.marklogic.gradle.task.scaffold

NewExternalSecurityTask - Class in com.marklogic.gradle.task.scaffold

NewGroupTask - Class in com.marklogic.gradle.task.scaffold

NewPrivilegeTask - Class in com.marklogic.gradle.task.scaffold

newProject() - Method in NewProjectTask

NewProjectTask - Class in com.marklogic.gradle.task

NewProtectedCollectionTask - Class in com.marklogic.gradle.task.scaffold

newQueryBatcherTemplate(DatabaseClient) - Method in DataMovementTask

Use runQueryBatcherJob instead.

newResource() - Method in NewAmpTask

newResource() - Method in NewDatabaseTask

newResource() - Method in NewExternalSecurityTask

newResource() - Method in NewGroupTask

newResource() - Method in NewPrivilegeTask

newResource() - Method in NewProtectedCollectionTask

newResource() - Method in NewRoleTask

newResource() - Method in NewServerTask

newResource() - Method in NewTaskTask

newResource() - Method in NewUserTask

NewResourceTask - Class in com.marklogic.gradle.task.scaffold

NewRoleTask - Class in com.marklogic.gradle.task.scaffold

NewServerTask - Class in com.marklogic.gradle.task.scaffold

NewTaskTask - Class in com.marklogic.gradle.task.scaffold

NewUserTask - Class in com.marklogic.gradle.task.scaffold

O

P

prepareRestApiDependencies() - Method in PrepareRestApiDependenciesTask

PrepareRestApiDependenciesTask - Class in com.marklogic.gradle.task.client

Purpose of this task is to unzip each restApi dependency to the build directory and then register the path of each unzipped directory in AppConfig.modulePaths.

printCommands() - Method in PrintCommandsTask

PrintCommandsTask - Class in com.marklogic.gradle.task

printForestPlan() - Method in PrintForestPlanTask

PrintForestPlanTask - Class in com.marklogic.gradle.task.forests

printJobProperties(ConfigurableJob) - Method in DataMovementTask

printMissingPathMessage() - Method in RoxyTask

printProperties() - Method in PrintPropertiesTask

PrintPropertiesTask - Class in com.marklogic.gradle.task

printTokens() - Method in PrintTokensTask

PrintTokensTask - Class in com.marklogic.gradle.task

processTemplateString(def, def, def, def, def) - Method in GenerateUnitTestSuiteTask

ProjectPropertySource - Class in com.marklogic.gradle

TODO Would be nice to combine PropertySource and PropertiesSource, if possible.

ProjectPropertySource(Project) - Constructor in ProjectPropertySource

Q

R

reindexContentDatabase() - Method in ReindexContentDatabaseTask

ReindexContentDatabaseTask - Class in com.marklogic.gradle.task.databases

reindexDatabase() - Method in ReindexDatabaseTask

ReindexDatabaseTask - Class in com.marklogic.gradle.task.databases

removeCollections() - Method in RemoveCollectionsTask

RemoveCollectionsTask - Class in com.marklogic.gradle.task.datamovement

removeHost() - Method in RemoveHostTask

RemoveHostTask - Class in com.marklogic.gradle.task.cluster

removePermissions() - Method in RemovePermissionsTask

RemovePermissionsTask - Class in com.marklogic.gradle.task.datamovement

removeTrigger(XccHelper, String) - Method in CreateTriggersTask

restartCluster() - Method in RestartClusterTask

RestartClusterTask - Class in com.marklogic.gradle.task.cluster

RoxyMigrateBuildStepsTask - Class in com.marklogic.gradle.task.roxy

Does some hacky string parsing to try to convert custom build steps in the Roxy app_specific.rb file into custom Gradle tasks.

RoxyMigrateFilesTask - Class in com.marklogic.gradle.task.roxy

RoxyMigratePropertiesTask - Class in com.marklogic.gradle.task.roxy

RoxyTask - Class in com.marklogic.gradle.task.roxy

runQueryBatcherJob(QueryBatcherJob) - Method in DataMovementTask

runUnitTests() - Method in UnitTestTask

S

serverEval() - Method in ServerEvalTask

ServerEvalTask - Class in com.marklogic.gradle.task

setCollections() - Method in SetCollectionsTask

SetCollectionsTask - Class in com.marklogic.gradle.task.datamovement

SetContentUpdatesAllowedTask - Class in com.marklogic.gradle.task.databases

setPermissions() - Method in SetPermissionsTask

SetPermissionsTask - Class in com.marklogic.gradle.task.datamovement

setTraceEvents() - Method in SetTraceEventsTask

SetTraceEventsTask - Class in com.marklogic.gradle.task.groups

ShellTask - Class in com.marklogic.gradle.task.shell

Convenience task for using ml-groovysh and setting up an API instance.

T

toGradleTask() - Method in BuildStep

U

undeployAmps() - Method in UndeployAmpsTask

UndeployAmpsTask - Class in com.marklogic.gradle.task.security

UndeployAppTask - Class in com.marklogic.gradle.task

undeployCertificateTemplates() - Method in UndeployCertificateTemplatesTask

UndeployCertificateTemplatesTask - Class in com.marklogic.gradle.task.security

undeployExternalSecurity() - Method in UndeployExternalSecurityTask

UndeployExternalSecurityTask - Class in com.marklogic.gradle.task.security

undeployMimetypes() - Method in UndeployMimetypesTask

UndeployMimetypesTask - Class in com.marklogic.gradle.task.mimetypes

undeployOtherServers() - Method in UndeployOtherServersTask

UndeployOtherServersTask - Class in com.marklogic.gradle.task.servers

undeployPrivileges() - Method in UndeployPrivilegesTask

UndeployPrivilegesTask - Class in com.marklogic.gradle.task.security

undeployProtectedCollections() - Method in UndeployProtectedCollectionsTask

UndeployProtectedCollectionsTask - Class in com.marklogic.gradle.task.security

undeployProtectedPaths() - Method in UndeployProtectedPathsTask

UndeployProtectedPathsTask - Class in com.marklogic.gradle.task.security

undeployQueryRolesets() - Method in UndeployQueryRolesetsTask

UndeployQueryRolesetsTask - Class in com.marklogic.gradle.task.security

undeployRoles() - Method in UndeployRolesTask

UndeployRolesTask - Class in com.marklogic.gradle.task.security

undeploySecurity() - Method in UndeploySecurityTask

UndeploySecurityTask - Class in com.marklogic.gradle.task.security

undeployTasks() - Method in UndeployTasksTask

UndeployTasksTask - Class in com.marklogic.gradle.task.tasks

undeployUsers() - Method in UndeployUsersTask

UndeployUsersTask - Class in com.marklogic.gradle.task.security

undeployWithCommandListProperty(String) - Method in MarkLogicTask

undeployWithCommands(List<Command>) - Method in MarkLogicTask

undeployWithCommandWithClassName(String) - Method in MarkLogicTask

UnitTestTask - Class in com.marklogic.gradle.task.test

Task for running test suites found by the marklogic-unit-test framework.

updateIndexes() - Method in UpdateIndexesTask

UpdateIndexesTask - Class in com.marklogic.gradle.task.databases

V

W

waitForTaskServer() - Method in WaitForTaskServerTask

WaitForTaskServerTask - Class in com.marklogic.gradle.task.tasks

Waits until the task server has no requests in progress.

watchModules() - Method in WatchTask

WatchTask - Class in com.marklogic.gradle.task.client

Runs an infinite loop, and each second, it loads any new/modified modules.

wrapInEval(String) - Method in CreateTriggersTask

writeFile(String, String) - Method in NewProjectTask

writeFile(String, String) - Method in RoxyMigrateBuildStepsTask

Used for backing up and then overwriting the Gradle build file.

writeFile(String, String) - Method in RoxyMigratePropertiesTask

X

XccHelper - Class in com.marklogic.gradle.xcc

XccHelper(ContentSource) - Constructor in XccHelper

XccTask - Class in com.marklogic.gradle.task

Simple task for easing the execution of ad hoc XQuery.

Y

Z

_