Skip to content

Commit 784b933

Browse files
author
Shiva Verma
committed
Merge branch 'release-3.0-6' into 3.0-master
2 parents 7e9cc12 + 8934eb7 commit 784b933

49 files changed

Lines changed: 3663 additions & 2128 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,17 @@ Be sure to run the tests before submitting your pull request. PRs with failing
115115
tests won't be accepted.
116116

117117
$ mvn test-compile
118-
$ sh src/test/resources/boot-test.sh
118+
$ mvn exec:java@test-server-init
119119
$ mvn test
120120

121+
If your Maven installation is older than 3.3.1 you will get an error from the
122+
`mvn exec:java@...` command as this syntax variant was introduced with Maven
123+
3.3.1. Simply replace the original command with
124+
125+
$ ...
126+
$ mvn exec:java -DexecutionId=test-server-init
127+
$ ...
128+
121129
#### Push your changes
122130

123131
$ git push origin my-feature-branch

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ To use the API in your maven project, include the following in your pom.xml:
5151
<dependency>
5252
<groupId>com.marklogic</groupId>
5353
<artifactId>java-client-api</artifactId>
54-
<version>3.0.1</version>
54+
<version>3.0.6</version>
5555
</dependency>
5656

5757
For gradle projects, include the following:
5858

5959
dependencies {
60-
compile group: 'com.marklogic', name: 'java-client-api', version: '3.0.1'
60+
compile group: 'com.marklogic', name: 'java-client-api', version: '3.0.6'
6161
}
6262

6363
Read [The Java API in Five Minutes](http://developer.marklogic.com/try/java/index)
@@ -82,14 +82,14 @@ https://developer.marklogic.com/free-developer
8282

8383
To obtain verified downloads signed with MarkLogic's PGP key, use maven tools or directly download
8484
the .jar and .asc files from
85-
[maven central](http://repo1.maven.org/maven2/com/marklogic/java-client-api/3.0.1/). MarkLogic's
86-
pgp key ID is 48D4B86E and it is available from pgp.mit.edu by installing gnupg and running the command:
85+
[maven central](http://repo1.maven.org/maven2/com/marklogic/java-client-api/3.0.6/). MarkLogic's
86+
pgp key ID is 38A56C73 and it is available from pgp.mit.edu by installing gnupg and running the command:
8787

88-
$ gpg --keyserver pgp.mit.edu --recv-key 48D4B86E
88+
$ gpg --keyserver pgp.mit.edu --recv-key 38A56C73
8989

9090
Files can be verified with the command:
9191

92-
$ gpg java-client-api-3.0.1.jar.asc
92+
$ gpg java-client-api-3.0.6.jar.asc
9393

9494

9595
### Building and Contributing
@@ -108,7 +108,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more on contributing to this github p
108108
### Running JUnit Tests
109109

110110
$ mvn test-compile
111-
$ sh src/test/resources/boot-test.sh
111+
$ mvn exec:java@test-server-init
112112
$ mvn test
113113

114114
## Support

‎pom.xml‎

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<groupId>com.marklogic</groupId>
55
<artifactId>java-client-api</artifactId>
66
<packaging>jar</packaging>
7-
<version>3.0.5.1</version>
7+
<version>3.0.6</version>
88
<name>MarkLogic Java Client API</name>
99
<description>The official MarkLogic Java client API.</description>
1010
<url>https://github.com/marklogic/java-client-api</url>
@@ -185,7 +185,35 @@
185185
<phase>deploy</phase>
186186
</execution>
187187
</executions>
188-
</plugin>
188+
</plugin>
189+
<plugin>
190+
<groupId>org.codehaus.mojo</groupId>
191+
<artifactId>exec-maven-plugin</artifactId>
192+
<version>1.5.0</version>
193+
<executions>
194+
<execution>
195+
<id>test-server-init</id>
196+
<goals>
197+
<goal>java</goal>
198+
</goals>
199+
</execution>
200+
<execution>
201+
<id>test-server-teardown</id>
202+
<goals>
203+
<goal>java</goal>
204+
</goals>
205+
<configuration>
206+
<arguments>
207+
<argument>teardown</argument>
208+
</arguments>
209+
</configuration>
210+
</execution>
211+
</executions>
212+
<configuration>
213+
<mainClass>com.marklogic.client.test.util.TestServerBootstrapper</mainClass>
214+
<classpathScope>test</classpathScope>
215+
</configuration>
216+
</plugin>
189217
</plugins>
190218
</build>
191219
<dependencies>
@@ -260,17 +288,17 @@
260288
<dependency>
261289
<groupId>com.fasterxml.jackson.core</groupId>
262290
<artifactId>jackson-core</artifactId>
263-
<version>2.4.1</version>
291+
<version>2.8.3</version>
264292
</dependency>
265293
<dependency>
266294
<groupId>com.fasterxml.jackson.core</groupId>
267295
<artifactId>jackson-annotations</artifactId>
268-
<version>2.4.1</version>
296+
<version>2.8.3</version>
269297
</dependency>
270298
<dependency>
271299
<groupId>com.fasterxml.jackson.core</groupId>
272300
<artifactId>jackson-databind</artifactId>
273-
<version>2.4.1</version>
301+
<version>2.8.3</version>
274302
</dependency>
275303
<!-- test dependencies -->
276304
<dependency>
@@ -331,13 +359,13 @@
331359
<dependency>
332360
<groupId>com.fasterxml.jackson.dataformat</groupId>
333361
<artifactId>jackson-dataformat-xml</artifactId>
334-
<version>2.4.1</version>
362+
<version>2.8.3</version>
335363
<scope>test</scope>
336364
</dependency>
337365
<dependency>
338366
<groupId>com.fasterxml.jackson.dataformat</groupId>
339367
<artifactId>jackson-dataformat-csv</artifactId>
340-
<version>2.4.1</version>
368+
<version>2.8.3</version>
341369
<scope>test</scope>
342370
</dependency>
343371
</dependencies>

‎src/main/java/com/marklogic/client/admin/ExtensionLibrariesManager.java‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,12 @@ public ExtensionLibraryDescriptor[] list(String directory)
4545

4646
/**
4747
* Reads the contents of a library asset as an object of an IO class.
48-
*
49-
* The IO class must have been registered before creating the database client.
50-
* By default, standard Java IO classes for document content are registered.
48+
*
49+
* The IO class must have been registered before creating the database client.
50+
* By default, the provided handles that implement
51+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
52+
*
53+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
5154
*
5255
* @param libraryPath the path to the library
5356
* @param as the IO class for reading the library asset
@@ -58,9 +61,12 @@ public <T> T readAs(String libraryPath, Class<T> as)
5861
throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException;
5962
/**
6063
* Reads the contents of a library asset as an object of an IO class.
61-
*
62-
* The IO class must have been registered before creating the database client.
63-
* By default, standard Java IO classes for document content are registered.
64+
*
65+
* The IO class must have been registered before creating the database client.
66+
* By default, the provided handles that implement
67+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
68+
*
69+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
6470
*
6571
* @param libraryDescriptor a descriptor that locates the library
6672
* @param as the IO class for reading the library asset
@@ -94,7 +100,10 @@ public <T extends AbstractReadHandle> T read(ExtensionLibraryDescriptor libraryD
94100
* as an object of an IO class.
95101
*
96102
* The IO class must have been registered before creating the database client.
97-
* By default, standard Java IO classes for document content are registered.
103+
* By default, the provided handles that implement
104+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
105+
*
106+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
98107
*
99108
* @param libraryPath The path at which to install the library.
100109
* @param content an IO representation of the library asset
@@ -106,7 +115,10 @@ public void writeAs(String libraryPath, Object content)
106115
* as an object of an IO class.
107116
*
108117
* The IO class must have been registered before creating the database client.
109-
* By default, standard Java IO classes for document content are registered.
118+
* By default, the provided handles that implement
119+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
120+
*
121+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
110122
*
111123
* @param libraryDescriptor The descriptory which locates where to install the library.
112124
* @param content an IO representation of the library asset

‎src/main/java/com/marklogic/client/admin/QueryOptionsManager.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ public interface QueryOptionsManager {
3434
* XML representation provided as an object of an IO class.
3535
*
3636
* The IO class must have been registered before creating the database client.
37-
* By default, standard Java IO classes for document content are registered.
37+
* By default, the provided handles that implement
38+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
39+
*
40+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
3841
*
3942
* @param format whether to provide the list in a JSON or XML representation
4043
* @param as the IO class for reading the list of options
@@ -60,10 +63,16 @@ public <T extends QueryOptionsListReadHandle> T optionsList(T listHandle)
6063
/**
6164
* Fetch a query options configuration from the REST Server by name.
6265
*
63-
* @param name the name of options configuration stored on MarkLogic REST instance.
66+
* The IO class must have been registered before creating the database client.
67+
* By default, the provided handles that implement
68+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
69+
*
70+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
71+
*
72+
* @param name the name of options configuration stored on MarkLogic REST instance.
6473
* @param format whether to provide the options in a JSON or XML representation
6574
* @param as the IO class for reading the query options
66-
* @param <T> the type of object that will be returned by the handle registered for it
75+
* @param <T> the type of object that will be returned by the handle registered for it
6776
* @return an object of the IO class with the query options
6877
*/
6978
public <T> T readOptionsAs(String name, Format format, Class<T> as)
@@ -86,7 +95,10 @@ public <T extends QueryOptionsReadHandle> T readOptions(String name, T queryOpti
8695
* XML representation provided as an object of an IO class.
8796
*
8897
* The IO class must have been registered before creating the database client.
89-
* By default, standard Java IO classes for document content are registered.
98+
* By default, the provided handles that implement
99+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
100+
*
101+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
90102
*
91103
* @param name name given to the QueryOptions for use in runtime queries
92104
* @param format whether the options are provided in a JSON or XML representation

‎src/main/java/com/marklogic/client/admin/ResourceExtensionsManager.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ public interface ResourceExtensionsManager {
3535
* in a JSON or XML representation provided as an object of an IO class.
3636
*
3737
* The IO class must have been registered before creating the database client.
38-
* By default, standard Java IO classes for document content are registered.
38+
* By default, the provided handles that implement
39+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
40+
*
41+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
3942
*
4043
* @param format whether to provide the list in a JSON or XML representation
4144
* @param as the IO class for reading the list of resource service extensions
@@ -48,7 +51,10 @@ public interface ResourceExtensionsManager {
4851
* in a JSON or XML representation provided as an object of an IO class.
4952
*
5053
* The IO class must have been registered before creating the database client.
51-
* By default, standard Java IO classes for document content are registered.
54+
* By default, the provided handles that implement
55+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
56+
*
57+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
5258
*
5359
* @param format whether to provide the list in a JSON or XML representation
5460
* @param as the IO class for reading the list of resource service extensions
@@ -80,7 +86,10 @@ public interface ResourceExtensionsManager {
8086
* in a textual representation provided as an object of an IO class.
8187
*
8288
* The IO class must have been registered before creating the database client.
83-
* By default, standard Java IO classes for document content are registered.
89+
* By default, the provided handles that implement
90+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
91+
*
92+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
8493
*
8594
* @param resourceName the name of the resource
8695
* @param as the IO class for reading the source code as text
@@ -103,7 +112,10 @@ public interface ResourceExtensionsManager {
103112
* in a textual representation provided as an object of an IO class.
104113
*
105114
* The IO class must have been registered before creating the database client.
106-
* By default, standard Java IO classes for document content are registered.
115+
* By default, the provided handles that implement
116+
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
117+
*
118+
* <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
107119
*
108120
* @param resourceName the name of the resource
109121
* @param source an IO representation of the source code

0 commit comments

Comments
 (0)