Added sample project for deploying Redaction Rulesets using Gradle. Also included optional Gradle task for validating Redaction Rulesets anytime after deploying

Author: Bill Miller

examples/redaction-ruleset-project/.gitignore

@@ -0,0 +1,6 @@
+/bin
+.classpath
+.project
+/build
+.gradle
+.settings

examples/redaction-ruleset-project/README.md

@@ -0,0 +1,15 @@
+This project shows an example of how MarkLogic 9 Redaction Rulesets can be loaded into a schemas
+database from src/main/ml-schemas (the default path - this can be overridden via 
+mlSchemasPath). 
+
+Note that in order for this to work, the content-database.json file must specify the schema
+database that it's associated with. And in most cases, you'll want your own schemas database - not the default Schemas one - so schemas-database.json can be used to create own with a name based on mlAppName.
+
+Within each folder containing one or more Redaction Rulesets, you must provide a **collecitons.properties** and **permissions.properties** file.
+These files contain the definitions for the applicable collections to be applied to the rulesets as well as the document permissions.
+
+***Note***: Rulesets must have a .json or .xml file extension.
+
+See [Specifying collections and permissions](https://github.com/marklogic-community/ml-javaclient-util/wiki/Loading-files#specifying-collections-and-permissions) for information on how to appliy the collections and permission when the rulesets are loaded
+
+See [Redacting Document Content](http://docs.marklogic.com/guide/app-dev/redaction) for more information on redacting content

examples/redaction-ruleset-project/build.gradle

@@ -0,0 +1,60 @@
+buildscript {
+	repositories {
+		jcenter()
+		// Needed for corb dependency: XCC
+		maven { url "http://developer.marklogic.com/maven2/" }
+	}
+	dependencies {
+		//Needed for CorbTask to dynamicaly generate properties from CORB Options class
+		classpath 'com.marklogic:marklogic-corb:2.3.2'
+	}
+}
+
+plugins {
+	id "com.marklogic.ml-gradle" version "3.0.0"
+}
+
+repositories {
+	jcenter()
+
+	// Needed for corb dependency: XCC
+	maven { url "http://developer.marklogic.com/maven2/" }
+}
+
+configurations {
+	// This configuration captures the dependencies for running corb (Content Reprocessing in Bulk).
+	// This is only needed if you want to run corb via Gradle tasks.
+	// If you do, using com.marklogic.gradle.task.CorbTask is a useful starting point, as shown below.
+	corb
+}
+
+dependencies {
+	// required to run CoRB2
+	corb 'com.marklogic:marklogic-corb:2.3.2'
+	// optional
+	//corb 'org.jasypt:jasypt:1.9.2' // would be necessary to leverage JasyptDecrypter
+}
+
+/*
+ * ml-gradle adds an instance of com.marklogic.appdeployer.AppConfig to the Gradle project under the key "mlAppConfig".
+ * This instance can be modified to affect the behavior of ml-gradle.
+ */
+ext {
+	// mlAppConfig is an instance of com.marklogic.appdeployer.AppConfig
+	mlAppConfig {
+		// XCC URL for running corb task below and for creating triggers on pre-8.0-4 builds of MarkLogic
+		contentXccUrl = "xcc://${mlUsername}:${mlPassword}@${mlHost}:${mlRestPort}"
+	}
+}
+
+/*
+ * This optional task demonstrates validating redaction rules via a locally run CORB process.
+ * To execute this task simply run it after you have successfully deployed the redaction rulesets (via mlAppDeploy or mlLoadSchemas).
+ */
+task validateRedactionRulesetsAdhoc(type: com.marklogic.gradle.task.CorbTask) {
+	xccConnectionUri = contentXccUrl
+	urisModule = "src/main/ml-modules/ext/redaction-ruleset-validation/corb/redaction-rules-uris.xqy|ADHOC"
+	processModule = "src/main/ml-modules/ext/redaction-ruleset-validation/corb/validate-redaction-rules.xqy|ADHOC"
+
+}
+

examples/redaction-ruleset-project/gradle.properties

@@ -0,0 +1,5 @@
+mlHost=localhost
+mlAppName=redaction-project
+mlRestPort=8130
+mlUsername=admin
+mlPassword=admin

examples/redaction-ruleset-project/src/main/ml-config/databases/content-database.json

@@ -0,0 +1,4 @@
+{
+  "database-name": "%%DATABASE%%",
+  "schema-database": "%%SCHEMAS_DATABASE%%"
+}

examples/redaction-ruleset-project/src/main/ml-config/databases/schemas-database.json

@@ -0,0 +1,3 @@
+{
+  "database-name": "%%SCHEMAS_DATABASE%%"
+}

examples/redaction-ruleset-project/src/main/ml-modules/ext/redaction-ruleset-validation/corb/redaction-rules-uris.xqy

@@ -0,0 +1,10 @@
+xquery version "1.0-ml";
+
+let $uris :=
+	xdmp:invoke-function(
+		function() { cts:uris((), (), cts:directory-query("/redactionRules/")) },
+		<options xmlns="xdmp:eval">
+			<database>{xdmp:database("redaction-project-schemas")}</database>
+		</options>)
+
+return (count($uris), $uris)

examples/redaction-ruleset-project/src/main/ml-modules/ext/redaction-ruleset-validation/corb/validate-redaction-rules.xqy

@@ -0,0 +1,17 @@
+xquery version "1.0-ml";
+import module namespace rdt = "http://marklogic.com/xdmp/redaction" at "/MarkLogic/redaction.xqy";
+
+
+declare variable $URI external;
+
+let $collections :=
+	xdmp:invoke-function(
+		function() { xdmp:document-get-collections($URI) },
+		<options xmlns="xdmp:eval">
+			<database>{xdmp:database("redaction-project-schemas")}</database>
+		</options>)
+
+
+return rdt:rule-validate(($collections))
+
+

examples/redaction-ruleset-project/src/main/ml-schemas/redactionRules/collections.properties

@@ -0,0 +1,5 @@
+#Add one or more collecitons to add the ruleset to (comma separated)
+# Example: file.json=collection1,collection2
+
+ssn.json=security-rules,pii-rules
+email.json=security-rules,email-rules

examples/redaction-ruleset-project/src/main/ml-schemas/redactionRules/email.json

@@ -0,0 +1,12 @@
+{
+	"rule": {
+		"description": "hide email addresses",
+		"path": "//email",
+		"method": {
+			"function": "redact-email"
+		},
+		"options": {
+			"pattern": "partial"
+		}
+	}
+}