Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id D12292009F9 for ; Mon, 23 May 2016 23:33:04 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id CF82F160A0E; Mon, 23 May 2016 21:33:04 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id EEBFC160A05 for ; Mon, 23 May 2016 23:33:03 +0200 (CEST) Received: (qmail 85475 invoked by uid 500); 23 May 2016 21:33:03 -0000 Mailing-List: contact commits-help@zookeeper.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ Delivered-To: mailing list commits@zookeeper.apache.org Received: (qmail 85464 invoked by uid 99); 23 May 2016 21:33:03 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 23 May 2016 21:33:03 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id B9F2FC14B9 for ; Mon, 23 May 2016 21:33:02 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 0.374 X-Spam-Level: X-Spam-Status: No, score=0.374 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-1.426] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id i4Mba-1u6YB6 for ; Mon, 23 May 2016 21:33:01 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTP id 75FE55F3F5 for ; Mon, 23 May 2016 21:33:01 +0000 (UTC) Received: from svn01-us-west.apache.org (svn.apache.org [10.41.0.6]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 38563E00A2 for ; Mon, 23 May 2016 21:33:00 +0000 (UTC) Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 9D40A3A01DD for ; Mon, 23 May 2016 21:32:59 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1745280 - in /zookeeper/branches/branch-3.5: CHANGES.txt src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Date: Mon, 23 May 2016 21:32:59 -0000 To: commits@zookeeper.apache.org From: fpj@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20160523213259.9D40A3A01DD@svn01-us-west.apache.org> archived-at: Mon, 23 May 2016 21:33:05 -0000 Author: fpj Date: Mon May 23 21:32:58 2016 New Revision: 1745280 URL: http://svn.apache.org/viewvc?rev=1745280&view=rev Log: ZOOKEEPER-2402: Document client side properties (Arshad Mohammad via fpj) Modified: zookeeper/branches/branch-3.5/CHANGES.txt zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Modified: zookeeper/branches/branch-3.5/CHANGES.txt URL: http://svn.apache.org/viewvc/zookeeper/branches/branch-3.5/CHANGES.txt?rev=1745280&r1=1745279&r2=1745280&view=diff ============================================================================== --- zookeeper/branches/branch-3.5/CHANGES.txt (original) +++ zookeeper/branches/branch-3.5/CHANGES.txt Mon May 23 21:32:58 2016 @@ -182,6 +182,8 @@ IMPROVEMENTS: ZOOKEEPER-2139: Support multiple ZooKeeper client with different configurations in a single JVM (Arshad Mohammad via fpj) + ZOOKEEPER-2402: Document client side properties (Arshad Mohammad via fpj) + Release 3.5.1 - 07/27/2015 NEW FEATURES: Modified: zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml URL: http://svn.apache.org/viewvc/zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml?rev=1745280&r1=1745279&r2=1745280&view=diff ============================================================================== --- zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml (original) +++ zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml Mon May 23 21:32:58 2016 @@ -1238,20 +1238,6 @@ server.3=zoo3:2888:3888 will be used for secure authentication. - - - zookeeper.client.secure - - (Java system property only: zookeeper.client.secure) - If you want to connect to server's secure client port, you need to - set this property to true on client. - This will connect to server using SSL with specified credentials. Note that - you also need to plug-in Netty client. - - - - Modified: zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml URL: http://svn.apache.org/viewvc/zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml?rev=1745280&r1=1745279&r2=1745280&view=diff ============================================================================== --- zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml (original) +++ zookeeper/branches/branch-3.5/src/docs/src/documentation/content/xdocs/zookeeperProgrammers.xml Mon May 23 21:32:58 2016 @@ -1373,6 +1373,114 @@ authProvider.2=com.f.MyAuth2 (SESSION_EXPIRED and AUTH_FAILED), the ZooKeeper object becomes invalid. On a close, the two threads shut down and any further access on zookeeper handle is undefined behavior and should be avoided. +
+ <emphasis role="bold">Client Configuration Parameters</emphasis> + + The following list contains configuration properties for the Java client. You can set any + of these properties using Java system properties. For server properties, please check the + following reference + Server configuration section. + + + + zookeeper.sasl.client + + Set the value to false to disable + SASL authentication. Default is true. + + + + zookeeper.sasl.clientconfig + + Specifies the context key in the JAAS login file. Default is "Client". + + + + zookeeper.sasl.client.username + + Traditionally, a principal is divided into three parts: the primary, the instance, and the realm. + The format of a typical Kerberos V5 principal is primary/instance@REALM. + zookeeper.sasl.client.username specifies the primary part of the server principal. Default + is "zookeeper". Instance part is derived from the server IP. Finally server's principal is + username/IP@realm, where username is the value of zookeeper.sasl.client.username, IP is + the server IP, and realm is the value of zookeeper.server.realm. + + + + zookeeper.server.realm + + Realm part of the server principal. By default it is the client principal realm. + + + + zookeeper.disableAutoWatchReset + + This switch controls whether automatic watch resetting is enabled. Clients automatically + reset watches during session reconnect by default, this option allows the client to turn off + this behavior by setting zookeeper.disableAutoWatchReset to true. + + + + + zookeeper.client.secure + + + If you want to connect to the server secure client port, you need to set this property to + true + on the client. This will connect to server using SSL with specified credentials. Note that + it requires the Netty client. + + + + + zookeeper.clientCnxnSocket + + + Specifies which ClientCnxnSocket to be used. Possible values are + org.apache.zookeeper.ClientCnxnSocketNIO + and + org.apache.zookeeper.ClientCnxnSocketNetty + . Default is + org.apache.zookeeper.ClientCnxnSocketNIO + . If you want to connect to server's secure client port, you need to set this property to + org.apache.zookeeper.ClientCnxnSocketNetty + on client. + + + + + zookeeper.ssl.keyStore.location and zookeeper.ssl.keyStore.password + + Specifies the file path to a JKS containing the local credentials to be used for SSL connections, + and the password to unlock the file. + + + + + zookeeper.ssl.trustStore.location and zookeeper.ssl.trustStore.password + + Specifies the file path to a JKS containing the remote credentials to be used for SSL connections, + and the password to unlock the file. + + + + + jute.maxbuffer + + It specifies the maximum size of the incoming data from the server. The default value is 4194304 + Bytes , or just 4 MB. This is really a sanity check. The ZooKeeper server is designed to store and send + data on the order of kilobytes. If incoming data length is more than this value, an IOException + is raised. + + + + zookeeper.kinit + + Specifies path to kinit binary. Default is "/usr/bin/kinit". + + + +