Folder ml-xcc-util into this project

Author: rjrudin

CHANGELOG.mdown

@@ -1,5 +1,9 @@
 # ml-gradle releases
 
+## 2.5
+
+* Added classes from ml-xcc-util
+
 ## 2.4
 
 * Repackaged to com.marklogic

build.gradle

@@ -11,11 +11,12 @@ targetCompatibility = "1.7"
 
 repositories {
   jcenter()
+  maven {url "http://developer.marklogic.com/maven2/"}
 }
 
 dependencies {
   compile 'com.marklogic:java-client-api:3.0.4'
-  compile 'com.marklogic:ml-xcc-util:2.2'
+  compile 'com.marklogic:marklogic-xcc:8.0.4'
   compile 'org.jdom:jdom2:2.0.5'
   compile 'org.springframework:spring-context:4.1.5.RELEASE'
   testCompile 'junit:junit:4+'
@@ -56,7 +57,7 @@ if (project.hasProperty("myBintrayUser")) {
       licenses = ['Apache-2.0']
       vcsUrl = 'https://github.com/rjrudin/' + project.name + '.git'
       version {
-        name = "2.4"
+        name = "2.5"
         released = new Date()
       }
     }

gradle.properties

@@ -11,4 +11,4 @@ javadocsDir=../gh-pages-marklogic-java/javadocs
 # 2.0.6 - #8 now supports loading rest-properties.json file
 # 2.0.7 - #8 Fix for not loading rest-properties.json when it's not been modified
 # 2.0.8 - Added TestServerModulesFinder
-version=2.4
+version=2.5

src/main/java/com/marklogic/xcc/template/AdhocQueryCallback.java

@@ -0,0 +1,25 @@
+package com.marklogic.xcc.template;
+
+import com.marklogic.xcc.AdhocQuery;
+import com.marklogic.xcc.Session;
+import com.marklogic.xcc.exceptions.RequestException;
+
+/**
+ * Simple callback for executing an adhoc query. Could be subclassed for a variety of queries, such as getting all the
+ * URIs in a collection or retrieving a single document.
+ */
+public class AdhocQueryCallback implements XccCallback<String> {
+
+    private String xquery;
+
+    public AdhocQueryCallback(String xquery) {
+        this.xquery = xquery;
+    }
+
+    @Override
+    public String execute(Session session) throws RequestException {
+        AdhocQuery q = session.newAdhocQuery(xquery);
+        return session.submitRequest(q).asString();
+    }
+
+}

src/main/java/com/marklogic/xcc/template/InsertContentCallback.java

@@ -0,0 +1,34 @@
+package com.marklogic.xcc.template;
+
+import java.io.File;
+
+import com.marklogic.xcc.Content;
+import com.marklogic.xcc.ContentCreateOptions;
+import com.marklogic.xcc.ContentFactory;
+import com.marklogic.xcc.DocumentFormat;
+import com.marklogic.xcc.Session;
+import com.marklogic.xcc.exceptions.RequestException;
+
+/**
+ * Simple callback for inserting a single document.
+ */
+public class InsertContentCallback implements XccCallback<Void> {
+
+    private String uri;
+    private File file;
+    private DocumentFormat format;
+
+    public InsertContentCallback(String uri, File file, DocumentFormat format) {
+        this.uri = uri;
+        this.file = file;
+        this.format = format;
+    }
+
+    public Void execute(Session session) throws RequestException {
+        ContentCreateOptions opts = new ContentCreateOptions();
+        opts.setFormat(format);
+        Content c = ContentFactory.newContent(uri, file, opts);
+        session.insertContent(c);
+        return null;
+    }
+}

src/main/java/com/marklogic/xcc/template/XccCallback.java

@@ -0,0 +1,13 @@
+package com.marklogic.xcc.template;
+
+import com.marklogic.xcc.Session;
+import com.marklogic.xcc.exceptions.RequestException;
+
+/**
+ * Spring-style callback interface that provides an open Session to an implementation, which then doesn't have to worry
+ * about how to open or close the Session.
+ */
+public interface XccCallback<T> {
+
+    public T execute(Session session) throws RequestException;
+}

src/main/java/com/marklogic/xcc/template/XccTemplate.java

@@ -0,0 +1,58 @@
+package com.marklogic.xcc.template;
+
+import java.net.URI;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.marklogic.xcc.ContentSource;
+import com.marklogic.xcc.ContentSourceFactory;
+import com.marklogic.xcc.Session;
+import com.marklogic.xcc.exceptions.RequestException;
+
+/**
+ * Spring-style Template class that handles instantiating an XCC Session and then closing it, allowing the Callback
+ * implementation to focus on what to do with the Session.
+ */
+public class XccTemplate {
+
+    protected final Logger logger = LoggerFactory.getLogger(getClass());
+
+    private ContentSource contentSource;
+
+    public XccTemplate(String uri) {
+        try {
+            contentSource = ContentSourceFactory.newContentSource(new URI(uri));
+            if (logger.isInfoEnabled()) {
+                String[] tokens = uri.split("@");
+                if (tokens.length > 1) {
+                    String hostAndPort = tokens[tokens.length - 1];
+                    logger.info("Will submit requests to XDBC server at " + hostAndPort);
+                }
+            }
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public <T> T execute(XccCallback<T> callback) {
+        Session session = contentSource.newSession();
+        try {
+            return callback.execute(session);
+        } catch (RequestException re) {
+            throw new RuntimeException(re);
+        } finally {
+            session.close();
+        }
+    }
+
+    /**
+     * Convenience method for executing any adhoc query.
+     * 
+     * @param xquery the XQuery statement to execute
+     * @return the response from MarkLogic as a String
+     */
+    public String executeAdhocQuery(String xquery) {
+        return execute(new AdhocQueryCallback(xquery));
+    }
+}