diff options
author | Mirjan Merruko <mirjan@vaadin.com> | 2017-08-29 12:16:14 +0300 |
---|---|---|
committer | Henri Sara <henri.sara@gmail.com> | 2017-08-29 12:16:14 +0300 |
commit | 08ff3b8fdbc7f9b40000cd266449ec08c6e9e366 (patch) | |
tree | 3141b6c552d9df5e3623dad5e5f94ec5b37d2253 /liferay-integration/src | |
parent | 13961956f6f7deebf3bc4e285cec9ab162ef8d90 (diff) | |
download | vaadin-framework-08ff3b8fdbc7f9b40000cd266449ec08c6e9e366.tar.gz vaadin-framework-08ff3b8fdbc7f9b40000cd266449ec08c6e9e366.zip |
Enable Declarative Services in OSGi portlet UI (#9879)
If the UI scope is not prototype, show a warning that declarative services are not available in the UI.
Fixes #9589
Diffstat (limited to 'liferay-integration/src')
3 files changed, 62 insertions, 6 deletions
diff --git a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/OsgiUIProvider.java b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/OsgiUIProvider.java index 072dcbdc02..bdf50aa0d1 100644 --- a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/OsgiUIProvider.java +++ b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/OsgiUIProvider.java @@ -15,9 +15,15 @@ */ package com.vaadin.osgi.liferay; +import java.util.Optional; + +import org.osgi.framework.Constants; import org.osgi.framework.ServiceObjects; +import org.osgi.framework.ServiceReference; +import org.osgi.service.log.LogService; import com.vaadin.server.UIClassSelectionEvent; +import com.vaadin.server.UICreateEvent; import com.vaadin.server.UIProvider; import com.vaadin.ui.UI; @@ -34,12 +40,26 @@ import com.vaadin.ui.UI; @SuppressWarnings("serial") public class OsgiUIProvider extends UIProvider { private Class<UI> uiClass; + private ServiceObjects<UI> serviceObjects; + private boolean prototype; + private Optional<LogService> logService; @SuppressWarnings("unchecked") - public OsgiUIProvider(ServiceObjects<UI> serviceObjects) { + public OsgiUIProvider(ServiceObjects<UI> serviceObjects, + Optional<LogService> logService) { super(); + this.serviceObjects = serviceObjects; + this.logService = logService; + UI ui = serviceObjects.getService(); + + ServiceReference<UI> reference = serviceObjects.getServiceReference(); + Object property = reference.getProperty(Constants.SERVICE_SCOPE); + + prototype = Constants.SCOPE_PROTOTYPE.equals(property); + uiClass = (Class<UI>) ui.getClass(); + serviceObjects.ungetService(ui); } @@ -48,6 +68,22 @@ public class OsgiUIProvider extends UIProvider { return uiClass; } + @Override + public UI createInstance(UICreateEvent event) { + if (prototype) { + UI ui = serviceObjects.getService(); + ui.addDetachListener(e -> { + serviceObjects.ungetService(ui); + }); + return ui; + } + logService.ifPresent(log -> { + log.log(LogService.LOG_WARNING, + "UI services should have a prototype scope! Creating UI instance using the default constructor!"); + }); + return super.createInstance(event); + } + public String getDefaultPortletName() { return uiClass.getName(); } diff --git a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/PortletUIServiceTrackerCustomizer.java b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/PortletUIServiceTrackerCustomizer.java index 077730d2a8..607d5e33a0 100644 --- a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/PortletUIServiceTrackerCustomizer.java +++ b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/PortletUIServiceTrackerCustomizer.java @@ -19,6 +19,7 @@ import java.util.Dictionary; import java.util.HashMap; import java.util.Hashtable; import java.util.Map; +import java.util.Optional; import javax.portlet.Portlet; @@ -27,6 +28,7 @@ import org.osgi.framework.BundleContext; import org.osgi.framework.ServiceObjects; import org.osgi.framework.ServiceReference; import org.osgi.framework.ServiceRegistration; +import org.osgi.service.log.LogService; import org.osgi.util.tracker.ServiceTrackerCustomizer; import com.vaadin.osgi.resources.VaadinResourceService; @@ -60,9 +62,12 @@ class PortletUIServiceTrackerCustomizer private Map<ServiceReference<UI>, ServiceRegistration<Portlet>> portletRegistrations = new HashMap<ServiceReference<UI>, ServiceRegistration<Portlet>>(); private VaadinResourceService service; + private Optional<LogService> logService; - PortletUIServiceTrackerCustomizer(VaadinResourceService service) { + PortletUIServiceTrackerCustomizer(VaadinResourceService service, + LogService logService) { this.service = service; + this.logService = Optional.ofNullable(logService); } @Override @@ -102,7 +107,8 @@ class PortletUIServiceTrackerCustomizer ServiceObjects<UI> serviceObjects = bundleContext .getServiceObjects(reference); - OsgiUIProvider uiProvider = new OsgiUIProvider(serviceObjects); + OsgiUIProvider uiProvider = new OsgiUIProvider(serviceObjects, + logService); Dictionary<String, Object> properties = null; if (configuration != null) { diff --git a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/VaadinPortletProvider.java b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/VaadinPortletProvider.java index 78d0bff383..b95f0b591e 100644 --- a/liferay-integration/src/main/java/com/vaadin/osgi/liferay/VaadinPortletProvider.java +++ b/liferay-integration/src/main/java/com/vaadin/osgi/liferay/VaadinPortletProvider.java @@ -15,12 +15,17 @@ */ package com.vaadin.osgi.liferay; +import java.util.Optional; + import org.osgi.framework.BundleContext; import org.osgi.framework.ServiceObjects; import org.osgi.service.component.ComponentContext; import org.osgi.service.component.annotations.Activate; import org.osgi.service.component.annotations.Component; import org.osgi.service.component.annotations.Deactivate; +import org.osgi.service.component.annotations.Reference; +import org.osgi.service.component.annotations.ReferenceCardinality; +import org.osgi.service.log.LogService; import org.osgi.util.tracker.ServiceTracker; import com.vaadin.osgi.resources.OsgiVaadinResources; @@ -37,11 +42,12 @@ import com.vaadin.ui.UI; * * @since 8.1 */ -@Component(immediate = true) +@Component public class VaadinPortletProvider { private ServiceTracker<UI, ServiceObjects<UI>> serviceTracker; private PortletUIServiceTrackerCustomizer portletUIServiceTrackerCustomizer; + private LogService logService; @Activate void activate(ComponentContext componentContext) throws Exception { @@ -49,12 +55,21 @@ public class VaadinPortletProvider { VaadinResourceService service = OsgiVaadinResources.getService(); portletUIServiceTrackerCustomizer = new PortletUIServiceTrackerCustomizer( - service); + service, logService); serviceTracker = new ServiceTracker<UI, ServiceObjects<UI>>( bundleContext, UI.class, portletUIServiceTrackerCustomizer); serviceTracker.open(); } + @Reference(cardinality = ReferenceCardinality.OPTIONAL) + void setLogService(LogService logService) { + this.logService = logService; + } + + void unsetLogService(LogService logService) { + this.logService = null; + } + @Deactivate void deactivate() { if (serviceTracker != null) { @@ -62,6 +77,5 @@ public class VaadinPortletProvider { portletUIServiceTrackerCustomizer.cleanPortletRegistrations(); portletUIServiceTrackerCustomizer = null; } - } } |