[accumulo] branch 2.0 updated: Fix #822 Add thread-safety info to AccumuloClient javadoc (#1205)

[ct...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ctubbsii pushed a commit to branch 2.0
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/2.0 by this push:
     new 9e08419  Fix #822 Add thread-safety info to AccumuloClient javadoc (#1205)
9e08419 is described below

commit 9e08419a0b96444647d38618c7c0ac69dfabf04d
Author: Christopher Tubbs <ct...@apache.org>
AuthorDate: Fri Jun 14 12:37:15 2019 -0400

    Fix #822 Add thread-safety info to AccumuloClient javadoc (#1205)
---
 .../main/java/org/apache/accumulo/core/client/AccumuloClient.java  | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/core/src/main/java/org/apache/accumulo/core/client/AccumuloClient.java b/core/src/main/java/org/apache/accumulo/core/client/AccumuloClient.java
index d23b1e6..48dd139 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/AccumuloClient.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/AccumuloClient.java
@@ -54,6 +54,13 @@ import org.apache.accumulo.core.security.Authorizations;
  * creating them could perform worse than Connector. Therefore, it would be better to create an
  * AccumuloClient and pass it around.
  *
+ * <p>
+ * AccumuloClient objects are intended to be thread-safe, and can be used by multiple threads.
+ * However, care should be taken to ensure that the client is eventually closed, to clean up any
+ * resources in use in the client application when all threads are finished with the AccumuloClient
+ * object. Additionally, while the client itself is thread-safe, it is not necessarily true that all
+ * objects produced from the client (such as Scanners) are thread-safe.
+ *
  * @since 2.0.0
  * @see <a href="https://accumulo.apache.org/docs/2.x/getting-started/clients">Accumulo Client
  *      Documentation</a>