Move some more servlets to using whiteboard pattern

Author: laeubi

ua/org.eclipse.help.webapp/META-INF/MANIFEST.MF

@@ -10,8 +10,20 @@ Require-Bundle: org.eclipse.help.base;bundle-version="[4.3.200,5.0.0)",
  org.eclipse.core.runtime;bundle-version="[3.29.0,4.0.0)",
  org.eclipse.equinox.jsp.jasper.registry;bundle-version="1.0.100",
  org.eclipse.jdt.core.compiler.batch;bundle-version="[3.33.0,4.0.0)"
-Service-Component: OSGI-INF/org.eclipse.help.internal.webapp.servlet.ContentServlet.xml,
- OSGI-INF/org.eclipse.help.internal.webapp.servlet.NavServlet.xml
+Service-Component: OSGI-INF/org.eclipse.help.internal.webapp.HelpUiJs.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.AboutServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.ContentServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.ContextServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.ControlServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.ExtensionServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.IndexServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.LiveHelpServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.NavServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.SearchServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.TocFragmentServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.TocServlet.xml,
+ OSGI-INF/org.eclipse.help.internal.webapp.servlet.ValidatorServlet.xml
 Export-Package: org.eclipse.help.internal.webapp;x-friends:="org.eclipse.ua.tests",
  org.eclipse.help.internal.webapp.data;x-friends:="org.eclipse.ua.tests",
  org.eclipse.help.internal.webapp.parser;x-internal:=true,

ua/org.eclipse.help.webapp/plugin.xml

@@ -47,61 +47,6 @@
    </extension>
    <extension
          point="org.eclipse.equinox.http.registry.servlets">
-      <servlet
-            alias="/control"
-            class="org.eclipse.help.internal.webapp.servlet.ControlServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/livehelp"
-            class="org.eclipse.help.internal.webapp.servlet.LiveHelpServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/toc"
-            class="org.eclipse.help.internal.webapp.servlet.TocServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/advanced/tocfragment"
-            class="org.eclipse.help.internal.webapp.servlet.TocFragmentServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/index"
-            class="org.eclipse.help.internal.webapp.servlet.IndexServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/advanced/indexfragment"
-            class="org.eclipse.help.internal.webapp.servlet.IndexFragmentServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/search"
-            class="org.eclipse.help.internal.webapp.servlet.SearchServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/context"
-            class="org.eclipse.help.internal.webapp.servlet.ContextServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/extension"
-            class="org.eclipse.help.internal.webapp.servlet.ExtensionServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/about.html"
-            class="org.eclipse.help.internal.webapp.servlet.AboutServlet"
-            httpcontextId="help">
-      </servlet>
-      <servlet
-            alias="/m/index.js"
-            class="org.eclipse.help.internal.webapp.HelpUiJs"
-            httpcontextId="help">
-      </servlet>
       <servlet
             alias="/*.jsp"
             class="org.eclipse.equinox.jsp.jasper.registry.JSPFactory:/"
@@ -130,11 +75,6 @@
       <serviceSelector
             filter="(other.info=org.eclipse.help)">
       </serviceSelector>
-      <servlet
-            alias="/vs"
-            class="org.eclipse.help.internal.webapp.servlet.ValidatorServlet"
-            httpcontextId="help">
-      </servlet>
    </extension>
    <extension
          id="org.eclipse.help.webapp.remoteStatusProducer"

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/HelpUiJs.java

@@ -14,14 +14,21 @@
 import java.net.URL;
 import java.util.Scanner;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.eclipse.core.runtime.ILog;
 import org.eclipse.core.runtime.Platform;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("helpuijs")
+@HttpWhiteboardServletPattern("/m/index.js")
 public class HelpUiJs extends HttpServlet {
 
     private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/AboutServlet.java

@@ -22,6 +22,7 @@
 import java.util.List;
 import java.util.Locale;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -33,11 +34,17 @@
 import org.osgi.framework.Bundle;
 import org.osgi.framework.Constants;
 import org.osgi.framework.FrameworkUtil;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /**
  * A servlet that provides an informational page about the plugins that make up
  * the web application.
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("about")
+@HttpWhiteboardServletPattern("/about.html")
 public class AboutServlet extends HttpServlet {
 
 	protected static final int NUMBER_OF_COLUMNS = 4;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/ContextServlet.java

@@ -16,6 +16,7 @@
 import java.io.IOException;
 import java.io.PrintWriter;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -29,13 +30,19 @@
 import org.eclipse.help.internal.base.BaseHelpSystem;
 import org.eclipse.help.internal.context.Context;
 import org.eclipse.help.internal.webapp.data.UrlUtil;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /*
  * Returns a context help entry with the id specified in the id parameter.
  *
  * This is called on infocenters by client workbenches configured for remote
  * help in order to retrieve context help stored on the remote help server.
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("context")
+@HttpWhiteboardServletPattern("/context")
 public class ContextServlet extends HttpServlet {
 
 	private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/ControlServlet.java

@@ -15,6 +15,7 @@
 
 import java.io.IOException;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -24,6 +25,9 @@
 import org.eclipse.help.internal.base.HelpApplication;
 import org.eclipse.help.internal.base.HelpDisplay;
 import org.eclipse.help.internal.webapp.data.UrlUtil;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /**
  * Servlet to control Eclipse helpApplication from standalone application.
@@ -33,6 +37,9 @@
  * href - may be provided if comand==displayHelp.
  * featureId, version, from, to, verifyOnly may be provided for update commands
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("control")
+@HttpWhiteboardServletPattern("/control")
 public class ControlServlet extends HttpServlet {
 	private static final long serialVersionUID = 1L;
 

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/ExtensionServlet.java

@@ -18,6 +18,7 @@
 import java.util.Map;
 import java.util.WeakHashMap;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -28,13 +29,19 @@
 import org.eclipse.help.internal.dynamic.DocumentWriter;
 import org.eclipse.help.internal.extension.ContentExtension;
 import org.eclipse.help.internal.webapp.data.UrlUtil;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /*
  * Sends all topic extensions available on this host in XML form.
  *
  * This is called on infocenters by client workbenches configured for remote
  * help in order to gather all the pieces of a document.
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("extension")
+@HttpWhiteboardServletPattern("/extension")
 public class ExtensionServlet extends HttpServlet {
 
 	private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/IndexFragmentServlet.java

@@ -22,6 +22,7 @@
 import java.util.Map;
 import java.util.WeakHashMap;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -41,6 +42,9 @@
 import org.eclipse.help.internal.webapp.data.RequestScope;
 import org.eclipse.help.internal.webapp.data.UrlUtil;
 import org.eclipse.osgi.util.NLS;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /*
  * Creates xml representing selected parts of the index
@@ -50,6 +54,9 @@
  * letters should be displayed.
  * Parameter "offset" represents the starting point relative to the start
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("indexfragment")
+@HttpWhiteboardServletPattern("/advanced/indexfragment")
 public class IndexFragmentServlet extends HttpServlet {
 
 	private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/IndexServlet.java

@@ -18,6 +18,7 @@
 import java.util.Map;
 import java.util.WeakHashMap;
 
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -30,6 +31,9 @@
 import org.eclipse.help.internal.dynamic.DocumentWriter;
 import org.eclipse.help.internal.index.Index;
 import org.eclipse.help.internal.webapp.data.UrlUtil;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /*
  * Sends all available keyword index data in XML form. The data is sent as one
@@ -40,6 +44,9 @@
  * help in order to gather all the index keywords and assemble them into a
  * complete index.
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("index")
+@HttpWhiteboardServletPattern("/index")
 public class IndexServlet extends HttpServlet {
 
 	private static final long serialVersionUID = 1L;

ua/org.eclipse.help.webapp/src/org/eclipse/help/internal/webapp/servlet/LiveHelpServlet.java

@@ -14,6 +14,8 @@
 package org.eclipse.help.internal.webapp.servlet;
 
 import java.io.IOException;
+
+import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServlet;
@@ -22,10 +24,16 @@
 
 import org.eclipse.help.internal.base.BaseHelpSystem;
 import org.eclipse.help.internal.webapp.data.WebappPreferences;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletName;
+import org.osgi.service.http.whiteboard.propertytypes.HttpWhiteboardServletPattern;
 
 /**
  * Servlet to handle live help action requests
  */
+@Component(service = Servlet.class)
+@HttpWhiteboardServletName("livehelp")
+@HttpWhiteboardServletPattern("/livehelp")
 public class LiveHelpServlet extends HttpServlet {
 	private static final long serialVersionUID = 1L;
 	@Override