This is an automated email from the ASF dual-hosted git repository.
edcoleman pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/main by this push:
new 909ca63dc4 Expand instanceOperations.getSystemConfiguration javadoc.
(#3188)
909ca63dc4 is described below
commit 909ca63dc4c8310205ec5f217a54f1d0fea47975
Author: EdColeman <d...@etcoleman.com>
AuthorDate: Mon Feb 6 08:11:03 2023 -0500
Expand instanceOperations.getSystemConfiguration javadoc. (#3188)
---
.../accumulo/core/client/admin/InstanceOperations.java | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git
a/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
b/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
index 2e1c0c92ae..fcfe4c43d6 100644
---
a/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
+++
b/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
@@ -140,7 +140,17 @@ public interface InstanceOperations {
void removeProperty(final String property) throws AccumuloException,
AccumuloSecurityException;
/**
- * Retrieve the system-wide configuration.
+ * Retrieve the system-wide, merged view of the system configuration.
Accumulo has multiple layers
+ * of properties, in order of precedence (highest - lowest):
+ * <ul>
+ * <li>the properties set in Zookeeper</li>
+ * <li>the properties set in the site configuration file</li>
+ * <li>the default properties</li>
+ * </ul>
+ * The properties returned is the merged view of these properties. The
properties that are stored
+ * in ZooKeeper can be modified with {@link #modifyProperties
modifyProperties},
+ * {@link #setProperty setProperty} and {@link #removeProperty
removeProperty}. Properties can be
+ * further refined by namesapce {@link NamespaceOperations} and by table
{@link TableOperations}.
*
* @return A map of system properties set in zookeeper. If a property is not
set in zookeeper,
* then it will return the value set in accumulo.properties on some
server. If nothing is
