Distribution

When creating an Equo application using the CLI, some libraries of the Equo SDK are downloaded and used from a Maven repository, because that’s the usual way to consume libs when developing a Java app. There are some scenarios where user applications have a different layout and, as a result, need to consume their dependencies in a different way. These use cases include OSGi and Eclipse applications.

In order to meet the different application needs to consume libs, our SDK is distributed in different ways:

  • as a Maven repository,

  • as an Eclipse P2 repository,

  • and as an OSGi repository.

Each of the following repositories contains the Equo SDK Community Edition, which is licensed under GPLv3. You can only used these repositories in open source projects that meet the GPLv3 conditions. If you want to use our SDK in a commercial application please contact us.

Using the Equo SDK in a Java Application with Maven

This is the default way, and the one that is used by our CLI when it creates Equo apps. To consume our libs in your Maven based project, you need to place the following lines in your pom.xml file:

<properties>
  <equo.version>1.1.3</equo.version>
  <maven.compiler.source>11</maven.compiler.source>
  <maven.compiler.target>11</maven.compiler.target>
</properties>

<dependencies>
  <dependency>
    <groupId>com.equo</groupId>
    <artifactId>com.equo.starter.bom</artifactId>
    <version>${equo.version}</version>
  </dependency>
  <dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.6</version>
  </dependency>
</dependencies>

<repositories>
  <repository>
    <id>equo-release</id>
    <name>Equo Public Release Repository</name>
    <url>https://dl.equo.dev/sdk/mvn/release</url>
  </repository>
</repositories>

Using the Equo SDK in a Java Application with Gradle

To consume our libs in your Gradle based project, you need to add the Equo plugin in the settings.gradle or settings.gradle.kts file:

buildscript {
    repositories {
        gradlePluginPortal()
        maven(url = "https://dl.equo.dev/gradle/0.6.2")
    }

    dependencies {
        classpath("com.equo:com.equo.gradle.plugin:0.6.2")
    }
}

apply(plugin = "com.equo")

Then, include the Equo repository and dependency in your build.gradle or build.gradle.kts file:

repositories {
    mavenCentral()
    maven(url = "https://dl.equo.dev/sdk/mvn/release")
}

dependencies {
    implementation("com.equo:com.equo.starter.bom:1.1.3")
}

Using the Equo SDK in an Eclipse Application

The Equo SDK P2 repository can be used to build Java and Eclipse based applications. It can be installed in Eclipse IDEs with the standard mechanism, viewed with viewers like Oomph Repository Explorer in Eclipse, and consumed in tycho/pde/bnd builds as any other P2 Repository. Note that the repositories are not searchable in a browser.

The P2 repository URL of the Equo SDK is:

https://dl.equo.dev/sdk/1.0/repo/

Using the Equo SDK in an OSGi Application

To use the SDK modules in a pure OSGi application, you just need to make reference to the following OSGi repository:

https://dl.equo.dev/sdk/1.0/repo/index.xml.gz

To start developing OSGi applications you should consider bndtools, which is a great starting point. It basically provides tooling for OSGi apps.