From 1f1ff75071dc8adf6b2c27c72bdc48195fa5e657 Mon Sep 17 00:00:00 2001 From: Krystian Panek Date: Fri, 15 Dec 2023 07:51:31 +0100 Subject: [PATCH 1/3] Works on recent SDK --- pom.xml | 29 +++-------- .../plugins/search/SearchActivator.java | 50 ++++++++++++++++--- .../plugins/search/plugin/AbstractPlugin.java | 8 +-- .../plugins/search/rest/RestServlet.java | 11 ++-- 4 files changed, 59 insertions(+), 39 deletions(-) diff --git a/pom.xml b/pom.xml index ec5de92..6c8ab56 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ com.neva.felix search-webconsole-plugin bundle - 2.0.0 + 2.0.1-SNAPSHOT search-webconsole-plugin Search everywhere plugin for Apache Felix Web Console 2017 @@ -64,27 +64,6 @@ - - - - false - - central - bintray - https://jcenter.bintray.com - - - - - - false - - central - bintray-plugins - https://jcenter.bintray.com - - - @@ -211,6 +190,12 @@ 4.0.0 provided + + org.osgi + org.osgi.service.http.whiteboard + 1.1.1 + provided + org.apache.felix org.apache.felix.webconsole diff --git a/src/main/java/com/neva/felix/webconsole/plugins/search/SearchActivator.java b/src/main/java/com/neva/felix/webconsole/plugins/search/SearchActivator.java index 080f033..3426324 100644 --- a/src/main/java/com/neva/felix/webconsole/plugins/search/SearchActivator.java +++ b/src/main/java/com/neva/felix/webconsole/plugins/search/SearchActivator.java @@ -1,36 +1,70 @@ package com.neva.felix.webconsole.plugins.search; +import com.neva.felix.webconsole.plugins.search.core.SearchService; import com.neva.felix.webconsole.plugins.search.plugin.AbstractPlugin; import com.neva.felix.webconsole.plugins.search.plugin.SearchPlugin; import com.google.common.collect.ImmutableSet; +import com.neva.felix.webconsole.plugins.search.rest.*; import org.osgi.framework.BundleActivator; import org.osgi.framework.BundleContext; +import org.osgi.framework.ServiceRegistration; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import javax.servlet.Servlet; +import java.util.LinkedList; +import java.util.List; import java.util.Set; public class SearchActivator implements BundleActivator { - private SearchHttpTracker httpTracker; + private static final Logger LOG = LoggerFactory.getLogger(SearchActivator.class); + + private final List services = new LinkedList<>(); @Override public void start(BundleContext bundleContext) throws Exception { for (AbstractPlugin plugin : getPlugins(bundleContext)) { - plugin.register(); + ServiceRegistration service = bundleContext.registerService(Servlet.class.getName(), plugin, plugin.getProps()); + if (service != null) { + services.add(service); + } else { + LOG.error("Cannot register plugin '{}' as OSGi service", plugin.getClass().getName()); + } + } + for (RestServlet servlet : getServlets(bundleContext)) { + ServiceRegistration service = bundleContext.registerService(Servlet.class.getName(), servlet, servlet.createProps()); + if (service != null) { + services.add(service); + } else { + LOG.error("Cannot register plugin servlet '{}' as OSGi service", servlet.getClass().getName()); + } } - - httpTracker = new SearchHttpTracker(bundleContext); - httpTracker.open(); } @Override public void stop(BundleContext bundleContext) throws Exception { - httpTracker.close(); - httpTracker = null; + for (ServiceRegistration service : services) { + service.unregister(); + } } private Set getPlugins(BundleContext bundleContext) { - return ImmutableSet.of( + return ImmutableSet.of( new SearchPlugin(bundleContext) ); } + + private ImmutableSet getServlets(BundleContext context) { + return ImmutableSet.of( + new ByPhraseServlet(context), + new BundleDownloadServlet(context), + new BundleClassesServlet(context), + new ClassDecompileServlet(context), + new ClassSearchServlet(context), + new SourceGenerateServlet(context), + new FileDownloadServlet(context), + new BundleAssembleServlet(context) + ); + } } diff --git a/src/main/java/com/neva/felix/webconsole/plugins/search/plugin/AbstractPlugin.java b/src/main/java/com/neva/felix/webconsole/plugins/search/plugin/AbstractPlugin.java index d844c26..d973273 100644 --- a/src/main/java/com/neva/felix/webconsole/plugins/search/plugin/AbstractPlugin.java +++ b/src/main/java/com/neva/felix/webconsole/plugins/search/plugin/AbstractPlugin.java @@ -5,7 +5,6 @@ import org.apache.felix.webconsole.AbstractWebConsolePlugin; import org.osgi.framework.BundleContext; -import javax.servlet.Servlet; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -33,7 +32,7 @@ protected void renderContent(HttpServletRequest request, HttpServletResponse res response.getWriter().write(content); } - protected Dictionary createProps() { + public Dictionary getProps() { final Dictionary props = new Hashtable<>(); props.put("felix.webconsole.label", getLabel()); @@ -42,10 +41,8 @@ protected Dictionary createProps() { return props; } - public void register() { - bundleContext.registerService(Servlet.class.getName(), this, createProps()); - } + // do not remove it - https://felix.apache.org/documentation/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.html public URL getResource(final String path) { String prefix = "/" + getLabel() + "/"; if (path.startsWith(prefix)) { @@ -54,5 +51,4 @@ public URL getResource(final String path) { return null; } - } diff --git a/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java b/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java index b0b69b9..b29dbc1 100644 --- a/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java +++ b/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java @@ -1,8 +1,8 @@ package com.neva.felix.webconsole.plugins.search.rest; -import com.neva.felix.webconsole.plugins.search.core.SearchPaths; import com.neva.felix.webconsole.plugins.search.utils.TemplateRenderer; import org.osgi.framework.BundleContext; +import org.osgi.service.http.whiteboard.HttpWhiteboardConstants; import javax.servlet.http.HttpServlet; import java.util.Dictionary; @@ -23,13 +23,18 @@ public RestServlet(BundleContext bundleContext) { public Dictionary createProps() { Dictionary props = new Hashtable<>(); - props.put("alias", getAlias()); + //props.put("alias", getAlias()); + + props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/search/" + getAliasName()); + props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT, "(osgi.http.whiteboard.context.name=org.apache.felix.webconsole)"); // webManagerRoot + props.put("service.ranking", Integer.MAX_VALUE); return props; } public String getAlias() { - return SearchPaths.from(bundleContext).pluginAlias(getAliasName()); + return "/system/console/search-api/" + getAliasName(); + //return SearchPaths.from(bundleContext).pluginAlias(getAliasName()); } } From e5a967d94e4bbffa381ff399155bbede256973a6 Mon Sep 17 00:00:00 2001 From: Krystian Panek Date: Fri, 15 Dec 2023 07:55:17 +0100 Subject: [PATCH 2/3] Less updates --- pom.xml | 6 -- .../plugins/search/SearchHttpTracker.java | 65 ------------------- .../plugins/search/rest/RestServlet.java | 15 +---- 3 files changed, 2 insertions(+), 84 deletions(-) delete mode 100644 src/main/java/com/neva/felix/webconsole/plugins/search/SearchHttpTracker.java diff --git a/pom.xml b/pom.xml index 6c8ab56..0f5bf31 100644 --- a/pom.xml +++ b/pom.xml @@ -190,12 +190,6 @@ 4.0.0 provided - - org.osgi - org.osgi.service.http.whiteboard - 1.1.1 - provided - org.apache.felix org.apache.felix.webconsole diff --git a/src/main/java/com/neva/felix/webconsole/plugins/search/SearchHttpTracker.java b/src/main/java/com/neva/felix/webconsole/plugins/search/SearchHttpTracker.java deleted file mode 100644 index 88937c5..0000000 --- a/src/main/java/com/neva/felix/webconsole/plugins/search/SearchHttpTracker.java +++ /dev/null @@ -1,65 +0,0 @@ -package com.neva.felix.webconsole.plugins.search; - -import com.neva.felix.webconsole.plugins.search.rest.*; -import com.google.common.collect.ImmutableSet; -import org.osgi.framework.BundleContext; -import org.osgi.framework.ServiceReference; -import org.osgi.service.http.HttpService; -import org.osgi.service.http.NamespaceException; -import org.osgi.util.tracker.ServiceTracker; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.servlet.ServletException; -import java.util.Set; - -public class SearchHttpTracker extends ServiceTracker { - - private static final Logger LOG = LoggerFactory.getLogger(SearchHttpTracker.class); - - private final Set restServlets; - - public SearchHttpTracker(BundleContext context) { - super(context, HttpService.class.getName(), null); - this.restServlets = createRestServlets(); - } - - @Override - public Object addingService(ServiceReference reference) { - HttpService httpService = (HttpService) super.addingService(reference); - if (httpService == null) - return null; - - try { - for (RestServlet restServlet : restServlets) { - httpService.registerServlet(restServlet.getAlias(), restServlet, restServlet.createProps(), null); - } - } catch (NamespaceException | ServletException e) { - LOG.error("Cannot register REST servlet for search webconsole plugin.", e); - } - - return httpService; - } - - public void removedService(ServiceReference reference, Object service) { - HttpService httpService = (HttpService) service; - for (RestServlet restServlet : restServlets) { - httpService.unregister(restServlet.getAlias()); - } - - super.removedService(reference, service); - } - - private ImmutableSet createRestServlets() { - return ImmutableSet.of( - new ByPhraseServlet(context), - new BundleDownloadServlet(context), - new BundleClassesServlet(context), - new ClassDecompileServlet(context), - new ClassSearchServlet(context), - new SourceGenerateServlet(context), - new FileDownloadServlet(context), - new BundleAssembleServlet(context) - ); - } -} diff --git a/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java b/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java index b29dbc1..e4da397 100644 --- a/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java +++ b/src/main/java/com/neva/felix/webconsole/plugins/search/rest/RestServlet.java @@ -2,7 +2,6 @@ import com.neva.felix.webconsole.plugins.search.utils.TemplateRenderer; import org.osgi.framework.BundleContext; -import org.osgi.service.http.whiteboard.HttpWhiteboardConstants; import javax.servlet.http.HttpServlet; import java.util.Dictionary; @@ -23,18 +22,8 @@ public RestServlet(BundleContext bundleContext) { public Dictionary createProps() { Dictionary props = new Hashtable<>(); - //props.put("alias", getAlias()); - - props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/search/" + getAliasName()); - props.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT, "(osgi.http.whiteboard.context.name=org.apache.felix.webconsole)"); // webManagerRoot - props.put("service.ranking", Integer.MAX_VALUE); - + props.put("osgi.http.whiteboard.servlet.pattern", "/search/" + getAliasName()); + props.put("osgi.http.whiteboard.context.select", "(osgi.http.whiteboard.context.name=org.apache.felix.webconsole)"); return props; } - - public String getAlias() { - return "/system/console/search-api/" + getAliasName(); - //return SearchPaths.from(bundleContext).pluginAlias(getAliasName()); - } - } From 7f7ea7aacd9ecf79e5a3a4e3aa3b6a5dd271a81a Mon Sep 17 00:00:00 2001 From: Krystian Panek Date: Fri, 15 Dec 2023 07:56:39 +0100 Subject: [PATCH 3/3] Release 2.0.1 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 0f5bf31..4f70b18 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ com.neva.felix search-webconsole-plugin bundle - 2.0.1-SNAPSHOT + 2.0.1 search-webconsole-plugin Search everywhere plugin for Apache Felix Web Console 2017