Skip to content

Latest commit

 

History

History
96 lines (83 loc) · 3.81 KB

README.md

File metadata and controls

96 lines (83 loc) · 3.81 KB
Raw

Google Code Jam - OSGi client API

Build Status Maven Central Join the chat at https://gitter.im/Faylixe/googlecodejam-client

This project is a simple port, of the existing fr.faylixe:googlecodejam-client artifact, into an OSGi bundle with dependencies embed. Bundle is created using maven-bundle-plugin and could be integrated in any OSGi project.

Maven dependency

Following dependency could be added to your POM.xml if you want to use the OSGi client API into your project.

<dependency>
    <groupId>fr.faylixe</groupId>
    <artifactId>googlecodejam-client-osgi</artifactId>
    <version>1.2.33</version>
</dependency>

Eclipse integration

In order to use it into an Eclipse plugin project, a custom target platform should be defined. To do so, you first need to create a non faceted project into your workspace, through menu File > New > Project ..., select then Project into the general section. Let's call this project custom-target-platform for this tutorial purpose.

Maven dependencies integration

Once project created, we will then create an empty folder that we will call repository. This folder will be the target directory of our OSGi dependencies.

So as to download required dependencies into this directory, we will add the following pom.xml file into our project :

<project
	xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>your_group_id</groupId>
	<artifactId>custom-target-platform</artifactId>
	<version>1.0</version>
	<packaging>pom</packaging>
	<properties>
		<outputDirectory>repository</outputDirectory>
	</properties>
  <!-- We add our required dependencies here -->
	<dependencies>
		<dependency>
			<groupId>fr.faylixe</groupId>
			<artifactId>googlecodejam-client-osgi</artifactId>
			<version>1.2.32</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-dependency-plugin</artifactId>
				<version>2.8</version>
				<executions>
					<execution>
						<id>copy-dependencies</id>
						<phase>initialize</phase>
						<goals>
							<goal>copy-dependencies</goal>
						</goals>
						<configuration>
							<overWriteReleases>false</overWriteReleases>
							<overWriteSnapshots>false</overWriteSnapshots>
							<overWriteIfNewer>true</overWriteIfNewer>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>

This POM will only download required dependencies into our target directory. To run it, just right click on your POM file into Eclipse, and select Run as > Maven install.

Target platform creation

Now that we have an automated procedure to retrieve required OSGi bundle from Maven Central, we have to integrate this directory into a dedicated target platform. To do so, just create a target definition file, from the existing active target platform, and add the repository using the following path : ${project_loc:/custom-target-platform}/repository. Once it is done, just click on Set as Target Plateform, and you will be able to access to your OSGi version of code jam API from any plugin context.