flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [flink] pnowojski commented on a change in pull request #8038: [FLINK-11953] Introduce Plugin/Loading system and integrate it with FileSystem
Date Mon, 08 Apr 2019 08:24:10 GMT
pnowojski commented on a change in pull request #8038: [FLINK-11953] Introduce Plugin/Loading
system and integrate it with FileSystem
URL: https://github.com/apache/flink/pull/8038#discussion_r272921337
 
 

 ##########
 File path: flink-core/src/main/java/org/apache/flink/core/plugin/DirectoryBasedPluginDescriptorsFactory.java
 ##########
 @@ -0,0 +1,108 @@
+/*
+ * 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.flink.core.plugin;
+
+import org.apache.flink.util.function.FunctionUtils;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.net.URL;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.PathMatcher;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+/**
+ * This class is used to create a collection of {@link PluginDescriptor} based on directory
structure for a given plugin
+ * root folder.
+ *
+ * <p>The expected structure is as follows: the given plugins root folder, containing
the plugins folder. One plugin folder
+ * contains all resources (jar files) belonging to a plugin. The name of the plugin folder
becomes the plugin id.
+ * <pre>
+ * plugins-root-folder/
+ *	         |------------plugin-a/ (folder of plugin a)
+ *	         |	              |-plugin-a-1.jar (the jars containing the classes of plugin a)
+ *	         |                |-plugin-a-2.jar
+ *	         |                |-...
+ *	         |
+ *	         |------------plugin-b/
+ *		     |                |-plugin-b-1.jar
+ *		    ...               |-...
+ * </pre>
+ */
+public class DirectoryBasedPluginDescriptorsFactory {
+
+	private static final Logger log = LoggerFactory.getLogger(DirectoryBasedPluginDescriptorsFactory.class);
+
+	private static final PathMatcher JAR_FILE_MATCHER =
+		FileSystems.getDefault().getPathMatcher("glob:**.jar");
+
+	private final Path pluginsRootDir;
+
+	public DirectoryBasedPluginDescriptorsFactory(Path pluginsRootDir) {
+		this.pluginsRootDir = pluginsRootDir;
+	}
+
+	//TODO this can go into an interface if there would be more strategies in the future.
+	public Collection<PluginDescriptor> createPluginDescriptors() throws IOException {
+		return Files.list(pluginsRootDir)
+			.filter((Path path) -> Files.isDirectory(path))
+			.map(FunctionUtils.uncheckedFunction(this::createPluginDescriptorForSubDirectory))
+			.filter(Optional::isPresent)
+			.map(Optional::get)
+			.collect(Collectors.toList());
+	}
+
+	private Optional<PluginDescriptor> createPluginDescriptorForSubDirectory(Path subDirectory)
{
+		Optional<URL[]> jarURLsFromDirectory = createJarURLsFromDirectory(subDirectory);
+		if (jarURLsFromDirectory.isPresent()) {
+			URL[] urls = jarURLsFromDirectory.get();
+			// we sort the urls for the benefit of having a stable/reproducible order of jars.
+			Arrays.sort(urls, Comparator.comparing(URL::toString));
+			//TODO: This class could be extended to parse exclude-pattern from a optional text files
in the plugin directories.
+			return Optional.of(
+				new PluginDescriptor(
+					subDirectory.getFileName().toString(),
+					urls,
+					new String[0]));
+		} else {
+			return Optional.empty();
+		}
+	}
+
+	private static Optional<URL[]> createJarURLsFromDirectory(Path subDirectory) {
+		URL[] urls = null;
+		try {
+			urls = Files.list(subDirectory)
+				.filter((Path p) -> Files.isRegularFile(p) && JAR_FILE_MATCHER.matches(p))
+				.map(FunctionUtils.uncheckedFunction((Path p) -> p.toUri().toURL()))
+				.toArray(URL[]::new);
+		} catch (Exception ex) {
+			log.warn("Exception while collecting the URLs of jar-files in plugin sub-directory {}.",
subDirectory, ex);
 
 Review comment:
   why is this warning only and you ignore the exception? Shouldn't this throw an error as
`createPluginDescriptors` does? Throwing the exception here would also allow you to drop the
`null` branch.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message