FELIX-1796 Added cometd support to HTTP service.
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@1076920 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/http/samples/cometd/DEPENDENCIES b/http/samples/cometd/DEPENDENCIES
new file mode 100644
index 0000000..ccacee9
--- /dev/null
+++ b/http/samples/cometd/DEPENDENCIES
@@ -0,0 +1,20 @@
+Apache Felix HTTP Service Cometd Sample
+Copyright 2011 The Apache Software Foundation
+
+This software was developed at the Apache Software Foundation
+(http://www.apache.org) and may have dependencies on other
+Apache software licensed under Apache License 2.0.
+
+I. Included Third-Party Software
+
+N/A
+
+II. Used Third-Party Software
+
+This product uses software developed at
+The OSGi Alliance (http://www.osgi.org).
+Copyright (c) OSGi Alliance (2000, 2009).
+Licensed under the Apache License 2.0.
+
+III. License Summary
+- Apache License 2.0
diff --git a/http/samples/cometd/LICENSE b/http/samples/cometd/LICENSE
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/http/samples/cometd/LICENSE
@@ -0,0 +1,203 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
diff --git a/http/samples/cometd/NOTICE b/http/samples/cometd/NOTICE
new file mode 100644
index 0000000..32f0c55
--- /dev/null
+++ b/http/samples/cometd/NOTICE
@@ -0,0 +1,6 @@
+Apache Felix Http Service Cometd Sample
+Copyright 2011 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+Licensed under the Apache License 2.0.
diff --git a/http/samples/cometd/pom.xml b/http/samples/cometd/pom.xml
new file mode 100644
index 0000000..d3b9e24
--- /dev/null
+++ b/http/samples/cometd/pom.xml
@@ -0,0 +1,91 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<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/maven-v4_0_0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>org.apache.felix.http</artifactId>
+ <version>2.2.1-SNAPSHOT</version>
+ <relativePath>../../pom.xml</relativePath>
+ </parent>
+
+ <name>Apache Felix Http Samples - Cometd</name>
+ <artifactId>org.apache.felix.http.samples.cometd</artifactId>
+ <packaging>jar</packaging>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <configuration>
+ <instructions>
+ <Bundle-Activator>
+ org.apache.felix.http.samples.cometd.Activator
+ </Bundle-Activator>
+ <Private-Package>
+ org.apache.felix.http.samples.cometd.*
+ </Private-Package>
+ <Import-Package>
+ *;resolution:=optional
+ </Import-Package>
+ </instructions>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <version>2.0.4</version>
+ <executions>
+ <execution>
+ <id>attach-sources</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.core</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.compendium</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>org.apache.felix.http.api</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
+ </dependencies>
+
+</project>
diff --git a/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/Activator.java b/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/Activator.java
new file mode 100644
index 0000000..a631a79
--- /dev/null
+++ b/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/Activator.java
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.felix.http.samples.cometd;
+
+
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.osgi.framework.ServiceRegistration;
+import org.osgi.util.tracker.ServiceTracker;
+import org.osgi.util.tracker.ServiceTrackerCustomizer;
+import javax.servlet.Servlet;
+import javax.servlet.ServletException;
+import java.util.Hashtable;
+import org.apache.felix.http.api.CometdService;
+import org.cometd.Bayeux;
+
+public final class Activator
+ implements BundleActivator, ServiceTrackerCustomizer
+{
+ private BundleContext context;
+ private ServiceTracker cometdServiceTracker;
+ private ServiceRegistration reg;
+
+ public void start(BundleContext context)
+ throws Exception
+ {
+ this.context = context;
+ this.cometdServiceTracker = new ServiceTracker(this.context, CometdService.class.getName(), this);
+ this.cometdServiceTracker.open();
+ }
+
+ public void stop(BundleContext context)
+ throws Exception
+ {
+ if (this.cometdServiceTracker != null) {
+ this.cometdServiceTracker.close();
+ }
+ this.unregister();
+ }
+
+ public Object addingService(ServiceReference reference)
+ {
+ Object service = this.context.getService(reference);
+ this.register((CometdService)service);
+ return service;
+ }
+
+ public void modifiedService(ServiceReference reference, Object service)
+ {
+ this.unregister();
+ this.register((CometdService)service);
+ }
+
+ public void removedService(ServiceReference reference, Object service)
+ {
+ this.unregister();
+ }
+
+ private void register(CometdService cometdService) {
+ try {
+ Bayeux bayeux = cometdService.getBayeux();
+ if (bayeux != null) {
+ Hashtable<String, String> props = new Hashtable<String, String>();
+ props.put("alias", "/system/time");
+ this.reg = context.registerService(Servlet.class.getName(), new TimeServlet(bayeux), props);
+ doLog("Connect a browser to http://<host>:<port>/system/time to view the time.");
+ }
+ else {
+ doLog("Failed to get bayeux");
+ }
+ }
+ catch (ServletException e) {
+ doLog("Failed to register TimeServlet at /system/time: " + e.getMessage());
+ }
+ }
+
+ private void unregister() {
+ if (this.reg != null) {
+ this.reg.unregister();
+ this.reg = null;
+ }
+ }
+
+ private void doLog(String message)
+ {
+ System.out.println("## Activator: " + message);
+ }
+}
diff --git a/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/TimeServlet.java b/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/TimeServlet.java
new file mode 100644
index 0000000..f970edb
--- /dev/null
+++ b/http/samples/cometd/src/main/java/org/apache/felix/http/samples/cometd/TimeServlet.java
@@ -0,0 +1,138 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.felix.http.samples.cometd;
+
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+import java.util.Timer;
+import java.util.TimerTask;
+import org.cometd.Bayeux;
+import org.cometd.Channel;
+import org.cometd.Client;
+
+public class TimeServlet
+ extends HttpServlet
+{
+ private static final long serialVersionUID = 1L;
+
+ private enum SystemTopics {
+ Time
+ };
+
+ private Bayeux bayeux;
+ private Client client;
+ private List<Channel> channels;
+ private Timer updateTimer;
+ private SimpleDateFormat logDateFormat;
+ private String html =
+ "<html>\n" +
+ " <head>\n" +
+ " <title>System Information</title>\n" +
+ " <script type='text/javascript' src='/dojo/dojo/dojo.js'></script>\n" +
+ " <script type='text/javascript'>\n" +
+ " dojo.require('dojox.cometd');\n" +
+ " dojo.addOnLoad(init);\n" +
+ " dojo.addOnUnload(destroy);\n" +
+ " function init() {\n" +
+ " dojox.cometd.init('/system/cometd');\n" +
+ " dojox.cometd.subscribe('/System/Time', updateTime);\n" +
+ " }\n" +
+ " function destroy() {\n" +
+ " dojox.cometd.unsubscribe('/System/Time');\n" +
+ " dojox.cometd.disconnect();\n" +
+ " }\n" +
+ " function updateTime(message) {\n" +
+ " document.getElementById('systemTime').innerHTML = message.data;\n" +
+ " }\n" +
+ " </script>\n" +
+ " </head>\n" +
+ " <body>\n" +
+ " <h2 id='systemTime'></h2>\n" +
+ " </body>\n" +
+ "</html>\n";
+
+ public TimeServlet(Bayeux bayeux)
+ {
+ this.bayeux = bayeux;
+ this.client = this.bayeux.newClient(this.getClass().getName());
+ this.channels = new ArrayList<Channel>();
+ for (SystemTopics topic : SystemTopics.values()) {
+ this.channels.add(topic.ordinal(), this.bayeux.getChannel("/System/" + topic, true));
+ }
+ this.updateTimer = new Timer("System.Time.ClientNotifier");
+ this.updateTimer.scheduleAtFixedRate(new ClientNotifier(), 1000, 1000);
+ this.logDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
+ }
+
+ @Override
+ public void init(ServletConfig config)
+ throws ServletException
+ {
+ doLog("Init with config [" + config + "]");
+ super.init(config);
+ }
+
+ @Override
+ public void destroy()
+ {
+ doLog("Destroyed servlet");
+ this.updateTimer.cancel();
+ super.destroy();
+ }
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse res)
+ throws ServletException, IOException
+ {
+ res.setContentType("text/html");
+ PrintWriter out = res.getWriter();
+ out.println(this.html);
+ }
+
+ private void doLog(String message)
+ {
+ System.out.println("## TimeServlet: " + message);
+ }
+
+ private class ClientNotifier
+ extends TimerTask
+ {
+
+ public void run() {
+ for (SystemTopics topic : SystemTopics.values()) {
+ String topicData;
+ switch (topic) {
+ case Time:
+ topicData = logDateFormat.format(new Date());
+ break;
+ default:
+ topicData = "unknown topic: " + topic.toString();
+ }
+ channels.get(topic.ordinal()).publish(client, topicData, null);
+ }
+ }
+ }
+}