Debian Codegraph @

samples/helloworld-osgi-webapp/README.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <!--
3
4 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5
6 Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
7
8 The contents of this file are subject to the terms of either the GNU
9 General Public License Version 2 only ("GPL") or the Common Development
10 and Distribution License("CDDL") (collectively, the "License"). You
11 may not use this file except in compliance with the License. You can
12 obtain a copy of the License at
13 http://glassfish.java.net/public/CDDL+GPL_1_1.html
14 or packager/legal/LICENSE.txt. See the License for the specific
15 language governing permissions and limitations under the License.
16
17 When distributing the software, include this License Header Notice in each
18 file and include the License file at packager/legal/LICENSE.txt.
19
20 GPL Classpath Exception:
21 Oracle designates this particular file as subject to the "Classpath"
22 exception as provided by Oracle in the GPL Version 2 section of the License
23 file that accompanied this code.
24
25 Modifications:
26 If applicable, add the following below the License Header, with the fields
27 enclosed by brackets [] replaced by your own identifying information:
28 "Portions Copyright [year] [name of copyright owner]"
29
30 Contributor(s):
31 If you wish your version of this file to be governed by only the CDDL or
32 only the GPL Version 2, indicate your decision by adding "[Contributor]
33 elects to include this software in this distribution under the [CDDL or GPL
34 Version 2] license." If you don't indicate a single choice of license, a
35 recipient has the option to distribute your version of this file under
36 either the CDDL, the GPL Version 2 or to extend the choice of license to
37 its licensees as provided above. However, if you add GPL Version 2 code
38 and therefore, elected the GPL Version 2 license, then the option applies
39 only if the new code is made subject to such option by the copyright
40 holder.
41
42 -->
43 <html><head><title>HelloWorld OSGi Example</title></head>
44
45
46 <body>
47 <h1>HelloWorld OSGi Example</h1>
48
49 <p>This example demonstrates how to develop a simple OSGi WAR bundle containing a RESTful hello world web service</p>
50
51 <h2>Contents</h2>
52 <p>The example WAR (see the <tt>war-bundle</tt> module) consists of two Jersey resources:</p>
53 <dl>
54 <dt><code>com.sun.jersey.samples.helloworld.HelloWorldResource</code></dt>
55 <dd>that produces a textual response to an HTTP GET</dd>
56 </dl>
57 <dl>
58 <dt><code>com.sun.jersey.samples.helloworld.AnotherResource</code></dt>
59 <dd>that produces a different textual response to an HTTP GET.
60 The purpose of this resource is to show how to define multiple
61 web resources within a web application.</dd>
62 </dl>
63 <p>The mapping of the URI path space is presented in the following table:</p>
64 <table border="1">
65 <tr>
66 <th>URI path</th>
67 <th>Resource class</th>
68 <th>HTTP methods</th>
69 </tr>
70 <tr>
71 <td>/helloworld</td>
72 <td>HelloWorldResource</td>
73 <td>GET</td>
74 </tr>
75 <tr>
76 <td>/another</td>
77 <td>AnotherResource</td>
78 <td>GET</td>
79 </tr>
80 </table>
81
82 <h2>Running the Example</h2>
83 <p>To run the example, you would need to build the WAR file
84 and install it to an OSGi runtime (e.g. Apache Felix) together with other OSGi modules.
85 Look at the attached <tt>functional-test</tt> module for details on the programatical runtime configuration.
86 To build the war archive and run the tests, you can just launch
87 <pre>%mvn clean install
88 </pre>
89 </p>
90 <p>After <a href="http://felix.apache.org/site/downloads.cgi">downloading</a> and installing <a href="http://felix.apache.org/site/index.html">Felix</a>, you can also deploy the WAR manually as shown below.
91 The following steps are known to work with the Felix version 4.2.1. You will need to replace <b>&lt;version&gt;</b>
92 with the current Jersey version, and <b>&lt;repository&gt;</b> with either <code>snapshots</code> or <code>releases</code> based on whether
93 you depend on a snapshot or stable release version of Jersey respectively, in the install commands below.
94 The war archive built by the mvn command above
95 should be located under the <tt>war-bundle/target</tt> subdirectory:
96 <pre>
97 %unzip ~/Downloads/org.apache.felix.main.distribution-4.2.1.zip
98 %cp war-bundle/target/war-bundle*war felix-framework-4.2.1
99 %cd felix-framework-4.2.1
100 %java -jar bin/felix.jar
101 ____________________________
102 Welcome to Apache Felix Gogo
103
104 g! lb
105 START LEVEL 1
106 ID|State |Level|Name
107 0|Active | 0|System Bundle (4.2.1)
108 1|Active | 1|Apache Felix Bundle Repository (1.6.6)
109 2|Active | 1|Apache Felix Gogo Command (0.12.0)
110 3|Active | 1|Apache Felix Gogo Runtime (0.10.0)
111 4|Active | 1|Apache Felix Gogo Shell (0.10.0)
112 g! install http://repo2.maven.org/maven2/org/apache/felix/org.apache.felix.configadmin/1.2.8/org.apache.felix.configadmin-1.2.8.jar
113 Bundle ID: 5
114 g! install http://repo1.maven.org/maven2/org/apache/felix/org.apache.felix.eventadmin/1.2.10/org.apache.felix.eventadmin-1.2.10.jar
115 Bundle ID: 6
116 g! install http://repo2.maven.org/maven2/org/ops4j/pax/web/pax-web-jetty-bundle/0.7.1/pax-web-jetty-bundle-0.7.1.jar
117 Bundle ID: 7
118 g! install http://repo2.maven.org/maven2/org/ops4j/pax/web/pax-web-extender-war/0.7.1/pax-web-extender-war-0.7.1.jar
119 Bundle ID: 8
120 g! install http://repo1.maven.org/maven2/asm/asm-all/3.1/asm-all-3.1.jar
121 Bundle ID: 9
122 g! install https://maven.java.net/service/local/artifact/maven/redirect?r=<b>&lt;repository&gt;</b>&g=com.sun.jersey&a=jersey-core&v=<b>&lt;version&gt;</b>&e=jar
123 Bundle ID: 10
124 g! install https://maven.java.net/service/local/artifact/maven/redirect?r=<b>&lt;repository&gt;</b>&g=com.sun.jersey&a=jersey-server&v=<b>&lt;version&gt;</b>&e=jar
125 Bundle ID: 11
126 g! install https://maven.java.net/service/local/artifact/maven/redirect?r=<b>&lt;repository&gt;</b>&g=com.sun.jersey&a=jersey-servlet&v=<b>&lt;version&gt;</b>&e=jar
127 Bundle ID: 12
128 g! install file:war-bundle-1.18.war
129 Bundle ID: 13
130 g! lb
131 START LEVEL 1
132 ID|State |Level|Name
133 0|Active | 0|System Bundle (4.2.1)
134 1|Active | 1|Apache Felix Bundle Repository (1.6.6)
135 2|Active | 1|Apache Felix Gogo Command (0.12.0)
136 3|Active | 1|Apache Felix Gogo Runtime (0.10.0)
137 4|Active | 1|Apache Felix Gogo Shell (0.10.0)
138 5|Installed | 1|Apache Felix Configuration Admin Service (1.2.8)
139 6|Installed | 1|Apache Felix EventAdmin (1.2.10)
140 7|Installed | 1|OPS4J Pax Web - Jetty Bundle (0.7.1)
141 8|Installed | 1|OPS4J Pax Web - Extender - WAR (0.7.1)
142 9|Installed | 1|ASM all classes (3.1.0)
143 10|Installed | 1|jersey-core (1.18.0)
144 11|Installed | 1|jersey-server (1.18.0)
145 12|Installed | 1|jersey-servlet (1.18.0)
146 13|Installed | 1|Helloworld OSGi WebApp - Jersey Sample WAR (1.18.0)
147 g! start 5 6 7 8 9 10 11 12 13
148 Nov 15, 2013 5:05:46 PM com.sun.jersey.api.core.PackagesResourceConfig init
149 INFO: Scanning for root resource and provider classes in the packages:
150 com.sun.jersey.samples.helloworld
151 Nov 15, 2013 5:05:46 PM com.sun.jersey.api.core.ScanningResourceConfig logClasses
152 INFO: Root resource classes found:
153 class com.sun.jersey.samples.helloworld.AnotherResource
154 class com.sun.jersey.samples.helloworld.HelloWorldResource
155 Nov 15, 2013 5:05:46 PM com.sun.jersey.api.core.ScanningResourceConfig init
156 INFO: No provider classes found.
157 Nov 15, 2013 5:05:46 PM com.sun.jersey.server.impl.application.WebApplicationImpl _initiate
158 INFO: Initiating Jersey application, version 'Jersey: 1.18 11/15/2013 09:28 AM'
159 </pre>
160 <b>Note</b>: The version string can be updated to install another Jersey version runtime.<br><br>
161 Now both Jersey resources should become available at:
162 <ul>
163 <li><a href="http://localhost:8080/helloworld/webresources/helloworld">http://localhost:8080/helloworld/webresources/helloworld</a></li>
164 <li><a href="http://localhost:8080/helloworld/webresources/another">http://localhost:8080/helloworld/webresources/another</a></li>
165 </ul>
166 </p>
167 <h2>Troubleshooting</h2>
168 <h3>HTTP Proxy</h3>
169 <p>Behind a HTTP proxy, Apache Felix returns <tt>java.net.ConnectException: Connection timed out</tt> when
170 installing bundles from the Internet. You will need to setup the following system properties:
171 <ul>
172 <li>http.proxyHost - the name of the proxy host.</li>
173 <li>http.proxyPort - the port of the proxy host.</li>
174 <li>http.proxyAuth - the user name and password to use when connecting to the proxy; this string should be the user name and password separated by a colon (e.g., rickhall:mypassword).</li>
175 </ul>
176
177 These system properties can be set directly on the command line when starting the JVM using the standard "-D&lt;prop&gt;=&lt;value&gt;" syntax or you can put them in the lib/system.properties file of your Felix installation; see documentation on configuring Felix for more information.</p>
178 </body></html>