Added some documentation for OSGi & Fix another OSGi deployment issue

README.md

@@ -119,3 +119,53 @@ The [OsgiGraphQLServlet](https://github.com/graphql-java/graphql-java-servlet/bl
 * [GraphQLTypesProvider](https://github.com/graphql-java/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLTypesProvider.java): Provides type information to the GraphQL schema.
 * [ExecutionStrategyProvider](https://github.com/graphql-java/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/ExecutionStrategyProvider.java): Provides an execution strategy for running each query.
 * [GraphQLContextBuilder](https://github.com/graphql-java/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLContextBuilder.java): Builds a context for running each query.
+
+## Examples
+
+You can now find some example on how to use graphql-java-servlet.
+
+### OSGi Examples
+
+#### Requirements
+
+The OSGi examples use Maven as a build tool because it requires plugins that are not (yet) available for Gradle.
+Therefore you will need Maven 3.2+.
+
+#### Building & running the OSGi examples
+
+You can build the OSGi examples sub-projects by simply executing the following command from the examples/osgi directory:
+
+    mvn clean install
+
+This will generate a complete Apache Karaf distribution in the following files:
+
+     examples/osgi/apache-karaf-package/target/graphql-java-servlet-osgi-examples-apache-karaf-package-VERSION.tar.gz(.zip)
+
+You can simply uncompress this file and launch the OSGi server using the command from the uncompressed directory:
+
+    bin/karaf
+
+You should then be able to access the GraphQL endpoint at the following URL once the server is started:
+
+    http://localhost:8181/graphql/schema.json
+
+If you see the JSON result of an introspection query, then all is ok. If not, check the data/log/karaf.log file for 
+any errors.
+
+We also provide a script file to do all of the building and running at once (only for Linux / MacOS ):
+
+    ./buildAndRun.sh
+
+#### Deploying inside Apache Karaf server
+
+You can use the graphql-java-servlet as part of an Apache Karaf feature, as you can see in the example project here:
+* [pom.xml](examples/osgi/apache-karaf-feature/pom.xml)
+
+And here is a sample src/main/feature/feature.xml file to add some dependencies on other features:
+* [feature.xml](examples/osgi/apache-karaf-feature/src/main/feature/feature.xml)
+
+#### Example GraphQL provider implementation
+
+Here's an example of a GraphQL provider that implements three interfaces at the same time.
+
+* [ExampleGraphQLProvider](examples/osgi/providers/src/main/java/graphql/servlet/examples/osgi/ExampleGraphQLProvider.java)

examples/osgi/apache-karaf-feature/pom.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+    <parent>
+        <groupId>com.graphql-java</groupId>
+        <artifactId>graphql-java-servlet-osgi-examples</artifactId>
+        <version>3.0.1</version>
+    </parent>
+
+    <artifactId>graphql-java-servlet-osgi-examples-karaf-feature</artifactId>
+    <packaging>feature</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>2.8.4</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>2.8.4</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.8.4</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jdk8</artifactId>
+            <version>2.8.4</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>20.0</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-fileupload</groupId>
+            <artifactId>commons-fileupload</artifactId>
+            <version>1.3.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.antlr</groupId>
+            <artifactId>antlr4-runtime</artifactId>
+            <version>4.5.1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java-servlet</artifactId>
+            <version>${graphql.java.servlet.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java</artifactId>
+            <version>${graphql.java.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java-annotations</artifactId>
+            <version>0.13.1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java-servlet-osgi-examples-providers</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.karaf.tooling</groupId>
+                <artifactId>karaf-maven-plugin</artifactId>
+                <version>4.0.8</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <startLevel>80</startLevel>
+                    <addTransitiveFeatures>true</addTransitiveFeatures>
+                    <includeTransitiveDependency>true</includeTransitiveDependency>
+                </configuration>
+            </plugin>
+        </plugins>
+
+    </build>
+
+</project>

examples/osgi/apache-karaf-feature/src/main/feature/feature.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<features xmlns="http://karaf.apache.org/xmlns/features/v1.4.0" name="graphql-java-servlet-osgi-examples-karaf-feature">
+    <feature name="graphql-java-servlet-osgi-examples-karaf-feature" description="graphql-java-servlet-osgi-examples-karaf-feature">
+        <feature prerequisite="true" dependency="false">scr</feature>
+        <feature prerequisite="true" dependency="false">war</feature>
+    </feature>
+</features>

examples/osgi/apache-karaf-package/pom.xml

@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+    <parent>
+        <groupId>com.graphql-java</groupId>
+        <artifactId>graphql-java-servlet-osgi-examples</artifactId>
+        <version>3.0.1</version>
+    </parent>
+
+    <artifactId>graphql-java-servlet-osgi-examples-apache-karaf-package</artifactId>
+    <packaging>karaf-assembly</packaging>
+
+    <dependencies>
+        <dependency>
+            <!-- scope is compile so all features (there is only one) are installed into startup.properties and the feature repo itself is not added in etc/org.apache.karaf.features.cfg file -->
+            <groupId>org.apache.karaf.features</groupId>
+            <artifactId>framework</artifactId>
+            <version>${karaf.version}</version>
+            <type>kar</type>
+        </dependency>
+        <dependency>
+            <!-- scope is runtime so the feature repo is listed in etc/org.apache.karaf.features.cfg file, and features will installed into the system directory if specify in the plugin configuration -->
+            <groupId>org.apache.karaf.features</groupId>
+            <artifactId>standard</artifactId>
+            <version>${karaf.version}</version>
+            <classifier>features</classifier>
+            <type>xml</type>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <!-- scope is runtime so the feature repo is listed in etc/org.apache.karaf.features.cfg file, and features will installed into the system directory if specify in the plugin configuration -->
+            <groupId>org.apache.karaf.features</groupId>
+            <artifactId>enterprise</artifactId>
+            <version>${karaf.version}</version>
+            <classifier>features</classifier>
+            <type>xml</type>
+            <scope>runtime</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java-servlet-osgi-examples-karaf-feature</artifactId>
+            <version>${project.version}</version>
+            <classifier>features</classifier>
+            <type>xml</type>
+            <scope>runtime</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <!-- if you want to include resources in the distribution -->
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>false</filtering>
+                <includes>
+                    <include>**/*</include>
+                </includes>
+            </resource>
+            <resource>
+                <directory>src/main/filtered-resources</directory>
+                <filtering>true</filtering>
+                <includes>
+                    <include>**/*</include>
+                </includes>
+            </resource>
+        </resources>
+
+        <plugins>
+            <!-- if you want to include resources in the distribution -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-resources-plugin</artifactId>
+                <version>2.6</version>
+                <executions>
+                    <execution>
+                        <id>process-resources</id>
+                        <goals>
+                            <goal>resources</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.karaf.tooling</groupId>
+                <artifactId>karaf-maven-plugin</artifactId>
+                <version>${karaf.version}</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <!-- no startupFeatures -->
+                    <bootFeatures>
+                        <feature>minimal</feature>
+                        <feature>wrapper</feature>
+                        <feature>graphql-java-servlet-osgi-examples-karaf-feature</feature>
+                    </bootFeatures>
+                    <installedFeatures>
+                    </installedFeatures>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

examples/osgi/buildAndRun.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+mvn clean install
+pushd apache-karaf-package/target
+tar zxvf graphql-java-servlet-osgi-examples-apache-karaf-package-3.0.1.tar.gz
+cd graphql-java-servlet-osgi-examples-apache-karaf-package-3.0.1/bin
+./karaf debug
+popd

examples/osgi/pom.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>com.graphql-java</groupId>
+    <artifactId>graphql-java-servlet-osgi-examples</artifactId>
+    <version>3.0.1</version>
+    <packaging>pom</packaging>
+
+    <properties>
+        <karaf.version>4.1.1</karaf.version>
+        <graphql.java.servlet.version>3.0.1</graphql.java.servlet.version>
+        <graphql.java.version>2.4.0</graphql.java.version>
+    </properties>
+
+    <modules>
+        <module>providers</module>
+        <module>apache-karaf-feature</module>
+        <module>apache-karaf-package</module>
+    </modules>
+
+</project>

examples/osgi/providers/pom.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+    <parent>
+        <groupId>com.graphql-java</groupId>
+        <artifactId>graphql-java-servlet-osgi-examples</artifactId>
+        <version>3.0.1</version>
+    </parent>
+
+    <artifactId>graphql-java-servlet-osgi-examples-providers</artifactId>
+    <packaging>bundle</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java-servlet</artifactId>
+            <version>${graphql.java.servlet.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.graphql-java</groupId>
+            <artifactId>graphql-java</artifactId>
+            <version>${graphql.java.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>osgi.enterprise</artifactId>
+            <version>6.0.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.scr.ds-annotations</artifactId>
+            <version>1.2.4</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <version>3.3.0</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <instructions>
+                    </instructions>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>