Repository files navigation

jUPnP is a Java UPnP library and has been forked from the no-longer maintainedCling project.

You can use jUPnP in your code by adding a dependency on it.See the Maven, Gradle etc. dependency examples onMaven Central.

Additional documentation is available onwww.jupnp.org.

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 itas easy as possible to get up to speed. If you know Maven already thenthere won't be any surprises for you. If you have not worked with Mavenyet, 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 fromhttps://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.git

To build jUPnP from the sources, Maven takes care of everything:

• change into the jupnp directory (cd jupnp)
• runmvn clean install to compile and package all sources

The build result will be available in the foldertarget.

To improve build times you can add the following options to the command:

For example you can skip tests and the Spotless checks during development with:

mvn clean install -DskipTests -Dspotless.check.skip=true

Adding 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 incodestyle.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:check

To reformat your code so it conforms to the code style you can run:

mvn spotless:apply

The OSGi integration tests in the "itests" directory use specific versions of bundles in the runbundles ofitest.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 -DwithResolver

When using Eclipse ensure that the JDK is set via the-vm option ineclipse.ini.Otherwise m2e might fail to resolve the system scoped dependency totools.jar.