ZooKeeper
  1. ZooKeeper
  2. ZOOKEEPER-490

the java docs for session creation are misleading/incomplete

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 3.1.1, 3.2.0
    • Fix Version/s: 3.2.1, 3.3.0
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      the javadoc for ZooKeeper constructor says:

      • The client object will pick an arbitrary server and try to connect to it.
      • If failed, it will try the next one in the list, until a connection is
      • established, or all the servers have been tried.

      the "or all server tried" phrase is misleading, it should indicate that we retry until success, con closed, or session expired.

      we also need ot mention that connection is async, that constructor returns immed and you need to look for connection event in watcher

        Activity

        Hide
        Patrick Hunt added a comment -

        this patch updates the javadoc for zk construction
        talks about async nature
        talks about thread safety

        Show
        Patrick Hunt added a comment - this patch updates the javadoc for zk construction talks about async nature talks about thread safety
        Hide
        Benjamin Reed added a comment -

        +1 looks good pat

        Show
        Benjamin Reed added a comment - +1 looks good pat
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12415675/ZOOKEEPER-490.patch
        against trunk revision 801839.

        +1 @author. The patch does not contain any @author tags.

        -1 tests included. The patch doesn't appear to include any new or modified tests.
        Please justify why no tests are needed for this patch.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 findbugs. The patch does not introduce any new Findbugs warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed core unit tests.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Console output: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12415675/ZOOKEEPER-490.patch against trunk revision 801839. +1 @author. The patch does not contain any @author tags. -1 tests included. The patch doesn't appear to include any new or modified tests. Please justify why no tests are needed for this patch. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. +1 core tests. The patch passed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: http://hudson.zones.apache.org/hudson/job/Zookeeper-Patch-vesta.apache.org/174/console This message is automatically generated.
        Hide
        Patrick Hunt added a comment -

        I've committed based on ben's +1.

        Show
        Patrick Hunt added a comment - I've committed based on ben's +1.
        Hide
        Hudson added a comment -

        Integrated in ZooKeeper-trunk #409 (See http://hudson.zones.apache.org/hudson/job/ZooKeeper-trunk/409/)
        . the java docs for session creation are misleading/incomplete

        Show
        Hudson added a comment - Integrated in ZooKeeper-trunk #409 (See http://hudson.zones.apache.org/hudson/job/ZooKeeper-trunk/409/ ) . the java docs for session creation are misleading/incomplete

          People

          • Assignee:
            Patrick Hunt
            Reporter:
            Patrick Hunt
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development