ZOOKEEPER-233: Split zookeeper-common, zookeeper-server from zookeeper

The resulting `zookeeper-server` module does not depend on client side
codes.

Author: kezhuw

.typos.toml

@@ -48,5 +48,5 @@
 
 [files]
 extend-exclude = [
-    "zookeeper-client/src/test/java/org/apache/zookeeper/common/CertificatesToPlayWith.java",
+    "zookeeper-common/src/test/java/org/apache/zookeeper/common/CertificatesToPlayWith.java",
 ]

bin/zkEnv.sh

@@ -104,7 +104,7 @@ for d in "$ZOOBINDIR"/../build/lib/*.jar; do
 done
 
 #make it work for developers
-for d in "$ZOOBINDIR"/../zookeeper-server/target/lib/*.jar; do
+for d in "$ZOOBINDIR"/../zookeeper/target/lib/*.jar; do
   CLASSPATH="$d:$CLASSPATH"
 done
 
@@ -117,6 +117,8 @@ done
 CLASSPATH="$ZOOBINDIR/../build/classes:$CLASSPATH"
 
 #make it work for developers
+CLASSPATH="$ZOOBINDIR/../zookeeper-client/target/classes:$CLASSPATH"
+CLASSPATH="$ZOOBINDIR/../zookeeper-common/target/classes:$CLASSPATH"
 CLASSPATH="$ZOOBINDIR/../zookeeper-server/target/classes:$CLASSPATH"
 
 #make it work for developers

checkstyleSuppressions.xml

@@ -24,14 +24,20 @@
     <suppress checks="LineLength" files=".+[\\/]jute[\\/].+\.java"/>
 
     <!-- TODO ZOOKEEPER-3508 -->
+    <suppress checks="LineLength" files=".+[\\/]zookeeper[\\/].+\.java"/>
+    <suppress checks="LineLength" files=".+[\\/]zookeeper-common[\\/].+\.java"/>
     <suppress checks="LineLength" files=".+[\\/]zookeeper-client[\\/].+\.java"/>
     <suppress checks="LineLength" files=".+[\\/]zookeeper-server[\\/].+\.java"/>
 
     <!-- TODO ZOOKEEPER-3507 -->
+    <suppress checks=".*Name.*" files=".+[\\/]zookeeper[\\/].+\.java"/>
+    <suppress checks=".*Name.*" files=".+[\\/]zookeeper-common[\\/].+\.java"/>
     <suppress checks=".*Name.*" files=".+[\\/]zookeeper-client[\\/].+\.java"/>
     <suppress checks=".*Name.*" files=".+[\\/]zookeeper-server[\\/].+\.java"/>
 
     <!-- TODO ZOOKEEPER-3469 -->
+    <suppress checks="Javadoc.+" files=".+[\\/]zookeeper[\\/].+\.java"/>
+    <suppress checks="Javadoc.+" files=".+[\\/]zookeeper-common[\\/].+\.java"/>
     <suppress checks="Javadoc.+" files=".+[\\/]zookeeper-client[\\/].+\.java"/>
     <suppress checks="Javadoc.+" files=".+[\\/]zookeeper-server[\\/].+\.java"/>
 </suppressions>

pom.xml

@@ -57,10 +57,12 @@
   </licenses>
 
   <modules>
+    <module>zookeeper</module>
     <module>zookeeper-docs</module>
     <module>zookeeper-jute</module>
     <module>zookeeper-server</module>
     <module>zookeeper-metrics-providers</module>
+    <module>zookeeper-common</module>
     <module>zookeeper-client</module>
     <module>zookeeper-client-c</module>
     <module>zookeeper-recipes</module>

zookeeper-assembly/pom.xml

@@ -64,11 +64,6 @@
       <artifactId>zookeeper</artifactId>
       <version>${project.version}</version>
     </dependency>
-    <dependency>
-      <groupId>org.apache.zookeeper</groupId>
-      <artifactId>zookeeper-client</artifactId>
-      <version>${project.version}</version>
-    </dependency>
     <dependency>
       <groupId>org.apache.zookeeper</groupId>
       <artifactId>zookeeper-prometheus-metrics</artifactId>

zookeeper-assembly/src/main/assembly/bin-package.xml

@@ -76,9 +76,16 @@
       <fileMode>${rw.file.permission}</fileMode>
       <directoryMode>${rwx.file.permission}</directoryMode>
     </fileSet>
+    <fileSet>
+      <!-- ZooKeeper cli generated api document -->
+      <directory>${project.basedir}/../zookeeper/target/apidocs</directory>
+      <outputDirectory>docs/apidocs/zookeeper-server</outputDirectory>
+      <fileMode>${rw.file.permission}</fileMode>
+      <directoryMode>${rwx.file.permission}</directoryMode>
+    </fileSet>
     <fileSet>
       <!-- License files for 3rd party libs -->
-      <directory>${project.basedir}/../zookeeper-server/src/main/resources/lib</directory>
+      <directory>${project.basedir}/../zookeeper/src/main/resources/lib</directory>
       <includes>
         <include>*.txt</include>
       </includes>

zookeeper-client-c/tests/zkServer.sh

@@ -83,20 +83,15 @@ fi
 
 CLASSPATH="$CLASSPATH:$zk_base/build/classes"
 CLASSPATH="$CLASSPATH:$zk_base/conf"
-CLASSPATH="$CLASSPATH:$zk_base/zookeeper-server/target/classes"
 
 for i in "$zk_base"/build/lib/*.jar; do
   CLASSPATH="$CLASSPATH:$i"
 done
 
-for d in "$zk_base"/zookeeper-server/target/lib/*.jar; do
+for d in "$zk_base"/zookeeper/target/lib/*.jar; do
   CLASSPATH="$d:$CLASSPATH"
 done
 
-for i in "$zk_base"/zookeeper-server/src/main/resource/lib/*.jar; do
-  CLASSPATH="$CLASSPATH:$i"
-done
-
 CLASSPATH="$CLASSPATH:$CLOVER_HOME/lib/clover*.jar"
 
 if $cygwin; then

zookeeper-client/pom.xml

@@ -37,6 +37,11 @@
       <artifactId>zookeeper-jute</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.zookeeper</groupId>
+      <artifactId>zookeeper-common</artifactId>
+      <version>${project.version}</version>
+    </dependency>
 
     <!-- annotations -->
     <dependency>
@@ -135,64 +140,6 @@
 
   <build>
     <plugins>
-      <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>build-helper-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <!-- ${maven.build.timestamp} does not support timezone :( -->
-            <id>build-time</id>
-            <goals>
-              <goal>timestamp-property</goal>
-            </goals>
-            <configuration>
-              <name>build.time</name>
-              <pattern>yyyy-MM-dd HH:mm zz</pattern>
-              <locale>en_US</locale>
-              <timeZone>UTC</timeZone>
-            </configuration>
-          </execution>
-          <execution>
-            <id>parse-version</id>
-            <goals>
-              <goal>parse-version</goal>
-            </goals>
-          </execution>
-          <execution>
-            <phase>generate-sources</phase>
-            <goals>
-              <goal>add-source</goal>
-            </goals>
-            <configuration>
-              <sources>
-                <source>${project.build.directory}/generated-sources/java</source>
-              </sources>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-resources-plugin</artifactId>
-        <executions>
-          <execution>
-            <id>prepare-filtered-java-source</id>
-            <goals>
-              <goal>copy-resources</goal>
-            </goals>
-            <phase>generate-sources</phase>
-            <configuration>
-              <outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
-              <resources>
-                <resource>
-                  <directory>src/main/java-filtered</directory>
-                  <filtering>true</filtering>
-                </resource>
-              </resources>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
 
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

zookeeper-client/src/main/java/org/apache/zookeeper/ZKUtil.java

@@ -18,29 +18,24 @@
 
 package org.apache.zookeeper;
 
-import java.io.File;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 import java.util.Queue;
-import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.Semaphore;
 import java.util.concurrent.atomic.AtomicBoolean;
 import org.apache.zookeeper.AsyncCallback.MultiCallback;
 import org.apache.zookeeper.AsyncCallback.StringCallback;
 import org.apache.zookeeper.AsyncCallback.VoidCallback;
 import org.apache.zookeeper.KeeperException.Code;
 import org.apache.zookeeper.common.PathUtils;
-import org.apache.zookeeper.data.ACL;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class ZKUtil {
+public class ZKUtil extends ZKCommonUtil {
 
     private static final Logger LOG = LoggerFactory.getLogger(ZKUtil.class);
-    private static final Map<Integer, String> permCache = new ConcurrentHashMap<>();
     /**
      * Recursively delete the node with the given path.
      * <p>
@@ -166,24 +161,6 @@ public static void deleteRecursive(
         }
     }
 
-    /**
-     * @param filePath the file path to be validated
-     * @return Returns null if valid otherwise error message
-     */
-    public static String validateFileInput(String filePath) {
-        File file = new File(filePath);
-        if (!file.exists()) {
-            return "File '" + file.getAbsolutePath() + "' does not exist.";
-        }
-        if (!file.canRead()) {
-            return "Read permission is denied on the file '" + file.getAbsolutePath() + "'";
-        }
-        if (file.isDirectory()) {
-            return "'" + file.getAbsolutePath() + "' is a directory. it must be a file.";
-        }
-        return null;
-    }
-
     /**
      * BFS Traversal of the system under pathRoot, with the entries in the list, in the
      * same order as that of the traversal.
@@ -266,45 +243,4 @@ private static void visitSubTreeDFSHelper(
             return; // ignore
         }
     }
-
-    /**
-     * @param perms
-     *            ACL permissions
-     * @return string representation of permissions
-     */
-    public static String getPermString(int perms) {
-        return permCache.computeIfAbsent(perms, k -> constructPermString(k));
-    }
-
-    private static String constructPermString(int perms) {
-        StringBuilder p = new StringBuilder();
-        if ((perms & ZooDefs.Perms.CREATE) != 0) {
-            p.append('c');
-        }
-        if ((perms & ZooDefs.Perms.DELETE) != 0) {
-            p.append('d');
-        }
-        if ((perms & ZooDefs.Perms.READ) != 0) {
-            p.append('r');
-        }
-        if ((perms & ZooDefs.Perms.WRITE) != 0) {
-            p.append('w');
-        }
-        if ((perms & ZooDefs.Perms.ADMIN) != 0) {
-            p.append('a');
-        }
-        return p.toString();
-    }
-
-    public static String aclToString(List<ACL> acls) {
-        StringBuilder sb = new StringBuilder();
-        for (ACL acl : acls) {
-            sb.append(acl.getId().getScheme());
-            sb.append(":");
-            sb.append(acl.getId().getId());
-            sb.append(":");
-            sb.append(getPermString(acl.getPerms()));
-        }
-        return sb.toString();
-    }
 }

zookeeper-client/src/main/java/org/apache/zookeeper/client/ZKClientConfig.java

@@ -22,6 +22,7 @@
 import java.nio.file.Path;
 import org.apache.yetus.audience.InterfaceAudience;
 import org.apache.zookeeper.common.ConfigException;
+import org.apache.zookeeper.common.SaslLoginKeys;
 import org.apache.zookeeper.common.ZKConfig;
 
 /**
@@ -35,8 +36,8 @@ public class ZKClientConfig extends ZKConfig {
     public static final String ZK_SASL_CLIENT_USERNAME_DEFAULT = "zookeeper";
     public static final String ZK_SASL_CLIENT_CANONICALIZE_HOSTNAME = "zookeeper.sasl.client.canonicalize.hostname";
     public static final String ZK_SASL_CLIENT_CANONICALIZE_HOSTNAME_DEFAULT = "true";
-    public static final String LOGIN_CONTEXT_NAME_KEY = "zookeeper.sasl.clientconfig";
-    public static final String LOGIN_CONTEXT_NAME_KEY_DEFAULT = "Client";
+    public static final String LOGIN_CONTEXT_NAME_KEY = SaslLoginKeys.CLIENT_NAME_KEY;
+    public static final String LOGIN_CONTEXT_NAME_KEY_DEFAULT = SaslLoginKeys.CLIENT_NAME_KEY_DEFAULT;
     public static final String ENABLE_CLIENT_SASL_KEY = "zookeeper.sasl.client";
     public static final String ENABLE_CLIENT_SASL_DEFAULT = "true";
     public static final String ZOOKEEPER_SERVER_REALM = "zookeeper.server.realm";
@@ -121,6 +122,11 @@ protected void handleBackwardCompatibility() {
         setProperty(SECURE_CLIENT, System.getProperty(SECURE_CLIENT));
     }
 
+    @Override
+    public boolean isClient() {
+        return true;
+    }
+
     /**
      * Returns true if the SASL client is enabled. By default, the client is
      * enabled but can be disabled by setting the system property