[PIP-50] Package management implementation (part-1)

managed-ledger/src/test/java/org/apache/bookkeeper/test/BookKeeperClusterTestCase.java

@@ -24,7 +24,6 @@
 package org.apache.bookkeeper.test;
 
 import io.netty.buffer.ByteBufAllocator;
-import io.netty.buffer.UnpooledByteBufAllocator;
 
 import java.io.File;
 import java.io.IOException;

pom.xml

@@ -107,6 +107,9 @@ flexible messaging model and an intuitive client API.</description>
     <module>pulsar-broker-auth-sasl</module>
     <module>pulsar-client-auth-sasl</module>
 
+    <!-- package management related modules -->
+    <module>pulsar-package-manager</module>
+
     <!-- transaction related modules -->
     <module>pulsar-transaction</module>
 

pulsar-package-manager/pom.xml

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>pulsar</artifactId>
+        <groupId>org.apache.pulsar</groupId>
+        <version>2.5.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>pulsar-package-manager</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>pulsar-metadata</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>pulsar-common</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.zookeeper</groupId>
+            <artifactId>zookeeper</artifactId>
+            <classifier>tests</classifier>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.bookkeeper</groupId>
+            <artifactId>bookkeeper-server</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>managed-ledger-original</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>log4j</groupId>
+            <artifactId>log4j</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+
+
+        <dependency>
+            <groupId>org.apache.distributedlog</groupId>
+            <artifactId>distributedlog-core</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>net.jpountz.lz4</groupId>
+                    <artifactId>lz4</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>check-style</id>
+                        <phase>verify</phase>
+                        <configuration>
+                            <configLocation>../buildtools/src/main/resources/pulsar/checkstyle.xml</configLocation>
+                            <suppressionsLocation>../buildtools/src/main/resources/pulsar/suppressions.xml</suppressionsLocation>
+                            <encoding>UTF-8</encoding>
+                        </configuration>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>

pulsar-package-manager/src/main/java/org/apache/pulsar/packages/manager/Package.java

@@ -0,0 +1,99 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.pulsar.packages.manager;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+import org.apache.pulsar.common.naming.NamespaceName;
+import org.apache.pulsar.packages.manager.naming.PackageName;
+import org.apache.pulsar.packages.manager.naming.PackageType;
+
+/**
+ * Package provides a way to manage the packages of function, sink, source.
+ */
+public interface Package {
+
+    /**
+     * Get the metadata of a package.
+     *
+     * @param packageName package name
+     * @return
+     */
+    CompletableFuture<PackageMetadata> getMeta(PackageName packageName);
+
+    /**
+     * Update the metadata of a package.
+     *
+     * @param packageName package name
+     * @param metadata
+     * @return
+     */
+    CompletableFuture<Void> updateMeta(PackageName packageName, PackageMetadata metadata);
+
+    /**
+     * Download a package of a given version to a given path.
+     *
+     * @param packageName package name
+     * @param outputStream
+     * @return
+     */
+    CompletableFuture<Void> download(PackageName packageName, OutputStream outputStream);
+
+    /**
+     * Upload a package of a given version from a given path.
+     *
+     * @param packageName package name
+     * @param metadata metadata of a package
+     * @param inputStream
+     * @return
+     */
+    CompletableFuture<Void> upload(PackageName packageName, PackageMetadata metadata, InputStream inputStream);
+
+    /**
+     * Delete a package.
+     * It will delete all versions of a package if the version is not specified.
+     * Otherwise it will delete the specified version package.
+     *
+     * @param packageName package name
+     *            type://tenant/namespace/name@version is delete a given version of the package
+     *            type://tenant/namespace/name is delete all versions of the package
+     * @return
+     */
+    CompletableFuture<Void> delete(PackageName packageName);
+
+    /**
+     * List all the versions of a package.
+     *
+     * @param packageName package name without version
+     * @return
+     */
+    CompletableFuture<List<PackageName>> list(PackageName packageName);
+
+    /**
+     * List all the packages with the type of a namespace.
+     *
+     * @param type the package type
+     * @param namespace the namespace name
+     * @return
+     */
+    CompletableFuture<List<PackageName>> list(PackageType type, NamespaceName namespace);
+}

pulsar-package-manager/src/main/java/org/apache/pulsar/packages/manager/PackageMetadata.java

@@ -0,0 +1,38 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.pulsar.packages.manager;
+
+import java.util.Map;
+
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * Package metadata.
+ */
+@Data
+@Builder
+public class PackageMetadata {
+    String description;
+    String contact;
+    long createTime;
+    long modificationTime;
+    Map<String, String> properties;
+}

pulsar-package-manager/src/main/java/org/apache/pulsar/packages/manager/PackageStorage.java

@@ -0,0 +1,81 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.pulsar.packages.manager;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Package storage is used to store the package files.
+ */
+public interface PackageStorage {
+
+
+    /**
+     * Write a input stream to a path.
+     *
+     * @param path file path
+     * @param inputStream
+     * @return
+     */
+    CompletableFuture<Void> writeAsync(String path, InputStream inputStream);
+
+    /**
+     * Read a file to a output stream.
+     *
+     * @param path file path
+     * @param outputStream
+     * @return
+     */
+    CompletableFuture<Void> readAsync(String path, OutputStream outputStream);
+
+    /**
+     * Delete a file.
+     *
+     * @param path file path
+     * @return
+     */
+    CompletableFuture<Void> deleteAsync(String path);
+
+    /**
+     * List all the file under a path.
+     *
+     * @param path directory path
+     * @return
+     */
+    CompletableFuture<List<String>> listAsync(String path);
+
+    /**
+     * Check the file is or not exists.
+     *
+     * @param path file path
+     * @return
+     */
+    CompletableFuture<Boolean> existAsync(String path);
+
+    /**
+     * Close storage asynchronously.
+     *
+     * @return
+     */
+    CompletableFuture<Void> closeAsync();
+}

pulsar-package-manager/src/main/java/org/apache/pulsar/packages/manager/PackageStorageConfig.java

@@ -0,0 +1,26 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.pulsar.packages.manager;
+
+/**
+ * An interface of package storage config.
+ */
+public interface PackageStorageConfig {
+}