@@ -1,4 +1,3 @@ | |||
build | |||
.gradle | |||
.idea | |||
app/plugins/ |
@@ -6,7 +6,7 @@ This demo assumes that you know the basics of Gradle (Please look at [gradle](ht | |||
1. Clone the repo | |||
2. Go to demo_gradle `cd demo_gradle` | |||
3. run `gradle build` | |||
3. run `./gradlew build` | |||
* This will produce one jar, named app-plugin-demo-uberjar.jar, located in the `app/build/libs/` directory and three plugins zips located in `build/plugins` directory. | |||
* The plugins are `plugin-hello-plugin-0.0.1.zip`, `plugin-KotlinPlugin-1.0.0.zip` and `plugin-welcome-plugin-0.0.1.zip` | |||
@@ -16,20 +16,20 @@ This demo assumes that you know the basics of Gradle (Please look at [gradle](ht | |||
1. Run | |||
``` | |||
java -jar -Dpf4j.pluginsDir=build/plugins app/build/libs/app-plugin-demo-uberjar.jar | |||
./gradlew app:run | |||
``` | |||
* pf4j.pluginsDir: is where the plugins are located | |||
2. The demo's output should look similar to: (Please see `Boot#main()` for more details) | |||
``` | |||
demo_gradle $ java -jar -Dpf4j.pluginsDir=build/plugins app/build/libs/app-plugin-demo-uberjar.jar | |||
[main] INFO org.pf4j.demo.Boot - ######################################## | |||
[main] INFO org.pf4j.demo.Boot - PF4J-DEMO | |||
[main] INFO org.pf4j.demo.Boot - PF4J-DEMO | |||
[main] INFO org.pf4j.demo.Boot - ######################################## | |||
[main] INFO org.pf4j.DefaultPluginStatusProvider - Enabled plugins: [] | |||
[main] INFO org.pf4j.DefaultPluginStatusProvider - Disabled plugins: [] | |||
[main] INFO org.pf4j.DefaultPluginManager - PF4J version 0.0.0 in 'deployment' mode | |||
[main] INFO org.pf4j.DefaultPluginManager - PF4J version 3.1.0 in 'deployment' mode | |||
[main] INFO org.pf4j.util.FileUtils - Expanded plugin zip 'plugin-hello-plugin-0.0.1.zip' in 'plugin-hello-plugin-0.0.1' | |||
[main] INFO org.pf4j.util.FileUtils - Expanded plugin zip 'plugin-KotlinPlugin-1.0.0.zip' in 'plugin-KotlinPlugin-1.0.0' | |||
[main] INFO org.pf4j.util.FileUtils - Expanded plugin zip 'plugin-welcome-plugin-0.0.1.zip' in 'plugin-welcome-plugin-0.0.1' | |||
[main] INFO org.pf4j.AbstractPluginManager - Plugin 'welcome-plugin@0.0.1' resolved | |||
[main] INFO org.pf4j.AbstractPluginManager - Plugin 'KotlinPlugin@1.0.0' resolved | |||
[main] INFO org.pf4j.AbstractPluginManager - Plugin 'hello-plugin@0.0.1' resolved | |||
@@ -41,12 +41,13 @@ demo_gradle $ java -jar -Dpf4j.pluginsDir=build/plugins app/build/libs/app-plugi | |||
[main] INFO org.pf4j.demo.kotlin.KotlinPlugin - KOTLINPLUGIN | |||
[main] INFO org.pf4j.AbstractPluginManager - Start plugin 'hello-plugin@0.0.1' | |||
[main] INFO org.pf4j.demo.hello.HelloPlugin - HelloPlugin.start() | |||
[main] INFO org.pf4j.demo.Boot - Plugindirectory: | |||
[main] INFO org.pf4j.demo.Boot - build/plugins | |||
[main] INFO org.pf4j.demo.Boot - Plugindirectory: | |||
[main] INFO org.pf4j.demo.Boot - ../build/plugins | |||
[main] INFO org.pf4j.demo.Boot - Found 3 extensions for extension point 'org.pf4j.demo.api.Greeting' | |||
[main] INFO org.pf4j.demo.Boot - Found 4 extensions for extension point 'org.pf4j.demo.api.Greeting' | |||
[main] INFO org.pf4j.demo.Boot - >>> Whazzup | |||
[main] INFO org.pf4j.demo.Boot - >>> Welcome | |||
[main] INFO org.pf4j.demo.Boot - >>> KotlinGreetings | |||
[main] INFO org.pf4j.demo.Boot - >>> Hello | |||
[main] INFO org.pf4j.demo.Boot - Extensions added by plugin 'welcome-plugin': | |||
[main] INFO org.pf4j.demo.Boot - Extensions added by plugin 'KotlinPlugin': | |||
@@ -57,6 +58,5 @@ demo_gradle $ java -jar -Dpf4j.pluginsDir=build/plugins app/build/libs/app-plugi | |||
[main] INFO org.pf4j.demo.kotlin.KotlinPlugin - KotlinPlugin.stop() | |||
[main] INFO org.pf4j.AbstractPluginManager - Stop plugin 'welcome-plugin@0.0.1' | |||
[main] INFO org.pf4j.demo.welcome.WelcomePlugin - WelcomePlugin.stop() | |||
``` | |||
@@ -1,10 +1,14 @@ | |||
apply plugin: 'application' | |||
mainClassName = 'org.pf4j.demo.Boot' | |||
run { | |||
systemProperty 'pf4j.pluginsDir', '../build/plugins' | |||
} | |||
dependencies { | |||
compile project(':api') | |||
compile group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}" | |||
annotationProcessor(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") | |||
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.5' | |||
compile group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.25' | |||
@@ -13,19 +17,19 @@ dependencies { | |||
task uberjar(type: Jar, dependsOn: ['compileJava']) { | |||
zip64 true | |||
from configurations.runtime.asFileTree.files.collect { | |||
from configurations.runtimeClasspath.asFileTree.files.collect { | |||
exclude "META-INF/*.SF" | |||
exclude "META-INF/*.DSA" | |||
exclude "META-INF/*.RSA" | |||
zipTree(it) | |||
} | |||
from files(sourceSets.main.output.classesDir) | |||
from files(sourceSets.main.output.classesDirs) | |||
from files(sourceSets.main.resources) | |||
manifest { | |||
attributes 'Main-Class': mainClassName | |||
} | |||
baseName = "${project.name}-plugin-demo" | |||
classifier = "uberjar" | |||
archiveBaseName = "${project.name}-plugin-demo" | |||
archiveClassifier = "uberjar" | |||
} | |||
@@ -1,2 +1,2 @@ | |||
# PF4J | |||
pf4jVersion=2.0.0 | |||
pf4jVersion=3.1.0 |
@@ -0,0 +1,6 @@ | |||
#Thu Nov 14 12:06:04 CST 2019 | |||
distributionUrl=https\://services.gradle.org/distributions/gradle-6.0-all.zip | |||
distributionBase=GRADLE_USER_HOME | |||
distributionPath=wrapper/dists | |||
zipStorePath=wrapper/dists | |||
zipStoreBase=GRADLE_USER_HOME |
@@ -0,0 +1,183 @@ | |||
#!/usr/bin/env sh | |||
# | |||
# Copyright 2015 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 | |||
# | |||
# https://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. | |||
# | |||
############################################################################## | |||
## | |||
## Gradle start up script for UN*X | |||
## | |||
############################################################################## | |||
# Attempt to set APP_HOME | |||
# Resolve links: $0 may be a link | |||
PRG="$0" | |||
# Need this for relative symlinks. | |||
while [ -h "$PRG" ] ; do | |||
ls=`ls -ld "$PRG"` | |||
link=`expr "$ls" : '.*-> \(.*\)$'` | |||
if expr "$link" : '/.*' > /dev/null; then | |||
PRG="$link" | |||
else | |||
PRG=`dirname "$PRG"`"/$link" | |||
fi | |||
done | |||
SAVED="`pwd`" | |||
cd "`dirname \"$PRG\"`/" >/dev/null | |||
APP_HOME="`pwd -P`" | |||
cd "$SAVED" >/dev/null | |||
APP_NAME="Gradle" | |||
APP_BASE_NAME=`basename "$0"` | |||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. | |||
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' | |||
# Use the maximum available, or set MAX_FD != -1 to use that value. | |||
MAX_FD="maximum" | |||
warn () { | |||
echo "$*" | |||
} | |||
die () { | |||
echo | |||
echo "$*" | |||
echo | |||
exit 1 | |||
} | |||
# OS specific support (must be 'true' or 'false'). | |||
cygwin=false | |||
msys=false | |||
darwin=false | |||
nonstop=false | |||
case "`uname`" in | |||
CYGWIN* ) | |||
cygwin=true | |||
;; | |||
Darwin* ) | |||
darwin=true | |||
;; | |||
MINGW* ) | |||
msys=true | |||
;; | |||
NONSTOP* ) | |||
nonstop=true | |||
;; | |||
esac | |||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar | |||
# Determine the Java command to use to start the JVM. | |||
if [ -n "$JAVA_HOME" ] ; then | |||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then | |||
# IBM's JDK on AIX uses strange locations for the executables | |||
JAVACMD="$JAVA_HOME/jre/sh/java" | |||
else | |||
JAVACMD="$JAVA_HOME/bin/java" | |||
fi | |||
if [ ! -x "$JAVACMD" ] ; then | |||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME | |||
Please set the JAVA_HOME variable in your environment to match the | |||
location of your Java installation." | |||
fi | |||
else | |||
JAVACMD="java" | |||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. | |||
Please set the JAVA_HOME variable in your environment to match the | |||
location of your Java installation." | |||
fi | |||
# Increase the maximum file descriptors if we can. | |||
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then | |||
MAX_FD_LIMIT=`ulimit -H -n` | |||
if [ $? -eq 0 ] ; then | |||
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then | |||
MAX_FD="$MAX_FD_LIMIT" | |||
fi | |||
ulimit -n $MAX_FD | |||
if [ $? -ne 0 ] ; then | |||
warn "Could not set maximum file descriptor limit: $MAX_FD" | |||
fi | |||
else | |||
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" | |||
fi | |||
fi | |||
# For Darwin, add options to specify how the application appears in the dock | |||
if $darwin; then | |||
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" | |||
fi | |||
# For Cygwin or MSYS, switch paths to Windows format before running java | |||
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then | |||
APP_HOME=`cygpath --path --mixed "$APP_HOME"` | |||
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` | |||
JAVACMD=`cygpath --unix "$JAVACMD"` | |||
# We build the pattern for arguments to be converted via cygpath | |||
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` | |||
SEP="" | |||
for dir in $ROOTDIRSRAW ; do | |||
ROOTDIRS="$ROOTDIRS$SEP$dir" | |||
SEP="|" | |||
done | |||
OURCYGPATTERN="(^($ROOTDIRS))" | |||
# Add a user-defined pattern to the cygpath arguments | |||
if [ "$GRADLE_CYGPATTERN" != "" ] ; then | |||
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" | |||
fi | |||
# Now convert the arguments - kludge to limit ourselves to /bin/sh | |||
i=0 | |||
for arg in "$@" ; do | |||
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` | |||
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option | |||
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition | |||
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` | |||
else | |||
eval `echo args$i`="\"$arg\"" | |||
fi | |||
i=`expr $i + 1` | |||
done | |||
case $i in | |||
0) set -- ;; | |||
1) set -- "$args0" ;; | |||
2) set -- "$args0" "$args1" ;; | |||
3) set -- "$args0" "$args1" "$args2" ;; | |||
4) set -- "$args0" "$args1" "$args2" "$args3" ;; | |||
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; | |||
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; | |||
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; | |||
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; | |||
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; | |||
esac | |||
fi | |||
# Escape application args | |||
save () { | |||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done | |||
echo " " | |||
} | |||
APP_ARGS=`save "$@"` | |||
# Collect all arguments for the java command, following the shell quoting and substitution rules | |||
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" | |||
exec "$JAVACMD" "$@" |
@@ -0,0 +1,100 @@ | |||
@rem | |||
@rem Copyright 2015 the original author or authors. | |||
@rem | |||
@rem Licensed under the Apache License, Version 2.0 (the "License"); | |||
@rem you may not use this file except in compliance with the License. | |||
@rem You may obtain a copy of the License at | |||
@rem | |||
@rem https://www.apache.org/licenses/LICENSE-2.0 | |||
@rem | |||
@rem Unless required by applicable law or agreed to in writing, software | |||
@rem distributed under the License is distributed on an "AS IS" BASIS, | |||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
@rem See the License for the specific language governing permissions and | |||
@rem limitations under the License. | |||
@rem | |||
@if "%DEBUG%" == "" @echo off | |||
@rem ########################################################################## | |||
@rem | |||
@rem Gradle startup script for Windows | |||
@rem | |||
@rem ########################################################################## | |||
@rem Set local scope for the variables with windows NT shell | |||
if "%OS%"=="Windows_NT" setlocal | |||
set DIRNAME=%~dp0 | |||
if "%DIRNAME%" == "" set DIRNAME=. | |||
set APP_BASE_NAME=%~n0 | |||
set APP_HOME=%DIRNAME% | |||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. | |||
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" | |||
@rem Find java.exe | |||
if defined JAVA_HOME goto findJavaFromJavaHome | |||
set JAVA_EXE=java.exe | |||
%JAVA_EXE% -version >NUL 2>&1 | |||
if "%ERRORLEVEL%" == "0" goto init | |||
echo. | |||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. | |||
echo. | |||
echo Please set the JAVA_HOME variable in your environment to match the | |||
echo location of your Java installation. | |||
goto fail | |||
:findJavaFromJavaHome | |||
set JAVA_HOME=%JAVA_HOME:"=% | |||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe | |||
if exist "%JAVA_EXE%" goto init | |||
echo. | |||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% | |||
echo. | |||
echo Please set the JAVA_HOME variable in your environment to match the | |||
echo location of your Java installation. | |||
goto fail | |||
:init | |||
@rem Get command-line arguments, handling Windows variants | |||
if not "%OS%" == "Windows_NT" goto win9xME_args | |||
:win9xME_args | |||
@rem Slurp the command line arguments. | |||
set CMD_LINE_ARGS= | |||
set _SKIP=2 | |||
:win9xME_args_slurp | |||
if "x%~1" == "x" goto execute | |||
set CMD_LINE_ARGS=%* | |||
:execute | |||
@rem Setup the command line | |||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar | |||
@rem Execute Gradle | |||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% | |||
:end | |||
@rem End local scope for the variables with windows NT shell | |||
if "%ERRORLEVEL%"=="0" goto mainEnd | |||
:fail | |||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of | |||
rem the _cmd.exe /c_ return code! | |||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 | |||
exit /b 1 | |||
:mainEnd | |||
if "%OS%"=="Windows_NT" endlocal | |||
:omega |
@@ -3,20 +3,20 @@ subprojects { | |||
manifest { | |||
attributes 'Plugin-Class': "${pluginClass}", | |||
'Plugin-Id': "${pluginId}", | |||
'Plugin-Version': "${version}", | |||
'Plugin-Version': "${archiveVersion}", | |||
'Plugin-Provider': "${pluginProvider}" | |||
} | |||
} | |||
task plugin(type: Jar) { | |||
baseName = "plugin-${pluginId}" | |||
archiveBaseName = "plugin-${pluginId}" | |||
into('classes') { | |||
with jar | |||
} | |||
into('lib') { | |||
from configurations.compile | |||
} | |||
extension('zip') | |||
archiveExtension ='zip' | |||
} | |||
task assemblePlugin(type: Copy) { |
@@ -4,6 +4,7 @@ dependencies { | |||
compileOnly(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") { | |||
exclude group: "org.slf4j" | |||
} | |||
annotationProcessor(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") | |||
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.5' | |||
testCompile group: 'junit', name: 'junit', version: '4.+' | |||
} |
@@ -4,6 +4,7 @@ dependencies { | |||
compileOnly(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") { | |||
exclude group: "org.slf4j" | |||
} | |||
annotationProcessor(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") | |||
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.5' | |||
testCompile group: 'junit', name: 'junit', version: '4.+' | |||
} |
@@ -1,5 +1,5 @@ | |||
buildscript { | |||
ext.kotlin_version = '1.1.2-2' | |||
ext.kotlin_version = '1.3.50' | |||
repositories { | |||
mavenCentral() | |||
@@ -21,8 +21,9 @@ dependencies { | |||
compileOnly(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") { | |||
exclude group: "org.slf4j" | |||
} | |||
kapt(group: 'org.pf4j', name: 'pf4j', version: "${pf4jVersion}") | |||
compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.5' | |||
compile "org.jetbrains.kotlin:kotlin-stdlib-jre8:$kotlin_version" | |||
compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version" | |||
testCompile group: 'junit', name: 'junit', version: '4.+' | |||
} |