[zookeeper] branch master updated: ZOOKEEPER-3197: Improve documentation in ZooKeeperServer.superSecret

[an...@apache.org]

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

andor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/zookeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new 36b8711  ZOOKEEPER-3197: Improve documentation in ZooKeeperServer.superSecret
36b8711 is described below

commit 36b8711ebfd7ea749d547a52ddcd7d8853931728
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Mon Jan 7 15:34:02 2019 +0100

    ZOOKEEPER-3197: Improve documentation in ZooKeeperServer.superSecret
    
    Author: Colm O hEigeartaigh <co...@apache.org>
    
    Reviewers: andor@apache.org
    
    Closes #752 from coheigea/ZOOKEEPER-3197
---
 .../src/main/java/org/apache/zookeeper/server/ZooKeeperServer.java  | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServer.java b/zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServer.java
index b417a8f..20ab023 100644
--- a/zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServer.java
+++ b/zookeeper-server/src/main/java/org/apache/zookeeper/server/ZooKeeperServer.java
@@ -116,8 +116,10 @@ public class ZooKeeperServer implements SessionExpirer, ServerStats.Provider {
     }
 
     /**
-     * This is the secret that we use to generate passwords, for the moment it
-     * is more of a sanity check.
+     * This is the secret that we use to generate passwords. For the moment,
+     * it's more of a checksum that's used in reconnection, which carries no
+     * security weight, and is treated internally as if it carries no
+     * security weight.
      */
     static final private long superSecret = 0XB3415C00L;