1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
* Copyright (C) 2012-present the original author or authors.
*
* Licensed 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.pf4j;
import java.nio.file.Path;
import java.util.List;
import java.util.Set;
/**
* Provides the functionality for plugin management such as load,
* start and stop the plugins.
*
* @author Decebal Suiu
*/
public interface PluginManager {
/**
* Retrieves all plugins.
*/
List<PluginWrapper> getPlugins();
/**
* Retrieves all plugins with this state.
*/
List<PluginWrapper> getPlugins(PluginState pluginState);
/**
* Retrieves all resolved plugins (with resolved dependency).
*/
List<PluginWrapper> getResolvedPlugins();
/**
* Retrieves all unresolved plugins (with unresolved dependency).
*/
List<PluginWrapper> getUnresolvedPlugins();
/**
* Retrieves all started plugins.
*/
List<PluginWrapper> getStartedPlugins();
/**
* Retrieves the plugin with this id, or null if the plugin does not exist.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return A PluginWrapper object for this plugin, or null if it does not exist.
*/
PluginWrapper getPlugin(String pluginId);
/**
* Load plugins.
*/
void loadPlugins();
/**
* Load a plugin.
*
* @param pluginPath the plugin location
* @return the pluginId of the installed plugin as specified in
* its {@linkplain PluginDescriptor metadata}
* @throws PluginException if load of plugin fails
*/
String loadPlugin(Path pluginPath) throws PluginException;
/**
* Start all active plugins.
*/
void startPlugins();
/**
* Start the specified plugin and its dependencies.
*
* @return the plugin state
*/
PluginState startPlugin(String pluginId) throws PluginException;
/**
* Stop all active plugins.
*/
void stopPlugins();
/**
* Stop the specified plugin and its dependencies.
*
* @return the plugin state
*/
PluginState stopPlugin(String pluginId) throws PluginException;
/**
* Unload a plugin.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if the plugin was unloaded
*/
boolean unloadPlugin(String pluginId) throws PluginException;
/**
* Disables a plugin from being loaded.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is disabled
*/
boolean disablePlugin(String pluginId) throws PluginException;
/**
* Enables a plugin that has previously been disabled.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if plugin is enabled
*/
boolean enablePlugin(String pluginId) throws PluginException;
/**
* Deletes a plugin.
*
* @param pluginId the unique plugin identifier, specified in its metadata
* @return true if the plugin was deleted
*/
boolean deletePlugin(String pluginId) throws PluginException;
ClassLoader getPluginClassLoader(String pluginId);
List<Class<?>> getExtensionClasses(String pluginId);
<T> List<Class<T>> getExtensionClasses(Class<T> type);
<T> List<Class<T>> getExtensionClasses(Class<T> type, String pluginId);
<T> List<T> getExtensions(Class<T> type);
<T> List<T> getExtensions(Class<T> type, String pluginId);
List getExtensions(String pluginId);
Set<String> getExtensionClassNames(String pluginId);
ExtensionFactory getExtensionFactory();
/**
* The runtime mode. Must currently be either DEVELOPMENT or DEPLOYMENT.
*/
RuntimeMode getRuntimeMode();
/**
* Returns {@code true} id the runtime mode is {@code RuntimeMode.DEVELOPMENT}.
*/
default boolean isDevelopment() {
return RuntimeMode.DEVELOPMENT.equals(getRuntimeMode());
}
/**
* Retrieves the {@link PluginWrapper} that loaded the given class 'clazz'.
*/
PluginWrapper whichPlugin(Class<?> clazz);
void addPluginStateListener(PluginStateListener listener);
void removePluginStateListener(PluginStateListener listener);
/**
* Set the system version. This is used to compare against the plugin
* requires attribute. The default system version is 0.0.0 which
* disables all version checking.
*
* @default 0.0.0
* @param version
*/
void setSystemVersion(String version);
/**
* Returns the system version.
*
* @return the system version
*/
String getSystemVersion();
/**
* Gets the path of the folder where plugins are installed
* @return Path of plugins root
*/
Path getPluginsRoot();
VersionManager getVersionManager();
}
|
