feat: Added Google Guice ActionHooks support (#113)

Refs: #106

README.md

@@ -31,9 +31,10 @@ Use Administration -> Interceptor Manager -> Settings page to enable/disable or
 #### Standalone jar hooks
 Copy hook jar to hooks folder (`<polarion_home>/polarion/extensions/ch.sbb.polarion.extension.interceptor-manager/eclipse/plugins/hooks`) and enforce hooks reloading from the settings page or restart Polarion.
 By default, newly added hooks are disabled and must be enabled manually.
-#### Hooks from Another Polarion Extension
-Hooks can be located in another Polarion extension. In this case, the extension should register the hooks as an OSGi service using the IActionHook interface.
-For more details, refer to the example at [Delete Non-resolved Module Comments as OSGi Service](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.interceptor-manager.hook-samples/tree/main/hook-samples-osgi).
+#### Hooks from Different Polarion Extension
+Hooks can be located in another Polarion extension. In this case, the following two approaches to register the hooks are supported:
+ - OSGi Services, illustrated in example: [Delete Non-resolved Module Comments as OSGi Service](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.interceptor-manager.hook-samples/tree/main/hook-samples-osgi)
+ - Google Guice, illustrated in example: [Delete Non-resolved Module Comments as Guice Module](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.interceptor-manager.hook-samples/tree/main/hook-samples-guice)
 
 ## Upgrade
 

src/main/java/ch/sbb/polarion/extension/interceptor_manager/guice/GuiceActionHooksFactory.java

@@ -0,0 +1,33 @@
+package ch.sbb.polarion.extension.interceptor_manager.guice;
+
+import ch.sbb.polarion.extension.interceptor_manager.model.IActionHook;
+import com.google.inject.Inject;
+import com.polarion.core.util.logging.Logger;
+import com.polarion.platform.guice.internal.GuicePlatform;
+import lombok.Getter;
+
+import java.util.HashSet;
+import java.util.Set;
+
+@Getter
+public class GuiceActionHooksFactory {
+    private static final Logger logger = Logger.getLogger(GuiceActionHooksFactory.class);
+    private final Set<IActionHook> actionHooks = new HashSet<>();
+
+    private GuiceActionHooksFactory() {}
+
+    public static GuiceActionHooksFactory build() {
+        GuiceActionHooksFactory actionHooksFactory = new GuiceActionHooksFactory();
+        GuicePlatform.tryInjectMembers(actionHooksFactory);
+        return actionHooksFactory;
+    }
+
+    @Inject
+    @SuppressWarnings("unused")
+    public void setActionHooks(Set<IActionHook> actionHooks) {
+        if (actionHooks != null) {
+            this.actionHooks.addAll(actionHooks);
+            logger.info("Added guice action hooks: " + actionHooks.size());
+        }
+    }
+}

src/main/java/ch/sbb/polarion/extension/interceptor_manager/guice/GuiceModule.java

@@ -0,0 +1,13 @@
+package ch.sbb.polarion.extension.interceptor_manager.guice;
+
+import ch.sbb.polarion.extension.interceptor_manager.model.IActionHook;
+import com.google.inject.AbstractModule;
+import com.google.inject.multibindings.Multibinder;
+
+public class GuiceModule extends AbstractModule {
+
+    @Override
+    protected void configure() {
+        Multibinder.newSetBinder(binder(), IActionHook.class);
+    }
+}

src/main/java/ch/sbb/polarion/extension/interceptor_manager/model/HooksRegistry.java

@@ -1,9 +1,10 @@
 package ch.sbb.polarion.extension.interceptor_manager.model;
 
 import ch.sbb.polarion.extension.generic.settings.NamedSettingsRegistry;
+import ch.sbb.polarion.extension.interceptor_manager.guice.GuiceActionHooksFactory;
+import ch.sbb.polarion.extension.interceptor_manager.osgi.OSGiUtils;
 import ch.sbb.polarion.extension.interceptor_manager.settings.HookSettings;
 import ch.sbb.polarion.extension.interceptor_manager.util.HookJarUtils;
-import ch.sbb.polarion.extension.interceptor_manager.osgi.OSGiUtils;
 import com.polarion.core.util.logging.Logger;
 
 import java.util.ArrayList;
@@ -22,6 +23,7 @@ public synchronized void refresh() {
         hooks.clear();
         hooks.addAll(HookJarUtils.loadHooks());
         hooks.addAll(OSGiUtils.lookupOSGiService(IActionHook.class));
+        hooks.addAll(GuiceActionHooksFactory.build().getActionHooks());
         logger.info(hooks.size() + " hooks loaded.");
         NamedSettingsRegistry.INSTANCE.getAll().clear();
         hooks.forEach(hook -> NamedSettingsRegistry.INSTANCE.getAll().add(new HookSettings(hook)));

src/main/java/ch/sbb/polarion/extension/interceptor_manager/osgi/HooksBundleActivator.java

@@ -1,7 +1,6 @@
 package ch.sbb.polarion.extension.interceptor_manager.osgi;
 
 import ch.sbb.polarion.extension.interceptor_manager.model.IActionHook;
-import ch.sbb.polarion.extension.interceptor_manager.model.HooksRegistry;
 import org.osgi.framework.BundleActivator;
 import org.osgi.framework.BundleContext;
 import org.osgi.util.tracker.ServiceTracker;
@@ -13,7 +12,6 @@ public class HooksBundleActivator implements BundleActivator {
     public void start(BundleContext bundleContext) {
         serviceTracker = new ServiceTracker<>(bundleContext, IActionHook.class, new HooksServiceTrackerCustomizer(bundleContext));
         serviceTracker.open();
-        HooksRegistry.HOOKS.refresh();
     }
 
     @Override
@@ -22,5 +20,4 @@ public void stop(BundleContext bundleContext) {
             serviceTracker.close();
         }
     }
-
 }

src/main/java/ch/sbb/polarion/extension/interceptor_manager/rest/InterceptorManagerRestApplication.java

@@ -2,6 +2,7 @@
 
 import ch.sbb.polarion.extension.generic.rest.GenericRestApplication;
 import ch.sbb.polarion.extension.generic.rest.controller.NamedSettingsApiController;
+import ch.sbb.polarion.extension.interceptor_manager.model.HooksRegistry;
 import ch.sbb.polarion.extension.interceptor_manager.rest.controller.HooksApiController;
 import ch.sbb.polarion.extension.interceptor_manager.rest.controller.HooksInternalController;
 import ch.sbb.polarion.extension.interceptor_manager.rest.controller.HooksSettingsApiController;
@@ -13,6 +14,11 @@
 
 public class InterceptorManagerRestApplication extends GenericRestApplication {
 
+    public InterceptorManagerRestApplication() {
+        // Refresh actions hooks registry to process guice hooks after Google Guice platform was initialized
+        HooksRegistry.HOOKS.refresh();
+    }
+
     @Override
     protected @NotNull Set<Object> getExtensionControllerSingletons() {
         return Set.of(

src/main/resources/META-INF/MANIFEST.MF

@@ -3,6 +3,7 @@ Bundle-Name: Interceptor Manager Extension for Polarion ALM
 Bundle-Activator: ch.sbb.polarion.extension.interceptor_manager.osgi.HooksBundleActivator
 Bundle-ActivationPolicy: lazy
 Require-Bundle: com.polarion.portal.tomcat,
+ com.polarion.platform.guice,
  com.polarion.alm.ui,
  com.polarion.alm.tracker,
  org.glassfish.jersey,
@@ -13,6 +14,7 @@ Require-Bundle: com.polarion.portal.tomcat,
  org.apache.commons.logging,
  org.apache.hivemind,
  slf4j.api
+Guice-Modules: ch.sbb.polarion.extension.interceptor_manager.guice.GuiceModule
 Import-Package: org.osgi.framework,
  org.osgi.util.tracker
 Export-Package: ch.sbb.polarion.extension.interceptor_manager,