com.vaadin.osgi.liferay.OsgiUIProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-liferay-integration Show documentation

Liferay 7+ OSGi portlet support

There is a newer version: 8.27.3

Show newest version

/*
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */
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;

/**
 * Vaadin {@link com.vaadin.server.UIProvider} that provides a single {@link UI}
 * class provided through the registration of a {@link UI} as an OSGi service.
 * 
 * This only applies to Liferay Portal 7+ with OSGi support.
 *
 * @author Sampsa Sohlman
 *
 * @since 8.1
 */
@SuppressWarnings("serial")
public class OsgiUIProvider extends UIProvider {
    private Class uiClass;
    private ServiceObjects serviceObjects;
    private boolean prototype;
    private Optional logService;

    @SuppressWarnings("unchecked")
    public OsgiUIProvider(ServiceObjects serviceObjects,
            Optional logService) {
        super();
        this.serviceObjects = serviceObjects;
        this.logService = logService;

        UI ui = serviceObjects.getService();

        ServiceReference reference = serviceObjects.getServiceReference();
        Object property = reference.getProperty(Constants.SERVICE_SCOPE);

        prototype = Constants.SCOPE_PROTOTYPE.equals(property);

        uiClass = (Class) ui.getClass();

        serviceObjects.ungetService(ui);
    }

    @Override
    public Class getUIClass(UIClassSelectionEvent event) {
        return uiClass;
    }

    @Override
    public UI createInstance(UICreateEvent event) {
        if (prototype) {
            UI ui = serviceObjects.getService();
            ui.addDetachListener(event2 -> 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();
    }

    public String getDefaultDisplayName() {
        return uiClass.getSimpleName();
    }

}