blob: 690258fdd8730139041536bd15233ffe2f03b7a9 (
plain)
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
|
/*
* Copyright 2012 Decebal Suiu
*
* 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 ro.fortsoft.pf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class will be extended by all plugins and
* serve as the common class between a plugin and the application.
*
* @author Decebal Suiu
*/
public abstract class Plugin {
/**
* Makes logging service available for descending classes.
*/
protected final Logger log = LoggerFactory.getLogger(getClass());
/**
* Wrapper of the plugin.
*/
protected PluginWrapper wrapper;
/**
* Constructor to be used by plugin manager for plugin instantiation.
* Your plugins have to provide constructor with this exact signature to
* be successfully loaded by manager.
*/
public Plugin(final PluginWrapper wrapper) {
if (wrapper == null) {
throw new IllegalArgumentException("Wrapper cannot be null");
}
this.wrapper = wrapper;
}
/**
* Retrieves the wrapper of this plug-in.
*/
public final PluginWrapper getWrapper() {
return wrapper;
}
/**
* Start method is called by the application when the plugin is loaded.
*/
public void start() throws PluginException {
}
/**
* Stop method is called by the application when the plugin is unloaded.
*/
public void stop() throws PluginException {
}
}
|
