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
|
/*
* 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 org.pf4j;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* A plugin descriptor contains information about a plug-in obtained
* from the manifest (META-INF) file.
*
* @author Decebal Suiu
*/
public class PluginDescriptor {
private String pluginId;
private String pluginDescription;
private String pluginClass;
private String version;
private String requires = "*"; // SemVer format
private String provider;
private List<PluginDependency> dependencies;
private String license;
public PluginDescriptor() {
dependencies = new ArrayList<>();
}
/**
* Returns the unique identifier of this plugin.
*/
public String getPluginId() {
return pluginId;
}
/**
* Returns the description of this plugin.
*/
public String getPluginDescription() {
return pluginDescription;
}
/**
* Returns the name of the class that implements Plugin interface.
*/
public String getPluginClass() {
return pluginClass;
}
/**
* Returns the version of this plugin.
*/
public String getVersion() {
return version;
}
/**
* Returns string version of requires
* @return String with requires expression on SemVer format
*/
public String getRequires() {
return requires;
}
/**
* Returns the provider name of this plugin.
*/
public String getProvider() {
return provider;
}
/**
* Returns the legal license of this plugin, e.g. "Apache-2.0", "MIT" etc
*/
public String getLicense() {
return license;
}
/**
* Returns all dependencies declared by this plugin.
* Returns an empty array if this plugin does not declare any require.
*/
public List<PluginDependency> getDependencies() {
return dependencies;
}
@Override
public String toString() {
return "PluginDescriptor [pluginId=" + pluginId + ", pluginClass="
+ pluginClass + ", version=" + version + ", provider="
+ provider + ", dependencies=" + dependencies + ", description="
+ pluginDescription + ", requires=" + requires + ", license="
+ license + "]";
}
PluginDescriptor setPluginId(String pluginId) {
this.pluginId = pluginId;
return this;
}
PluginDescriptor setPluginDescription(String pluginDescription) {
this.pluginDescription = pluginDescription;
return this;
}
PluginDescriptor setPluginClass(String pluginClassName) {
this.pluginClass = pluginClassName;
return this;
}
PluginDescriptor setPluginVersion(String version) {
this.version = version;
return this;
}
PluginDescriptor setProvider(String provider) {
this.provider = provider;
return this;
}
PluginDescriptor setRequires(String requires) {
this.requires = requires;
return this;
}
PluginDescriptor setDependencies(String dependencies) {
if (dependencies != null) {
dependencies = dependencies.trim();
if (dependencies.isEmpty()) {
this.dependencies = Collections.emptyList();
} else {
this.dependencies = new ArrayList<>();
String[] tokens = dependencies.split(",");
for (String dependency : tokens) {
dependency = dependency.trim();
if (!dependency.isEmpty()) {
this.dependencies.add(new PluginDependency(dependency));
}
}
if (this.dependencies.isEmpty()) {
this.dependencies = Collections.emptyList();
}
}
} else {
this.dependencies = Collections.emptyList();
}
return this;
}
public PluginDescriptor setLicense(String license) {
this.license = license;
return this;
}
}
|
