Update filter example to http whiteboard
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@1720513 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/http/samples/filter/DEPENDENCIES b/http/samples/filter/DEPENDENCIES
deleted file mode 100644
index f57cc55..0000000
--- a/http/samples/filter/DEPENDENCIES
+++ /dev/null
@@ -1,20 +0,0 @@
-Apache Felix HTTP Service Filter 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/filter/LICENSE b/http/samples/filter/LICENSE
deleted file mode 100644
index 6b0b127..0000000
--- a/http/samples/filter/LICENSE
+++ /dev/null
@@ -1,203 +0,0 @@
-
- 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/filter/NOTICE b/http/samples/filter/NOTICE
deleted file mode 100644
index 290a6ff..0000000
--- a/http/samples/filter/NOTICE
+++ /dev/null
@@ -1,6 +0,0 @@
-Apache Felix Http Service Filter 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/filter/pom.xml b/http/samples/filter/pom.xml
index a4b0446..155e4fc 100644
--- a/http/samples/filter/pom.xml
+++ b/http/samples/filter/pom.xml
@@ -27,9 +27,10 @@
</parent>
<name>Apache Felix Http Samples - Filter</name>
+ <description>This example shows how to register servlets and filters using the Http Whiteboard Service.</description>
<artifactId>org.apache.felix.http.samples.filter</artifactId>
<version>2.3.3-SNAPSHOT</version>
- <packaging>jar</packaging>
+ <packaging>bundle</packaging>
<scm>
<connection>scm:svn:http://svn.apache.org/repos/asf/felix/trunk/http/samples/filter</connection>
@@ -42,32 +43,25 @@
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
+ <version>3.0.1</version>
+ <extensions>true</extensions>
<configuration>
<instructions>
<Bundle-Activator>
org.apache.felix.http.samples.filter.Activator
</Bundle-Activator>
<Private-Package>
- org.apache.felix.http.samples.filter.*
+ org.apache.felix.http.samples.filter
</Private-Package>
- <Import-Package>
- *;resolution:=optional
- </Import-Package>
+ <Export-Package>
+ !org.apache.felix.http.samples.filter
+ </Export-Package>
+ <Require-Capability>
+ osgi.contract; filter:="(&(osgi.contract=JavaServlet)(version>=3.1))"
+ </Require-Capability>
</instructions>
</configuration>
</plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-source-plugin</artifactId>
- <executions>
- <execution>
- <id>attach-sources</id>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
@@ -84,11 +78,5 @@
<groupId>org.osgi</groupId>
<artifactId>osgi.cmpn</artifactId>
</dependency>
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.http.api</artifactId>
- <version>3.0.0</version>
- </dependency>
</dependencies>
-
</project>
diff --git a/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/Activator.java b/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/Activator.java
index e6e2f9d..fcc5359 100644
--- a/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/Activator.java
+++ b/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/Activator.java
@@ -16,68 +16,69 @@
*/
package org.apache.felix.http.samples.filter;
+import java.util.Dictionary;
+import java.util.Hashtable;
+
+import javax.servlet.Filter;
+import javax.servlet.Servlet;
+
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;
-import org.osgi.framework.ServiceReference;
-import org.osgi.util.tracker.ServiceTracker;
-import org.apache.felix.http.api.ExtHttpService;
+import org.osgi.service.http.context.ServletContextHelper;
+import org.osgi.service.http.whiteboard.HttpWhiteboardConstants;
public final class Activator
implements BundleActivator
{
- private ServiceTracker tracker;
- private TestServlet servlet1 = new TestServlet("servlet1");
- private TestServlet servlet2 = new TestServlet("servlet2");
- private TestFilter filter1 = new TestFilter("filter1");
- private TestFilter filter2 = new TestFilter("filter2");
+ @Override
public void start(BundleContext context)
throws Exception
{
- this.tracker = new ServiceTracker(context, ExtHttpService.class.getName(), null)
- {
- @Override
- public Object addingService(ServiceReference ref)
- {
- Object service = super.addingService(ref);
- serviceAdded((ExtHttpService)service);
- return service;
- }
+ // create a servlet context
+ final TestServletContext servletContext = new TestServletContext(context.getBundle());
- @Override
- public void removedService(ServiceReference ref, Object service)
- {
- serviceRemoved((ExtHttpService)service);
- super.removedService(ref, service);
- }
- };
+ // register the servlet context with name "filtersample" at "/filtersample"
+ final Dictionary<String, Object> servletContextProps = new Hashtable<String, Object>();
+ servletContextProps.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME, "filtersample");
+ servletContextProps.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH, "/filtersample");
+ context.registerService(ServletContextHelper.class, servletContext, servletContextProps);
- this.tracker.open();
+ // create and register servlets
+ final TestServlet servlet1 = new TestServlet("servlet1");
+ final Dictionary<String, Object> servlet1Props = new Hashtable<String, Object>();
+ servlet1Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/");
+ servlet1Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+ "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME + "=filtersample)");
+ context.registerService(Servlet.class, servlet1, servlet1Props);
+
+ final TestServlet servlet2 = new TestServlet("servlet2");
+ final Dictionary<String, Object> servlet2Props = new Hashtable<String, Object>();
+ servlet2Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/other/*");
+ servlet2Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+ "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME + "=filtersample)");
+ context.registerService(Servlet.class, servlet2, servlet2Props);
+
+ // create and register filters
+ final TestFilter filter1 = new TestFilter("filter1");
+ final Dictionary<String, Object> filter1Props = new Hashtable<String, Object>();
+ filter1Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_FILTER_PATTERN, "/");
+ filter1Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+ "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME + "=filtersample)");
+ context.registerService(Filter.class, filter1, filter1Props);
+
+ final TestFilter filter2 = new TestFilter("filter2");
+ final Dictionary<String, Object> filter2Props = new Hashtable<String, Object>();
+ filter2Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_FILTER_PATTERN, "/other/*");
+ filter2Props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+ "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_NAME + "=filtersample)");
+ context.registerService(Filter.class, filter2, filter2Props);
}
+ @Override
public void stop(BundleContext context)
throws Exception
{
- this.tracker.close();
- }
-
- private void serviceAdded(ExtHttpService service)
- {
- try {
- service.registerServlet("/", this.servlet1, null, null);
- service.registerServlet("/other", this.servlet2, null, null);
- service.registerFilter(this.filter1, ".*", null, 0, null);
- service.registerFilter(this.filter2, "/other/.*", null, 100, null);
- } catch (Exception e) {
- e.printStackTrace();
- }
- }
-
- private void serviceRemoved(ExtHttpService service)
- {
- service.unregisterServlet(this.servlet1);
- service.unregisterServlet(this.servlet2);
- service.unregisterFilter(this.filter1);
- service.unregisterFilter(this.filter2);
+ // nothing to do, services are unregistered automatically
}
}
diff --git a/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/TestServletContext.java b/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/TestServletContext.java
new file mode 100644
index 0000000..ecc64d1
--- /dev/null
+++ b/http/samples/filter/src/main/java/org/apache/felix/http/samples/filter/TestServletContext.java
@@ -0,0 +1,33 @@
+/*
+ * 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.filter;
+
+import org.osgi.framework.Bundle;
+import org.osgi.service.http.context.ServletContextHelper;
+
+/**
+ * Simple sample servlet context
+ */
+public class TestServletContext
+ extends ServletContextHelper
+{
+
+ public TestServletContext(final Bundle bundle)
+ {
+ super(bundle);
+ }
+}