-package org.pf4j;\r
-\r
-import java.nio.file.Path;\r
-import java.util.ArrayList;\r
-import java.util.Arrays;\r
-import java.util.Collections;\r
-import java.util.List;\r
-import java.util.Set;\r
-import java.util.stream.Collectors;\r
-\r
-/**\r
- * Use this class to wrap the original plugin manager to prevent full access from within plugins.\r
- * Override AbstractPluginManager.createPluginWrapper to use this class\r
- * @author Wolfram Haussig\r
- *\r
- */\r
-public class SecurePluginManagerWrapper implements PluginManager {\r
-\r
- private static final String PLUGIN_PREFIX = "Plugin ";\r
- /**\r
- * the current plugin\r
- */\r
- private String currentPluginId;\r
- /**\r
- * the original plugin manager\r
- */\r
- private PluginManager original;\r
-\r
- /**\r
- * The registered {@link PluginStateListener}s.\r
- */\r
- protected List<PluginStateListener> pluginStateListeners = new ArrayList<>();\r
- /**\r
- * wrapper for pluginStateListeners\r
- */\r
- private PluginStateListenerWrapper listenerWrapper = new PluginStateListenerWrapper();\r
-\r
- /**\r
- * constructor\r
- * @param original the original plugin manager\r
- * @param currentPlugin the current pluginId\r
- */\r
- public SecurePluginManagerWrapper(PluginManager original, String currentPluginId) {\r
- this.original = original;\r
- this.currentPluginId = currentPluginId;\r
- }\r
-\r
- @Override\r
- public boolean isDevelopment() {\r
- return original.isDevelopment();\r
- }\r
-\r
- @Override\r
- public boolean isNotDevelopment() {\r
- return original.isNotDevelopment();\r
- }\r
-\r
- @Override\r
- public List<PluginWrapper> getPlugins() {\r
- return Arrays.asList(getPlugin(currentPluginId));\r
- }\r
-\r
- @Override\r
- public List<PluginWrapper> getPlugins(PluginState pluginState) {\r
- return getPlugins().stream().filter(p -> p.getPluginState() == pluginState).collect(Collectors.toList());\r
- }\r
-\r
- @Override\r
- public List<PluginWrapper> getResolvedPlugins() {\r
- return getPlugins().stream().filter(p -> p.getPluginState().ordinal() >= PluginState.RESOLVED.ordinal()).collect(Collectors.toList());\r
- }\r
-\r
- @Override\r
- public List<PluginWrapper> getUnresolvedPlugins() {\r
- return Collections.emptyList();\r
- }\r
-\r
- @Override\r
- public List<PluginWrapper> getStartedPlugins() {\r
- return getPlugins(PluginState.STARTED);\r
- }\r
-\r
- @Override\r
- public PluginWrapper getPlugin(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getPlugin(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPlugin for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public void loadPlugins() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute loadPlugins!");\r
- }\r
-\r
- @Override\r
- public String loadPlugin(Path pluginPath) {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute loadPlugin!");\r
- }\r
-\r
- @Override\r
- public void startPlugins() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute startPlugins!");\r
- }\r
-\r
- @Override\r
- public PluginState startPlugin(String pluginId) {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute startPlugin!");\r
- }\r
-\r
- @Override\r
- public void stopPlugins() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute stopPlugins!");\r
- }\r
-\r
- @Override\r
- public PluginState stopPlugin(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.stopPlugin(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute stopPlugin for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public void unloadPlugins() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute unloadPlugins!");\r
- }\r
-\r
- @Override\r
- public boolean unloadPlugin(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.unloadPlugin(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute unloadPlugin for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public boolean disablePlugin(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.disablePlugin(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute disablePlugin for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public boolean enablePlugin(String pluginId) {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute enablePlugin!");\r
- }\r
-\r
- @Override\r
- public boolean deletePlugin(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.deletePlugin(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute deletePlugin for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public ClassLoader getPluginClassLoader(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getPluginClassLoader(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginClassLoader for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public List<Class<?>> getExtensionClasses(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getExtensionClasses(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClasses for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public <T> List<Class<? extends T>> getExtensionClasses(Class<T> type) {\r
- return getExtensionClasses(type, currentPluginId);\r
- }\r
-\r
- @Override\r
- public <T> List<Class<? extends T>> getExtensionClasses(Class<T> type, String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getExtensionClasses(type, pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClasses for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public <T> List<T> getExtensions(Class<T> type) {\r
- return getExtensions(type, currentPluginId);\r
- }\r
-\r
- @Override\r
- public <T> List<T> getExtensions(Class<T> type, String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getExtensions(type, pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensions for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public List<?> getExtensions(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getExtensions(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensions for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public Set<String> getExtensionClassNames(String pluginId) {\r
- if (currentPluginId.equals(pluginId)) {\r
- return original.getExtensionClassNames(pluginId);\r
- } else {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClassNames for foreign pluginId!");\r
- }\r
- }\r
-\r
- @Override\r
- public ExtensionFactory getExtensionFactory() {\r
- return original.getExtensionFactory();\r
- }\r
-\r
- @Override\r
- public RuntimeMode getRuntimeMode() {\r
- return original.getRuntimeMode();\r
- }\r
-\r
- @Override\r
- public PluginWrapper whichPlugin(Class<?> clazz) {\r
- ClassLoader classLoader = clazz.getClassLoader();\r
- PluginWrapper plugin = getPlugin(currentPluginId);\r
- if (plugin.getPluginClassLoader() == classLoader) {\r
- return plugin;\r
- }\r
- return null;\r
- }\r
-\r
- @Override\r
- public void addPluginStateListener(PluginStateListener listener) {\r
- if (pluginStateListeners.isEmpty()) {\r
- this.original.addPluginStateListener(listenerWrapper);\r
- }\r
- pluginStateListeners.add(listener);\r
- }\r
-\r
- @Override\r
- public void removePluginStateListener(PluginStateListener listener) {\r
- pluginStateListeners.remove(listener);\r
- if (pluginStateListeners.isEmpty()) {\r
- this.original.removePluginStateListener(listenerWrapper);\r
- }\r
- }\r
-\r
- @Override\r
- public void setSystemVersion(String version) {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute setSystemVersion!");\r
- }\r
-\r
- @Override\r
- public String getSystemVersion() {\r
- return original.getSystemVersion();\r
- }\r
-\r
- @Override\r
- public Path getPluginsRoot() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginsRoot!");\r
- }\r
-\r
- @Override\r
- public List<Path> getPluginsRoots() {\r
- throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginsRoots!");\r
- }\r
-\r
- @Override\r
- public VersionManager getVersionManager() {\r
- return original.getVersionManager();\r
- }\r
-\r
- /**\r
- * Wrapper for PluginStateListener events. will only propagate events if they match the current pluginId\r
- * @author Wolfram Haussig\r
- *\r
- */\r
- private class PluginStateListenerWrapper implements PluginStateListener {\r
-\r
- @Override\r
- public void pluginStateChanged(PluginStateEvent event) {\r
- if (event.getPlugin().getPluginId().equals(currentPluginId)) {\r
- for (PluginStateListener listener : pluginStateListeners) {\r
- listener.pluginStateChanged(event);\r
- }\r
- }\r
- }\r
-\r
- }\r
-}\r
+package org.pf4j;
+
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * Use this class to wrap the original plugin manager to prevent full access from within plugins.
+ * Override AbstractPluginManager.createPluginWrapper to use this class.
+ * @deprecated Use application custom {@code PluginContext} instead of {@code PluginWrapper} to communicate with {@link Plugin}.
+ * See demo for more details.
+ *
+ * @author Wolfram Haussig
+ */
+@Deprecated()
+public class SecurePluginManagerWrapper implements PluginManager {
+
+ private static final String PLUGIN_PREFIX = "Plugin ";
+ /**
+ * the current plugin
+ */
+ private String currentPluginId;
+ /**
+ * the original plugin manager
+ */
+ private PluginManager original;
+
+ /**
+ * The registered {@link PluginStateListener}s.
+ */
+ protected List<PluginStateListener> pluginStateListeners = new ArrayList<>();
+ /**
+ * wrapper for pluginStateListeners
+ */
+ private PluginStateListenerWrapper listenerWrapper = new PluginStateListenerWrapper();
+
+ /**
+ * constructor
+ * @param original the original plugin manager
+ * @param currentPluginId the current pluginId
+ */
+ public SecurePluginManagerWrapper(PluginManager original, String currentPluginId) {
+ this.original = original;
+ this.currentPluginId = currentPluginId;
+ }
+
+ @Override
+ public boolean isDevelopment() {
+ return original.isDevelopment();
+ }
+
+ @Override
+ public boolean isNotDevelopment() {
+ return original.isNotDevelopment();
+ }
+
+ @Override
+ public List<PluginWrapper> getPlugins() {
+ return Arrays.asList(getPlugin(currentPluginId));
+ }
+
+ @Override
+ public List<PluginWrapper> getPlugins(PluginState pluginState) {
+ return getPlugins().stream().filter(p -> p.getPluginState() == pluginState).collect(Collectors.toList());
+ }
+
+ @Override
+ public List<PluginWrapper> getResolvedPlugins() {
+ return getPlugins().stream().filter(p -> p.getPluginState().ordinal() >= PluginState.RESOLVED.ordinal()).collect(Collectors.toList());
+ }
+
+ @Override
+ public List<PluginWrapper> getUnresolvedPlugins() {
+ return Collections.emptyList();
+ }
+
+ @Override
+ public List<PluginWrapper> getStartedPlugins() {
+ return getPlugins(PluginState.STARTED);
+ }
+
+ @Override
+ public PluginWrapper getPlugin(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getPlugin(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPlugin for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public void loadPlugins() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute loadPlugins!");
+ }
+
+ @Override
+ public String loadPlugin(Path pluginPath) {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute loadPlugin!");
+ }
+
+ @Override
+ public void startPlugins() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute startPlugins!");
+ }
+
+ @Override
+ public PluginState startPlugin(String pluginId) {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute startPlugin!");
+ }
+
+ @Override
+ public void stopPlugins() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute stopPlugins!");
+ }
+
+ @Override
+ public PluginState stopPlugin(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.stopPlugin(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute stopPlugin for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public void unloadPlugins() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute unloadPlugins!");
+ }
+
+ @Override
+ public boolean unloadPlugin(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.unloadPlugin(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute unloadPlugin for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public boolean disablePlugin(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.disablePlugin(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute disablePlugin for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public boolean enablePlugin(String pluginId) {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute enablePlugin!");
+ }
+
+ @Override
+ public boolean deletePlugin(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.deletePlugin(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute deletePlugin for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public ClassLoader getPluginClassLoader(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getPluginClassLoader(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginClassLoader for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public List<Class<?>> getExtensionClasses(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getExtensionClasses(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClasses for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public <T> List<Class<? extends T>> getExtensionClasses(Class<T> type) {
+ return getExtensionClasses(type, currentPluginId);
+ }
+
+ @Override
+ public <T> List<Class<? extends T>> getExtensionClasses(Class<T> type, String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getExtensionClasses(type, pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClasses for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public <T> List<T> getExtensions(Class<T> type) {
+ return getExtensions(type, currentPluginId);
+ }
+
+ @Override
+ public <T> List<T> getExtensions(Class<T> type, String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getExtensions(type, pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensions for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public List<?> getExtensions(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getExtensions(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensions for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public Set<String> getExtensionClassNames(String pluginId) {
+ if (currentPluginId.equals(pluginId)) {
+ return original.getExtensionClassNames(pluginId);
+ } else {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getExtensionClassNames for foreign pluginId!");
+ }
+ }
+
+ @Override
+ public ExtensionFactory getExtensionFactory() {
+ return original.getExtensionFactory();
+ }
+
+ @Override
+ public RuntimeMode getRuntimeMode() {
+ return original.getRuntimeMode();
+ }
+
+ @Override
+ public PluginWrapper whichPlugin(Class<?> clazz) {
+ ClassLoader classLoader = clazz.getClassLoader();
+ PluginWrapper plugin = getPlugin(currentPluginId);
+ if (plugin.getPluginClassLoader() == classLoader) {
+ return plugin;
+ }
+ return null;
+ }
+
+ @Override
+ public void addPluginStateListener(PluginStateListener listener) {
+ if (pluginStateListeners.isEmpty()) {
+ this.original.addPluginStateListener(listenerWrapper);
+ }
+ pluginStateListeners.add(listener);
+ }
+
+ @Override
+ public void removePluginStateListener(PluginStateListener listener) {
+ pluginStateListeners.remove(listener);
+ if (pluginStateListeners.isEmpty()) {
+ this.original.removePluginStateListener(listenerWrapper);
+ }
+ }
+
+ @Override
+ public void setSystemVersion(String version) {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute setSystemVersion!");
+ }
+
+ @Override
+ public String getSystemVersion() {
+ return original.getSystemVersion();
+ }
+
+ @Override
+ public Path getPluginsRoot() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginsRoot!");
+ }
+
+ @Override
+ public List<Path> getPluginsRoots() {
+ throw new IllegalAccessError(PLUGIN_PREFIX + currentPluginId + " tried to execute getPluginsRoots!");
+ }
+
+ @Override
+ public VersionManager getVersionManager() {
+ return original.getVersionManager();
+ }
+
+ /**
+ * Wrapper for PluginStateListener events. will only propagate events if they match the current pluginId
+ * @author Wolfram Haussig
+ *
+ */
+ private class PluginStateListenerWrapper implements PluginStateListener {
+
+ @Override
+ public void pluginStateChanged(PluginStateEvent event) {
+ if (event.getPlugin().getPluginId().equals(currentPluginId)) {
+ for (PluginStateListener listener : pluginStateListeners) {
+ listener.pluginStateChanged(event);
+ }
+ }
+ }
+
+ }
+}
projects / pf4j.git / commitdiff