Skip to content

Commit d69d502

Browse files
committed
Merge branch 'release-3.0.5' into 3.0-master
2 parents 650eba3 + da7b29a commit d69d502

File tree

620 files changed

+12010
-9690
lines changed

Some content is hidden

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

620 files changed

+12010
-9690
lines changed

.classpath

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
2-
<classpath>
3-
<classpathentry kind="src" output="target/classes" path="src/main/java">
4-
<attributes>
5-
<attribute name="optional" value="true"/>
6-
<attribute name="maven.pomderived" value="true"/>
7-
</attributes>
8-
</classpathentry>
9-
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
10-
<attributes>
11-
<attribute name="optional" value="true"/>
12-
<attribute name="maven.pomderived" value="true"/>
13-
</attributes>
14-
</classpathentry>
15-
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
16-
<attributes>
17-
<attribute name="maven.pomderived" value="true"/>
18-
</attributes>
19-
</classpathentry>
20-
<classpathentry kind="src" output="target/test-classes" path="src/test/resources">
21-
<attributes>
22-
<attribute name="maven.pomderived" value="true"/>
23-
</attributes>
24-
</classpathentry>
25-
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
26-
<attributes>
27-
<attribute name="maven.pomderived" value="true"/>
28-
</attributes>
29-
</classpathentry>
30-
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
31-
<classpathentry kind="output" path="target/classes"/>
32-
</classpath>
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<classpath>
3+
<classpathentry kind="src" output="target/classes" path="src/main/java">
4+
<attributes>
5+
<attribute name="optional" value="true"/>
6+
<attribute name="maven.pomderived" value="true"/>
7+
</attributes>
8+
</classpathentry>
9+
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
10+
<attributes>
11+
<attribute name="optional" value="true"/>
12+
<attribute name="maven.pomderived" value="true"/>
13+
</attributes>
14+
</classpathentry>
15+
<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
16+
<attributes>
17+
<attribute name="maven.pomderived" value="true"/>
18+
</attributes>
19+
</classpathentry>
20+
<classpathentry kind="src" output="target/test-classes" path="src/test/resources">
21+
<attributes>
22+
<attribute name="maven.pomderived" value="true"/>
23+
</attributes>
24+
</classpathentry>
25+
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
26+
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
27+
<attributes>
28+
<attribute name="maven.pomderived" value="true"/>
29+
</attributes>
30+
</classpathentry>
31+
<classpathentry kind="output" path="target/classes"/>
32+
</classpath>

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You might want to skip the tests until you have configured a test database and R
103103

104104
$ mvn package -Dmaven.test.skip=true
105105

106-
See [Contributing.md](Contributing.md) for more on contributing to this github project.
106+
See [CONTRIBUTING.md](CONTRIBUTING.md) for more on contributing to this github project.
107107

108108
### Running JUnit Tests
109109

pom.xml

Lines changed: 3 additions & 16 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.4</version>
7+
<version>3.0.5</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>
@@ -62,14 +62,15 @@
6262
<artifactId>maven-javadoc-plugin</artifactId>
6363
<version>2.8.1</version>
6464
<configuration>
65-
<bottom><![CDATA[Copyright &#169; 2013-2015 MarkLogic Corporation.]]></bottom>
65+
<bottom><![CDATA[Copyright &#169; 2013-2016 MarkLogic Corporation.]]></bottom>
6666
<excludePackageNames>*.impl:*.jaxb:*.test:*.test.*</excludePackageNames>
6767
<links>
6868
<link>http://docs.oracle.com/javase/8/docs/api/</link>
6969
</links>
7070
<overview>${basedir}/src/main/javadoc/overview.html</overview>
7171
<show>public</show>
7272
<doctitle>${javadoc-title}</doctitle>
73+
<windowtitle>${javadoc-title}</windowtitle>
7374
<use/>
7475
</configuration>
7576
<executions>
@@ -187,20 +188,6 @@
187188
</plugin>
188189
</plugins>
189190
</build>
190-
<profiles>
191-
<profile>
192-
<id>Java 8</id>
193-
<activation>
194-
<jdk>1.8</jdk>
195-
</activation>
196-
<properties>
197-
<!-- Disable Java 8 overly strict javadoc linter when building with Java 8
198-
http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html
199-
-->
200-
<additionalparam>-Xdoclint:none</additionalparam>
201-
</properties>
202-
</profile>
203-
</profiles>
204191
<dependencies>
205192
<!-- direct build / run dependencies -->
206193
<!--

src/main/java/com/marklogic/client/DatabaseClient.java

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -33,6 +33,10 @@
3333
import com.marklogic.client.pojo.PojoRepository;
3434
import com.marklogic.client.semantics.GraphManager;
3535
import com.marklogic.client.semantics.SPARQLQueryManager;
36+
import com.marklogic.client.DatabaseClientFactory.Authentication;
37+
import com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier;
38+
39+
import javax.net.ssl.SSLContext;
3640

3741
/**
3842
* A Database Client instantiates document and query managers and other objects
@@ -115,10 +119,14 @@ public interface DatabaseClient {
115119
*/
116120
public ServerConfigurationManager newServerConfigManager();
117121

118-
/** Creates a manager for CRUD operations on semantic graphs. */
122+
/** Creates a manager for CRUD operations on semantic graphs.
123+
* @return the new GraphManager instance
124+
*/
119125
public GraphManager newGraphManager();
120126

121-
/** Creates a manager for executing SPARQL queries and retrieving results. */
127+
/** Creates a manager for executing SPARQL queries and retrieving results.
128+
* @return the new SPARQLQueryManager instance
129+
*/
122130
public SPARQLQueryManager newSPARQLQueryManager();
123131

124132
/**
@@ -130,6 +138,8 @@ public interface DatabaseClient {
130138
* @param clazz the class type for this PojoRepository to handle
131139
* @param idClass the class type of the id field for this clazz, must obviously
132140
* be Serializable or we'll struggle to marshall it
141+
* @param <T> the pojo type this PojoRepository will manage
142+
* @param <ID> the scalar type of the id for pojos of type &lt;T&gt;
133143
* @return the initialized PojoRepository
134144
**/
135145
public <T, ID extends Serializable> PojoRepository<T, ID> newPojoRepository(Class<T> clazz, Class<ID> idClass);
@@ -139,6 +149,7 @@ public interface DatabaseClient {
139149
*
140150
* @param resourceName the name of the extension resource
141151
* @param resourceManager the manager for the extension resource
152+
* @param <T> the type of ResourceManager to init for the extension resource
142153
* @return the initialized resource manager
143154
*/
144155
public <T extends ResourceManager> T init(String resourceName, T resourceManager);
@@ -182,6 +193,23 @@ public interface DatabaseClient {
182193
* xdbc:invoke privilege. If this DatabaseClient is pointed at a database different
183194
* than the default for this REST server, you will need the xdbc:eval-in or xdbc:invoke-in
184195
* privilege.
196+
* @return the new ServerEvaluationCall instance
185197
*/
186-
public ServerEvaluationCall newServerEval();
198+
public ServerEvaluationCall newServerEval();
199+
200+
public String getHost();
201+
202+
public int getPort();
203+
204+
public String getDatabase();
205+
206+
public String getUser();
207+
208+
public String getPassword();
209+
210+
public Authentication getAuthentication();
211+
212+
public SSLContext getSSLContext();
213+
214+
public SSLHostnameVerifier getSSLHostnameVerifier();
187215
}

src/main/java/com/marklogic/client/DatabaseClientFactory.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -95,6 +95,7 @@ public interface SSLHostnameVerifier {
9595
* @param hostname the name of the checked host
9696
* @param cns common names for the checked host
9797
* @param subjectAlts alternative subject names for the checked host
98+
* @throws SSLException if the hostname isn't acceptable
9899
*/
99100
public void verify(String hostname, String[] cns, String[] subjectAlts) throws SSLException;
100101

@@ -165,6 +166,7 @@ public interface HandleFactoryRegistry {
165166
* Creates a ContentHandle if the registry has a factory
166167
* for the class of the IO representation.
167168
* @param type the class for an IO representation
169+
* @param <C> the registered type for the returned handle
168170
* @return a content handle or null if no factory supports the class
169171
*/
170172
public <C> ContentHandle<C> makeHandle(Class<C> type);
@@ -326,7 +328,7 @@ static private DatabaseClientImpl newClientImpl(String host, int port, String da
326328
);
327329
}
328330

329-
return new DatabaseClientImpl(services);
331+
return new DatabaseClientImpl(services, host, port, database, user, password, type, context, verifier);
330332
}
331333

332334
/**

src/main/java/com/marklogic/client/FailedRequestException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/ForbiddenUserException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/MarkLogicBindingException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/MarkLogicIOException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/MarkLogicInternalException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/MarkLogicServerException.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -33,8 +33,8 @@ public abstract class MarkLogicServerException extends RuntimeException {
3333
private FailedRequest failedRequest;
3434

3535
/**
36-
* @param localMessage
37-
* @param failedRequest
36+
* @param localMessage message describing the exception
37+
* @param failedRequest details about the failed request behind this exception
3838
*/
3939
public MarkLogicServerException(String localMessage, FailedRequest failedRequest) {
4040
super(localMessage);

src/main/java/com/marklogic/client/Page.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/RequestConstants.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2013-2015 MarkLogic Corporation
2+
* Copyright 2013-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/ResourceNotFoundException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/ResourceNotResendableException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

src/main/java/com/marklogic/client/Transaction.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
1616
package com.marklogic.client;
1717

1818
import com.marklogic.client.io.marker.StructureReadHandle;
19+
import javax.ws.rs.core.NewCookie;
20+
import java.util.List;
1921

2022
/**
2123
* Identifies and provides methods to complete a transaction.
@@ -40,10 +42,20 @@ public interface Transaction {
4042
*/
4143
public String getHostId();
4244

45+
/**
46+
* Returns any cookies sent in the response to open the transaction. This is
47+
* specifically to support cookies used by a load balancer to keep all
48+
* requests associated with a transaction on the host where that transaction
49+
* originated.
50+
* @return the cookies sent in the response to open the transaction
51+
*/
52+
public List<NewCookie> getCookies();
53+
4354
/**
4455
* Reads the status for the transaction including whether the transaction
4556
* has timed out.
4657
* @param handle a JSON or XML handle on the content of the status report
58+
* @param <T> the type of StructureReadHandle handle to return
4759
* @return the status report handle
4860
*/
4961
public <T extends StructureReadHandle> T readStatus(T handle) throws ForbiddenUserException, FailedRequestException;

src/main/java/com/marklogic/client/UnauthorizedUserException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 MarkLogic Corporation
2+
* Copyright 2012-2016 MarkLogic Corporation
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@ public ExtensionLibraryDescriptor[] list(String directory)
5151
*
5252
* @param libraryPath the path to the library
5353
* @param as the IO class for reading the library asset
54+
* @param <T> the type of object that will be returned by the handle registered for it
5455
* @return an object of the IO class with the library asset
5556
*/
5657
public <T> T readAs(String libraryPath, Class<T> as)
@@ -63,6 +64,7 @@ public <T> T readAs(String libraryPath, Class<T> as)
6364
*
6465
* @param libraryDescriptor a descriptor that locates the library
6566
* @param as the IO class for reading the library asset
67+
* @param <T> the type of AbstractReadHandle to return
6668
* @return an object of the IO class with the library asset
6769
*/
6870
public <T> T read(ExtensionLibraryDescriptor libraryDescriptor, Class<T> as)
@@ -72,6 +74,7 @@ public <T> T read(ExtensionLibraryDescriptor libraryDescriptor, Class<T> as)
7274
* Reads the contents of a library asset into a handle.
7375
* @param libraryPath the path to the library
7476
* @param readHandle a handle for reading the contents of the file
77+
* @param <T> the type of AbstractReadHandle to return
7578
* @return the handle for the library asset
7679
*/
7780
public <T extends AbstractReadHandle> T read(String libraryPath, T readHandle)
@@ -80,6 +83,7 @@ public <T extends AbstractReadHandle> T read(String libraryPath, T readHandle)
8083
* Reads the contents of a library asset into a handle.
8184
* @param libraryDescriptor a descriptor that locates the library.
8285
* @param readHandle A handle for reading the contents of the file.
86+
* @param <T> the type of AbstractReadHandle to return
8387
* @return The handle.
8488
*/
8589
public <T extends AbstractReadHandle> T read(ExtensionLibraryDescriptor libraryDescriptor, T readHandle)

0 commit comments

Comments
 (0)