From 6a8343c01da4b8dbdfffe997dd50376b16613993 Mon Sep 17 00:00:00 2001
From: Gregor Pfeifer <gregor.pfeifer.gp@gmail.com>
Date: Wed, 31 Jan 2024 20:21:41 +0100
Subject: [PATCH] Add an example of a Jersey OSGi bundle for Jetty 12 (ee8)

Signed-off-by: Gregor Pfeifer <gregor.pfeifer.gp@gmail.com>
---
 .../.gitignore                                |   1 +
 .../osgi-helloworld-webapp-jetty-12/README.md |  47 ++++++
 .../osgi-helloworld-webapp-jetty-12/pom.xml   |  47 ++++++
 .../war-bundle/.gitignore                     |   3 +
 .../war-bundle/README.md                      |  11 ++
 .../war-bundle/pom.xml                        | 145 ++++++++++++++++++
 .../osgi/helloworld/HelloResource.java        |  29 ++++
 .../osgi/helloworld/HelloResourceConfig.java  |  31 ++++
 .../src/main/webapp/WEB-INF/web.xml           |  31 ++++
 9 files changed, 345 insertions(+)
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/.gitignore
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/README.md
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/pom.xml
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/.gitignore
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/README.md
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/pom.xml
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResource.java
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResourceConfig.java
 create mode 100644 examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/webapp/WEB-INF/web.xml

diff --git a/examples/osgi-helloworld-webapp-jetty-12/.gitignore b/examples/osgi-helloworld-webapp-jetty-12/.gitignore
new file mode 100644
index 0000000000..9f970225ad
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/.gitignore
@@ -0,0 +1 @@
+target/
\ No newline at end of file
diff --git a/examples/osgi-helloworld-webapp-jetty-12/README.md b/examples/osgi-helloworld-webapp-jetty-12/README.md
new file mode 100644
index 0000000000..40b98f671c
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/README.md
@@ -0,0 +1,47 @@
+[//]: # " Copyright (c) 2015, 2018 Oracle and/or its affiliates. All rights reserved. "
+[//]: # " "
+[//]: # " This program and the accompanying materials are made available under the "
+[//]: # " terms of the Eclipse Distribution License v. 1.0, which is available at "
+[//]: # " http://www.eclipse.org/org/documents/edl-v10.php. "
+[//]: # " "
+[//]: # " SPDX-License-Identifier: BSD-3-Clause "
+
+HelloWorld OSGi Example
+=======================
+
+This example demonstrates how to develop a simple OSGi WAR bundle
+containing a RESTful hello world web service
+
+Contents
+--------
+
+The example WAR (see the `war-bundle` module) consists of two Jersey
+resources:
+
+`org.glassfish.jersey.examples.osgi.helloworld.resource.HelloWorldResource`
+
+that produces a textual response to an HTTP GET
+
+`org.glassfish.jersey.examples.osgi.helloworld.resource.AnotherResource`
+
+that produces a different textual response to an HTTP GET. The
+purpose of this resource is to show how to define multiple web
+resources within a web application.
+
+The mapping of the URI path space is presented in the following table:
+
+URI path           | Resource class       | HTTP method
+------------------ | -------------------- | -------------
+**_/helloworld_**  | HelloWorldResource   | GET
+**_/another_**     | AnotherResource      | GET
+
+Running the Example
+-------------------
+
+To run the example, you would need to build the WAR file and install it
+to an OSGi runtime (e.g. Apache Felix) together with other OSGi modules.
+Look at the attached `functional-test` module for details on the
+programatical runtime configuration. To build the war archive and run
+the tests, you can just launch
+
+>     mvn clean install
diff --git a/examples/osgi-helloworld-webapp-jetty-12/pom.xml b/examples/osgi-helloworld-webapp-jetty-12/pom.xml
new file mode 100644
index 0000000000..1954bde975
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/pom.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    This program and the accompanying materials are made available under the
+    terms of the Eclipse Distribution License v. 1.0, which is available at
+    http://www.eclipse.org/org/documents/edl-v10.php.
+
+    SPDX-License-Identifier: BSD-3-Clause
+
+-->
+
+<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>org.glassfish.jersey.examples</groupId>
+        <artifactId>project</artifactId>
+        <version>2.42-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>osgi-helloworld-webapp-jetty-12</artifactId>
+    <name>jersey-examples-osgi-helloworld-webapp-jetty-12</name>
+    <packaging>pom</packaging>
+
+    <modules>
+        <module>war-bundle</module>
+        <!-- 
+        TBD: Write functional tests.
+        <module>functional-test</module>
+        -->
+    </modules>
+
+    <profiles>
+        <profile>
+            <id>pre-release</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-assembly-plugin</artifactId>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
+</project>
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/.gitignore b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/.gitignore
new file mode 100644
index 0000000000..f105c80491
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/.gitignore
@@ -0,0 +1,3 @@
+target/
+.vscode/
+
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/README.md b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/README.md
new file mode 100644
index 0000000000..4cae4fb1fc
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/README.md
@@ -0,0 +1,11 @@
+# A minimalistic Hello World OSGi Bundle for Jetty 12 e88
+
+The Resource will be available under:
+
+	{{base_url}}/helloworld/webresources/hello
+
+**helloworld** is configured in the MANIFEST.MF
+
+**webresources** is configured in web.xml
+
+**hello** is path to the resource 
\ No newline at end of file
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/pom.xml b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/pom.xml
new file mode 100644
index 0000000000..b62329873e
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/pom.xml
@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    This program and the accompanying materials are made available under the
+    terms of the Eclipse Distribution License v. 1.0, which is available at
+    http://www.eclipse.org/org/documents/edl-v10.php.
+
+    SPDX-License-Identifier: BSD-3-Clause
+
+-->
+
+<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>org.glassfish.jersey.examples</groupId>
+        <artifactId>osgi-helloworld-webapp-jetty-12</artifactId>
+        <version>2.42-SNAPSHOT</version>
+    </parent>
+
+    <groupId>org.glassfish.jersey.examples.osgi-helloworld-jetty-12-webapp</groupId>
+    <artifactId>war-bundle</artifactId>
+    <name>jersey-examples-osgi-helloworld-jetty-12-webapp-wab</name>
+    <packaging>war</packaging>
+
+    <description>OSGi Helloworld Webapp WAR bundle for Jetty 12</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.glassfish.jersey.containers</groupId>
+            <artifactId>jersey-container-servlet-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.ws.rs</groupId>
+            <artifactId>jakarta.ws.rs-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>servlet-api</artifactId>
+            <version>${servlet2.version}</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.eventadmin</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.framework</artifactId>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <!-- to generate the MANIFEST-FILE required by the bundle -->
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <extensions>true</extensions>
+                <executions>
+                    <execution>
+                        <id>bundle-manifest</id>
+                        <phase>process-classes</phase>
+                        <goals>
+                            <goal>manifest</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <manifestLocation>${project.build.directory}/META-INF</manifestLocation>
+                    <supportedProjectTypes>
+                        <supportedProjectType>bundle</supportedProjectType>
+                        <supportedProjectType>war</supportedProjectType>
+                    </supportedProjectTypes>
+                    <instructions>
+                        <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
+                        <Import-Package>
+                            org.glassfish.jersey.servlet,
+                            *
+                        </Import-Package>
+                        <Export-Package>
+                            org.glassfish.jersey.examples.osgi.helloworld
+                        </Export-Package>
+                        <Webapp-Context>helloworld</Webapp-Context>
+                        <Web-ContextPath>helloworld</Web-ContextPath>
+                        <Jetty-Environment>ee8</Jetty-Environment>
+                        <_wab>src/main/webapp</_wab>
+                    </instructions>
+                </configuration>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-war-plugin</artifactId>
+                <configuration>
+                    <attachClasses>true</attachClasses>
+                    <archive>
+                        <manifestFile>${project.build.directory}/META-INF/MANIFEST.MF</manifestFile>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <profiles>
+        <profile>
+            <id>release</id>
+            <!-- do not create source zip bundles -->
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-assembly-plugin</artifactId>
+                        <configuration>
+                            <skipAssembly>true</skipAssembly>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+          <id>moxy</id>
+          <activation>
+                <property>
+                    <name>moxy</name>
+                </property>
+          </activation>
+          <dependencies>
+                <dependency>
+                    <groupId>org.eclipse.persistence</groupId>
+                    <artifactId>org.eclipse.persistence.moxy</artifactId>
+                    <version>${moxy.version}</version>
+                    <scope>provided</scope>
+                </dependency>
+            </dependencies>
+         </profile>
+    </profiles>
+
+</project>
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResource.java b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResource.java
new file mode 100644
index 0000000000..e5ebe67788
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResource.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2024. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Distribution License v. 1.0, which is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+package org.glassfish.jersey.examples.osgi.helloworld;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+
+/**
+ * The Hello resource
+ *
+ * @author Gregor Pfeifer
+ */
+@Path("/hello")
+public class HelloResource {
+
+    @GET
+    public String sayHello() {
+        return "Hello world :-)";
+    }
+
+}
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResourceConfig.java b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResourceConfig.java
new file mode 100644
index 0000000000..3a06794888
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/java/org/glassfish/jersey/examples/osgi/helloworld/HelloResourceConfig.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2024. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Distribution License v. 1.0, which is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+package org.glassfish.jersey.examples.osgi.helloworld;
+
+import org.glassfish.jersey.server.ResourceConfig;
+
+/**
+ * The Hello ResourceConfig
+ *
+ * @author Gregor Pfeifer
+ */
+public class HelloResourceConfig extends ResourceConfig {
+
+    public static Class<?>[] CLASSES = new Class[] {
+            HelloResource.class
+    };
+
+    public HelloResourceConfig() {
+        super(CLASSES);
+    }
+
+
+}
\ No newline at end of file
diff --git a/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/webapp/WEB-INF/web.xml b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/webapp/WEB-INF/web.xml
new file mode 100644
index 0000000000..ede62d8747
--- /dev/null
+++ b/examples/osgi-helloworld-webapp-jetty-12/war-bundle/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
+
+    This program and the accompanying materials are made available under the
+    terms of the Eclipse Distribution License v. 1.0, which is available at
+    http://www.eclipse.org/org/documents/edl-v10.php.
+
+    SPDX-License-Identifier: BSD-3-Clause
+
+-->
+
+<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
+
+    <!-- Jersey APP with a ResourceConfig-->
+    <servlet>
+        <servlet-name>Jersey Web Application</servlet-name>
+        <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
+        <init-param>
+            <param-name>javax.ws.rs.Application</param-name>
+            <param-value>org.glassfish.jersey.examples.osgi.helloworld.HelloResourceConfig</param-value>
+        </init-param>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
+    <servlet-mapping>
+        <servlet-name>Jersey Web Application</servlet-name>
+        <url-pattern>/webresources/*</url-pattern>
+    </servlet-mapping>
+
+</web-app>