Merge branch '4.1' into 4.0-master

Author: kkanthet

.github/CONTRIBUTING.md

@@ -0,0 +1,193 @@
+# Contributing to the Java Client API
+
+The Java Client API welcomes new contributors. This document will guide you 
+through the process.
+
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+ 
+## <a name="question"></a> Got a Question or Problem?
+
+If you have questions about how to use the Java Client API, you can ask on 
+[StackOverflow](http://stackoverflow.com/tags/marklogic), tagging the question 
+with MarkLogic.
+
+## <a name="issue"></a> Found an Issue?
+If you find a bug in the source code or a mistake in the documentation, you can help us by
+submitting an issue to our [GitHub Issue
+Tracker](https://github.com/marklogic/java-client-api/issues). Even better you
+can submit a Pull Request with a fix for the issue you filed.
+
+## <a name="feature"></a> Want a Feature?
+You can request a new feature by submitting an issue to our 
+[GitHub Issue Tracker](https://github.com/marklogic/java-client-api/issues).
+If you would like to implement a new feature then first create a new issue and
+discuss it with one of our project maintainers.
+
+## <a name="submit"></a> Submission Guidelines
+
+### Submitting an Issue
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Providing the following information will increase the chances of your issue 
+being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a stack trace helps
+* **Motivation for or Use Case** - explain why this is a bug for you
+* **Environment** - Mac, windows? Firefox, Chrome? details help
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point 
+to what might be causing the problem (line of code or commit)
+
+### Submitting a Pull Request
+
+#### Fill in the CLA
+
+Before we can accept your pull request, we need you to sign the [Contributor 
+License Agreement](http://developer.marklogic.com/products/cla). 
+
+#### Fork the Java Client API
+
+Fork the project [on GitHub](https://github.com/marklogic/java-client-api/fork) 
+and clone your copy.
+
+    $ git clone [email protected]:username/java-client-api.git
+    $ cd java-client-api
+    $ git remote add upstream git://github.com/marklogic/java-client-api.git
+
+All bug fixes and new features go into the
+[develop](https://github.com/marklogic/java-client-api/tree/develop) branch.
+
+We ask that you open an issue in the
+[issue tracker](https://github.com/marklogic/java-client-api/issues)
+and get agreement from at least one of the project maintainers before you start
+coding.
+
+Nothing is more frustrating than seeing your hard work go to waste because
+your vision does not align with that of a project maintainer.
+
+#### Choose the appropriate branch
+
+While the \*master branches reflect the latest released code for the
+corresponding server release, the \*develop branches reflect the latest changes
+that will be released next and are therefore the right place to commit changes.
+To be clear, the following branches have the assigned meaning:
+* develop - the place to make changes for the next release
+* master  - the stable code from the last release
+* 3.0-develop - the place to make changes for the next 3.x release (corresponds with the next server 8.x release)
+* 3.0-master  - the stable code from the last 3.x release (corresponds with the latest server 8.x release)
+* 2.0-develop - the place to make changes for the next 2.x release (corresponds with the next server 7.x release)
+* 2.0-master  - the stable code from the last 2.x release (corresponds with the latest server 7.x release)
+* 1.0-develop - the place to make changes for the next 1.x release (corresponds with the next server 6.x release)
+* 1.0-master  - the stable code from the last 1.x release (corresponds with the latest server 6.x release)
+
+#### Create a branch for your changes
+
+Okay, so you have decided to fix something. Create a feature branch
+and start hacking:
+
+    $ git checkout -b my-feature-branch -t origin/develop
+
+#### Commit your changes
+
+Make sure git knows your name and email address:
+
+    $ git config --global user.name "J. Random User"
+    $ git config --global user.email "[email protected]"
+
+Writing good commit logs is important. A commit log should describe what
+changed and why. Follow these guidelines when writing one:
+
+1. The first line should be 50 characters or less and contain a short
+   description of the change including the Issue number prefixed by a hash (#).
+2. Keep the second line blank.
+3. Wrap all other lines at 72 columns.
+
+A good commit log looks like this:
+
+```
+Fixing Issue #123: make the whatchamajigger work in MarkLogic 8
+
+Body of commit message is a few lines of text, explaining things
+in more detail, possibly giving some background about the issue
+being fixed, etc etc.
+
+The body of the commit message can be several paragraphs, and
+please do proper word-wrap and keep columns shorter than about
+72 characters or so. That way `git log` will show things
+nicely even when it is indented.
+```
+
+The header line should be meaningful; it is what other people see when they
+run `git shortlog` or `git log --oneline`.
+
+#### Rebase your repo
+
+Use `git rebase` (not `git merge`) to sync your work from time to time.
+
+    $ git fetch upstream
+    $ git rebase upstream/develop
+
+#### Test your code
+
+Be sure to run the tests before submitting your pull request. PRs with failing
+tests won't be accepted.
+
+First verify that you have valid server and admin auth info in
+`SERVER_ADMIN_USER` and `SERVER_ADMIN_PASS` fields in
+src/test/java/com/marklogic/client/test/Common.java
+
+    $ ./gradlew clean
+    $ ./gradlew testServerInit
+    $ ./gradlew test
+
+
+#### If your server is not on localhost
+
+You can either create SSH tunnels to your server on ports 8000, 8002, and 8012
+by a command like:
+
+    ssh -L 8000:localhost:8000 -L 8002:localhost:8002 -L 8012:localhost:8012 user@hostname
+
+Or you can update the static `HOST` field in
+src/test/java/com/marklogic/client/test/Common.java
+and the `example.host` property in src/main/resources/Example.properties.
+
+#### Push your changes
+
+    $ git push origin my-feature-branch
+
+#### Submit the pull request
+
+Go to https://github.com/username/java-client-api and select your feature 
+branch. Click the 'Pull Request' button and fill out the form.
+
+Pull requests are usually reviewed within a few days. If you get comments that 
+need to be to addressed, apply your changes in a separate commit and push that 
+to your feature branch. Post a comment in the pull request afterwards; GitHub 
+does not send out notifications when you add commits to existing pull requests.
+
+That's it! Thank you for your contribution!
+
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull 
+the changes from the main (upstream) repository:
+
+* Delete the remote branch on GitHub either through the GitHub web UI or your 
+local shell as follows:
+
+    $ git push origin --delete my-feature-branch
+
+* Check out the *develop* branch:
+
+    $ git checkout develop -f
+
+* Delete the local branch:
+
+    $ git branch -D my-feature-branch
+
+* Update your *develop* with the latest upstream version:
+
+    $ git pull --ff upstream develop

CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 4.1.0
+
+#### New Functionality
+- [#943](https://github.com/marklogic/java-client-api/issues/943) - Add base class for Proxy Services and integrate with the DatabaseClient
+- [#942](https://github.com/marklogic/java-client-api/issues/942) - Add value conversion utilities for Proxy Services
+- [#951](https://github.com/marklogic/java-client-api/issues/951) - Add utility to produce an SJS/Xquery main module from Proxy services function declaration
+
+#### Improvements and Bug Fixes
+- [881](https://github.com/marklogic/java-client-api/issues/881) - Added a BlockingRunsPolicy for rejected tasks for better threadpool utilization
+- [920](https://github.com/marklogic/java-client-api/issues/920) - Prevents QueryBatcher hang when you have a single thread
+- [971](https://github.com/marklogic/java-client-api/issues/971) - Passed the TrustManager to SSLContext so that the trust manager is taken into account
+
 ## 4.0.4
 
 #### New Functionality

README.md

@@ -60,7 +60,7 @@ To use the API in your maven project, include the following in your pom.xml:
     <dependency>
         <groupId>com.marklogic</groupId>
         <artifactId>marklogic-client-api</artifactId>
-        <version>4.0.4</version>
+        <version>4.1.0</version>
     </dependency>
 
 And add this repository to your pom.xml repositories section:
@@ -73,7 +73,7 @@ And add this repository to your pom.xml repositories section:
 For gradle projects, include the following:
 
     dependencies {
-        compile group: 'com.marklogic', name: 'marklogic-client-api', version: '4.0.4'
+        compile group: 'com.marklogic', name: 'marklogic-client-api', version: '4.1.0'
     }
 
 Use gradle 1.7+ and add this to your build.gradle repositories section:
@@ -102,14 +102,14 @@ https://developer.marklogic.com/free-developer
 
 To obtain verified downloads signed with MarkLogic's PGP key, use maven tools or directly download
 the .jar and .asc files from
-[maven central](http://repo1.maven.org/maven2/com/marklogic/marklogic-client-api/4.0.4/).  MarkLogic's
+[maven central](http://repo1.maven.org/maven2/com/marklogic/marklogic-client-api/4.1.0/).  MarkLogic's
 pgp key ID is 48D4B86E and it is available from pgp.mit.edu by installing gnupg and running the command:
 
     $ gpg --keyserver pgp.mit.edu --recv-key 48D4B86E
 
 Files can be verified with the command:
 
-    $ gpg marklogic-client-api-4.0.4.jar.asc
+    $ gpg marklogic-client-api-4.1.0.jar.asc
 
 
 ### Building and Contributing

gradle.properties

@@ -1,5 +1,5 @@
 group=com.marklogic
-version=4.0.4
-releaseVersion=4.0.4
+version=4.1.0
+releaseVersion=4.1.0
 describedName=MarkLogic Java Client API
 publishUrl=file:../marklogic-java/releases

marklogic-client-api-functionaltests/src/test/java/com/marklogic/client/datamovement/functionaltests/StringQueryHostBatcherTest.java

@@ -278,7 +278,7 @@ public void testAndWordQuery() throws Exception
    * 
    * @throws Exception
    */
-  @Test
+  @Ignore
   public void testAndWordQueryWithMultipleForests() throws Exception
   {
     String testMultipleDB = "QBMultipleForestDB";

marklogic-client-api-functionaltests/src/test/java/com/marklogic/client/functionaltest/TestOpticOnCtsQuery.java

@@ -66,7 +66,7 @@ public class TestOpticOnCtsQuery extends BasicJavaClientREST {
   private static String[] fNames = { "TestOpticOnCtsQueryDB-1" };
   private static String[] schemafNames = { "TestOpticOnCtsQuerySchemaDB-1" };
 
-  private static DatabaseClient client;
+  private static DatabaseClient client; 
   private static String datasource = "src/test/java/com/marklogic/client/functionaltest/data/optics/";
 
   @BeforeClass
@@ -129,14 +129,18 @@ public static void setUp() throws KeyManagementException, NoSuchAlgorithmExcepti
     createForest(schemafNames[0], schemadbName);
     // Set the schemadbName database as the Schema database.
     setDatabaseProperties(dbName, "schema-database", schemadbName);
+    
+    createUserRolesWithPrevilages("opticRole", "xdbc:eval", "xdbc:eval-in", "xdmp:eval-in", "any-uri", "xdbc:invoke");
+    createRESTUser("opticUser", "0pt1c", "tde-admin", "tde-view", "opticRole", "rest-admin", "rest-writer", 
+    		                             "rest-reader", "rest-extension-user", "manage-user");    
 
     if (IsSecurityEnabled()) {
-        schemaDBclient = getDatabaseClientOnDatabase(getRestServerHostName(), getRestServerPort(), schemadbName, "admin", "admin", Authentication.DIGEST);
-        client = getDatabaseClient("admin", "admin", Authentication.DIGEST);
+        schemaDBclient = getDatabaseClientOnDatabase(getRestServerHostName(), getRestServerPort(), schemadbName, "opticUser", "0pt1c", Authentication.DIGEST);
+        client = getDatabaseClient("opticUser", "0pt1c", Authentication.DIGEST);
     }
     else {
-        schemaDBclient = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), schemadbName, new DigestAuthContext("admin", "admin"));
-        client = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), new DigestAuthContext("admin", "admin"));
+        schemaDBclient = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), schemadbName, new DigestAuthContext("opticUser", "0pt1c"));
+        client = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), new DigestAuthContext("opticUser", "0pt1c"));
     }
 
     // Install the TDE templates
@@ -823,6 +827,8 @@ public static void tearDownAfterClass() throws Exception
     System.out.println("In tear down");
     // Delete the temp schema DB after resetting the Schema DB on content DB.
     // Else delete fails.
+    deleteUserRole("opticRole");
+    deleteRESTUser("opticUser");
     setDatabaseProperties(dbName, "schema-database", dbName);
     deleteDB(schemadbName);
     deleteForest(schemafNames[0]);

marklogic-client-api-functionaltests/src/test/java/com/marklogic/client/functionaltest/TestOpticOnLexicons.java

@@ -65,7 +65,7 @@ public class TestOpticOnLexicons extends BasicJavaClientREST {
   private static String schemadbName = "TestOpticOnLexiconsSchemaDB";
   private static String[] fNames = { "TestOpticOnLexiconsDB-1" };
   private static String[] schemafNames = { "TestOpticOnLexiconsSchemaDB-1" };
-
+ 
   private static DatabaseClient client;
   private static String datasource = "src/test/java/com/marklogic/client/functionaltest/data/optics/";
 
@@ -127,16 +127,21 @@ public static void setUp() throws KeyManagementException, NoSuchAlgorithmExcepti
     createForest(schemafNames[0], schemadbName);
     // Set the schemadbName database as the Schema database.
     setDatabaseProperties(dbName, "schema-database", schemadbName);
+   
+    createUserRolesWithPrevilages("opticRole", "xdbc:eval", "xdbc:eval-in", "xdmp:eval-in", "any-uri", "xdbc:invoke");
+    createRESTUser("opticUser", "0pt1c", "tde-admin", "tde-view", "opticRole", "rest-admin", "rest-writer", 
+    		                             "rest-reader", "rest-extension-user", "manage-user");    
 
     if (IsSecurityEnabled()) {
-        schemaDBclient = getDatabaseClientOnDatabase(getRestServerHostName(), getRestServerPort(), schemadbName, "admin", "admin", Authentication.DIGEST);
-        client = getDatabaseClient("admin", "admin", Authentication.DIGEST);
+        schemaDBclient = getDatabaseClientOnDatabase(getRestServerHostName(), getRestServerPort(), schemadbName, "opticUser", "0pt1c", Authentication.DIGEST);
+        client = getDatabaseClient("opticUser", "0pt1c", Authentication.DIGEST);
     }
     else {
-        schemaDBclient = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), schemadbName, new DigestAuthContext("admin", "admin"));
-        client = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), new DigestAuthContext("admin", "admin"));
+        schemaDBclient = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), schemadbName, new DigestAuthContext("opticUser", "0pt1c"));
+        client = DatabaseClientFactory.newClient(getRestServerHostName(), getRestServerPort(), new DigestAuthContext("opticUser", "0pt1c"));
     }
 
+
     // Install the TDE templates
     // loadFileToDB(client, filename, docURI, collection, document format)
     loadFileToDB(schemaDBclient, "masterDetail.tdex", "/optic/view/test/masterDetail.tdex", "XML", new String[] { "http://marklogic.com/xdmp/tde" });
@@ -1433,6 +1438,8 @@ public static void tearDownAfterClass() throws Exception {
     System.out.println("In tear down");
     // Delete the temp schema DB after resetting the Schema DB on content DB.
     // Else delete fails.
+    deleteUserRole("opticRole");
+    deleteRESTUser("opticUser");
     setDatabaseProperties(dbName, "schema-database", dbName);
     deleteDB(schemadbName);
     deleteForest(schemafNames[0]);