jUPnP is a Java UPnP library and has been forked from the no-longer maintained Cling project.
Building and running the project is fairly easy if you follow the steps detailed below.
The build infrastructure is based on Maven in order to make it as easy as possible to get up to speed. If you know Maven already then there won't be any surprises for you. If you have not worked with Maven yet, just follow the instructions and everything will miraculously work ;-)
What you need before you start:
- Java SDK 11 (please note that the build does NOT work with any higher version!)
- Maven 3 from https://maven.apache.org/download.html
Make sure that the "mvn" command is available on your path
Checkout the source code from GitHub, e.g. by running:
git clone https://github.com/jupnp/jupnp.gitTo build jUPnP from the sources, Maven takes care of everything:
- change into the jupnp directory (
cd jupnp) - run
mvn clean installto compile and package all sources
The build result will be available in the folder target.
To improve build times you can add the following options to the command:
| Option | Description |
|---|---|
-DskipTests |
Skip the execution of tests |
-Dmaven.test.skip=true |
Skip the compilation and execution of tests |
-Dmaven.javadoc.skip=true |
Skip the creation of Javadoc JARs |
-Dmaven.source.skip=true |
Skip the creation of source code JARs |
-Dlicense.skip=true |
Skip the license header checks |
-Dsort.skip=true |
Skip the POM sort order checks |
-Dspotless.check.skip=true |
Skip the Spotless code style checks |
-T 1C |
Build in parallel, using 1 thread per core |
For example you can skip tests and the Spotless checks during development with:
mvn clean install -DskipTests -Dspotless.check.skip=trueAdding these options improves the build time but could hide problems in your code. Parallel builds are also less easy to debug and the increased load may cause timing sensitive tests to fail.
The code style used by jUPnP is available as an Eclipse XML configuration in codestyle.xml. To use this configuration while coding, import the code style configuration into an IDE such as Eclipse or IntelliJ.
To check if your code is following the code style run:
mvn spotless:checkTo reformat your code so it conforms to the code style you can run:
mvn spotless:applyThe OSGi integration tests in the "itests" directory use specific versions of bundles in the runbundles of itest.bndrun.
You may need to update these runbundles after creating a new jupnp release or when changing dependencies.
Maven can resolve the runbundles automatically by executing:
mvn clean install -DwithResolverWhen using Eclipse ensure that the JDK is set via the -vm option in eclipse.ini.
Otherwise m2e might fail to resolve the system scoped dependency to tools.jar.