Merge branch 'dev' of github.com:marklogic-community/ml-gradle into dev

# Conflicts:
#	examples/disconnected-project-using-plugins-and-gradlew/README.md

Author: Dermot Smyth

README.md

@@ -24,11 +24,11 @@ First, [install Gradle](https://gradle.org/install/).
 
 Then, in an empty directory, create a file named "build.gradle" with your favorite text editor and enter the following:
 
-    plugins { id "com.marklogic.ml-gradle" version "3.4.0" }
+    plugins { id "com.marklogic.ml-gradle" version "3.6.1" }
 
 Then run:
 
-    gradle mlNew
+    gradle mlNewProject
 
 This starts a project wizard to stub out files for your new application. You can accept all the defaults, but be sure to
 enter a valid port number for the "REST API port" question. ml-gradle will then print the following logging:

build.gradle

@@ -70,7 +70,7 @@ if (project.hasProperty("myBintrayUser")) {
   bintray {
     user = myBintrayUser
     key = myBintrayKey
-    publications = ['mainJava', 'sourcesJava', 'mavenJavadoc']
+    publications = ['mainJava', 'sourcesJava']
     pkg {
       repo = 'maven'
       name = project.name

examples/disconnected-project-using-plugins-and-gradlew/.gitignore

@@ -0,0 +1,2 @@
+build
+.gradle

examples/disconnected-project-using-plugins-and-gradlew/README.md

@@ -12,21 +12,22 @@ Summary of the steps required. See sections below for more detailed steps
 ```
 2. Copy zip (build/distributions/offline.zip) to desired location / server and unzip
 
-3. Run  disconnected tasks from unzip location
+3. Run disconnected tasks from unzip location
 ```
 ./gradlew mlDeploy -Pdisconnected=true
 ```
 
 
 ## Overview 
 
-An example of how to create a completely self-contained deployer zip that contains -
-1. All of the plugin / depencencies required to run the deployment (including ml-gradle)
-2. The gradle distribution
+An example of how to create a completely self-contained deployer zip that contains:
 
-Once the zip has been created, you only need Java to run the deployment tasks
+1. All of the plugin / dependencies required to run the deployment (including ml-gradle)
+2. The Gradle distribution
 
-This approach is useful when you need to create a package that does not require any external ressources (e.g. maven/gradle repositories) to perform deployment operations. 
+Once the zip has been created, you only need Java to run the deployment tasks.
+
+This approach is useful when you need to create a package that does not require any external resources (e.g. Maven/Gradle repositories) to perform deployment operations. 
 
 ## Requirements
 
@@ -36,18 +37,19 @@ This approach is useful when you need to create a package that does not require
 
 ## How it works 
 
-This project will -
-* Download all of the required dependencies (including plugins) into the 'build/offline/maven-repo' directory in the project.
-* Download the gradle binary distribution (zip) into the 'build/offline/gradle/wrapper' directory in the project
+This project will:
+
+* Download all of the required dependencies (including plugins) into the 'build/offline/maven-repo' directory in the project
+* Download the Gradle binary distribution (zip) into the 'build/offline/gradle/wrapper' directory in the project
 * Create an offline.zip in build/distributions that contains 
-    * the gradle project itsself
-    * all of the required depenencies 
-    * the gradle distribution that works with the gradlew executable
+    * the Gradle project itself
+    * all of the required dependencies 
+    * the Gradle distribution that works with the gradlew executable
 
 
 ## Usage 
 
-*NOTE:* It is important to use the gradlew executable as it will download the gradle distribution that will be encorporated into the self-contained deployer zip
+*NOTE:* It is important to use the gradlew executable as it will download the Gradle distribution that will be incorporated into the self-contained deployer zip.
 
 ## 1. Create the self-contained deployer zip
 
@@ -74,7 +76,7 @@ Copy the created offline.zip to the desired location and unzip
 unzip offline.zip  
 ```
 
-## 3. Execute disconnected the gradle tasks 
+## 3. Execute disconnected the Gradle tasks 
 
 From the directory that you have unzipped the offline.zip file into 
 
@@ -88,7 +90,7 @@ This will use the jars that you have already downloaded to 'build/offline/maven-
 
 **IMPORTANT**: If you want to include dependencies for a configuration (e.g. compile, runtime, mlcp etc), then you need to modify the 'downloadToProjectMavenRepo' task to include the relevant configuration. E.g. by adding 'configurations.compile.files' to the beginning of the task, all of the dependencies for the 'compile' task will be downloaded.
 
-E.g. (assuming you are using the java plugin), the configuration below will download all the compile and runtime dependencies that you have defined 
+E.g. (assuming you are using the Java plugin), the configuration below will download all the compile and runtime dependencies that you have defined: 
 
 ```
 task downloadToProjectMavenRepo(type: Copy) {
@@ -112,4 +114,4 @@ gradle -Dgradle.user.home=build/gradle-home makeOfflineZip
 4. Run  disconnected tasks from unzip location
 ```
 gradle mlDeploy -Pdisconnected=true
-```
+```

examples/disconnected-project-using-plugins-and-gradlew/build.gradle

@@ -1,75 +1,73 @@
 plugins {
-    id 'java' //optional - delete if not needed
-    id 'net.saliman.properties' version '1.4.6'
-    id 'com.marklogic.ml-gradle' version '3.7.1'
+	id 'java' //optional - delete if not needed
+	id 'net.saliman.properties' version '1.4.6'
+	id 'com.marklogic.ml-gradle' version '3.7.1'
 }
 
 repositories {
-    // To use gradle in disconnected mode, you just need to set the 'disconnected' property. E.g. gradle compileJava -Pdisconnected 
-    if ( project.hasProperty("disconnected") && !"FALSE".equalsIgnoreCase(disconnected)) {
-        println "Using offline repositories"
-        maven {url uri( projectMavenRepo ) }
-    } else {
-        println "Using online repositories"
-        jcenter()
-        maven { url "https://developer.marklogic.com/maven2/" }
-    }
+	// To use gradle in disconnected mode, you just need to set the 'disconnected' property. E.g. gradle compileJava -Pdisconnected
+	if (project.hasProperty("disconnected") && !"FALSE".equalsIgnoreCase(disconnected)) {
+		println "Using offline repositories"
+		maven { url uri(projectMavenRepo) }
+	} else {
+		println "Using online repositories"
+		jcenter()
+		maven { url "https://developer.marklogic.com/maven2/" }
+	}
 }
 
 configurations {
 	mlcp //example if you want to use mlcp. Delete otherwise
 }
 
 dependencies {
-    // sample java compile dependency. Remove if not required
-    compile 'com.marklogic:marklogic-xcc:9.0.4'
+	// sample java compile dependency. Remove if not required
+	compile 'com.marklogic:marklogic-xcc:9.0.4'
 
-    //sample mlcp dependency. Remove if not required
-    mlcp "com.marklogic:mlcp:9.0.5"
+	//sample mlcp dependency. Remove if not required
+	mlcp "com.marklogic:mlcp:9.0.5"
 }
 
-
-
 /**
  * START: Disconnected gradle tasks
  */
 gradle.taskGraph.whenReady { graph ->
-    if (graph.hasTask(downloadToProjectMavenRepo)) {
-        println project.gradle.gradleUserHomeDir
-        if (!project.gradle.gradleUserHomeDir.equals(new File(rootDir,projectGradleHome))) {
-            throw new GradleException("Please set the gradle user home property to $projectGradleHome on the gradle command line - e.g. \n " +
-            (System.getProperty("os.name").startsWith("Windows") ? "" : "./") +
-            "gradlew -Dgradle.user.home=$projectGradleHome <task_to_execute>")
-        }
-    }
+	if (graph.hasTask(downloadToProjectMavenRepo)) {
+		println project.gradle.gradleUserHomeDir
+		if (!project.gradle.gradleUserHomeDir.equals(new File(rootDir, projectGradleHome))) {
+			throw new GradleException("Please set the gradle user home property to $projectGradleHome on the gradle command line - e.g. \n " +
+				(System.getProperty("os.name").startsWith("Windows") ? "" : "./") +
+				"gradlew -Dgradle.user.home=$projectGradleHome <task_to_execute>")
+		}
+	}
 }
 
 task downloadToProjectMavenRepo(type: Copy) {
-    /* 
-     * Include any configuration dependencies here that you want to copy the dependencies for. 
-     * These are defined in the 'dependencies' block. E.g. you need to include 
-     * configurations.compile.files if you want your java 'compile' dependencies downloaded
-     */  
-    configurations.compile.files //includes 'java' compile dependencies. Remove if not needed
-    configurations.mlcp.files //includes 'mlcp' dependencies. Remove if not needed
-    
-    from new File(gradle.gradleUserHomeDir, 'caches/modules-2/files-2.1') // correct as of gradle 4.7
-    into new File(rootDir, projectMavenRepo)
-    eachFile {
-        List<String> parts = it.path.split('/')
-        it.path = (parts[0].replace('.','/') + '/' + parts[1]) + '/' + parts[2] + '/' + parts[4]
-    }
-    includeEmptyDirs false
+	/*
+	 * Include any configuration dependencies here that you want to copy the dependencies for.
+	 * These are defined in the 'dependencies' block. E.g. you need to include
+	 * configurations.compile.files if you want your java 'compile' dependencies downloaded
+	 */
+	configurations.compile.files //includes 'java' compile dependencies. Remove if not needed
+	configurations.mlcp.files //includes 'mlcp' dependencies. Remove if not needed
+
+	from new File(gradle.gradleUserHomeDir, 'caches/modules-2/files-2.1') // correct as of gradle 4.7
+	into new File(rootDir, projectMavenRepo)
+	eachFile {
+		List<String> parts = it.path.split('/')
+		it.path = (parts[0].replace('.', '/') + '/' + parts[1]) + '/' + parts[2] + '/' + parts[4]
+	}
+	includeEmptyDirs false
 }
 
 task makeOfflineZip(type: Zip, dependsOn: downloadToProjectMavenRepo) {
-  from rootDir
-  excludes = ['.tmp','.gradle','build/gradle-home','build/distributions','build/offline/gradle/wrapper/dists']
-  destinationDir(file('build/distributions'))
-  archiveName =  'offline.zip' 
-  doLast {
-    println "Created offline project zip at build/distributions/offline.zip"
-  }
+	from rootDir
+	excludes = ['.tmp', '.gradle', 'build/gradle-home', 'build/distributions', 'build/offline/gradle/wrapper/dists']
+	destinationDir(file('build/distributions'))
+	archiveName = 'offline.zip'
+	doLast {
+		println "Created offline project zip at build/distributions/offline.zip"
+	}
 }
 
 /**

examples/external-security/.gitignore

@@ -0,0 +1,2 @@
+gradle-local.properties
+.gradle

examples/external-security/README.md

@@ -0,0 +1,3 @@
+This project shows how to configure an external security and use it in an application server. 
+
+If you want to deploy using a user with external security you'll need to configure the Admin, App-Services and Manage servers ahead of time.

examples/external-security/build.gradle

@@ -0,0 +1,3 @@
+plugins {
+	id "com.marklogic.ml-gradle" version "3.6.0"
+}

examples/external-security/gradle.properties

@@ -0,0 +1,17 @@
+mlHost=localhost
+mlAppName=external-security-example
+mlRestPort=8141
+mlUsername=admin
+mlPassword=admin
+
+#leave blank if you do not want an External Security Configuration used for an application server
+cpExternalSecurity=example
+
+#the below is needed if you want to deploy with an external user 
+#basic is used in this example but kerberos-ticket could also be used
+mlRestAuthentication=basic
+mlAppServicesAuthentication=basic
+mlAdminAuthentication=basic
+mlManageAuthentication=basic
+
+