You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by kt...@apache.org on 2013/10/30 14:43:57 UTC

git commit: ACCUMULO-1069 updated javadocs for instance operations to get config

Updated Branches:
  refs/heads/1.4.5-SNAPSHOT 4d493b467 -> 345b0a6d2


ACCUMULO-1069 updated javadocs for instance operations to get config


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/345b0a6d
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/345b0a6d
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/345b0a6d

Branch: refs/heads/1.4.5-SNAPSHOT
Commit: 345b0a6d2a15a55394938699bdf997afb553d735
Parents: 4d493b4
Author: Keith Turner <kt...@apache.org>
Authored: Wed Oct 30 09:43:18 2013 -0400
Committer: Keith Turner <kt...@apache.org>
Committed: Wed Oct 30 09:43:18 2013 -0400

----------------------------------------------------------------------
 .../core/client/admin/InstanceOperations.java   | 21 ++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/345b0a6d/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
----------------------------------------------------------------------
diff --git a/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java b/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
index c74497a..37266f9 100644
--- a/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
+++ b/src/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
@@ -28,7 +28,8 @@ import org.apache.accumulo.core.client.AccumuloSecurityException;
 public interface InstanceOperations {
   
   /**
-   * Sets an instance property in zookeeper. Tablet servers will pull this setting and override the equivalent setting in accumulo-site.xml
+   * Sets an system property in zookeeper. Tablet servers will pull this setting and override the equivalent setting in accumulo-site.xml. Changes can be seen
+   * using {@link #getSystemConfiguration()}
    * 
    * @param property
    *          the name of a per-table property
@@ -42,7 +43,7 @@ public interface InstanceOperations {
   public void setProperty(final String property, final String value) throws AccumuloException, AccumuloSecurityException;
   
   /**
-   * Removes a instance property from zookeeper
+   * Removes a system property from zookeeper. Changes can be seen using {@link #getSystemConfiguration()}
    * 
    * @param property
    *          the name of a per-table property
@@ -53,8 +54,24 @@ public interface InstanceOperations {
    */
   public void removeProperty(final String property) throws AccumuloException, AccumuloSecurityException;
   
+  /**
+   * 
+   * @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-site.xml on some
+   *         server. If nothing is set in an accumulo-site.xml file it will return the default value for each property.
+   * @throws AccumuloException
+   * @throws AccumuloSecurityException
+   */
+
   public Map<String,String> getSystemConfiguration() throws AccumuloException, AccumuloSecurityException;
   
+  /**
+   * 
+   * @return A map of system properties set in accumulo-site.xml on some server. If nothing is set in an accumulo-site.xml file it will return the default value
+   *         for each property.
+   * @throws AccumuloException
+   * @throws AccumuloSecurityException
+   */
+
   public Map<String,String> getSiteConfiguration() throws AccumuloException, AccumuloSecurityException;
   
   /**