org.flowable.cdi.impl.FlowableExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowable-cdi Show documentation
The newest version!
/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flowable.cdi.impl;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceLoader;

import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.AfterBeanDiscovery;
import jakarta.enterprise.inject.spi.AfterDeploymentValidation;
import jakarta.enterprise.inject.spi.BeanManager;
import jakarta.enterprise.inject.spi.BeforeBeanDiscovery;
import jakarta.enterprise.inject.spi.BeforeShutdown;
import jakarta.enterprise.inject.spi.Extension;

import org.flowable.cdi.annotation.BusinessProcessScoped;
import org.flowable.cdi.impl.context.BusinessProcessContext;
import org.flowable.cdi.impl.util.BeanManagerLookup;
import org.flowable.cdi.impl.util.FlowableServices;
import org.flowable.cdi.impl.util.ProgrammaticBeanLookup;
import org.flowable.cdi.spi.ProcessEngineLookup;
import org.flowable.common.engine.api.FlowableException;
import org.flowable.engine.ProcessEngine;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * CDI-Extension registering a custom context for {@link BusinessProcessScoped} beans.
 * 
 * Also starts / stops the {@link ProcessEngine} and deploys all processes listed in the 'processes.xml'-file.
 *
 * @author Daniel Meyer
 */
public class FlowableExtension implements Extension {

    private static final Logger LOGGER = LoggerFactory.getLogger(FlowableExtension.class);
    private ProcessEngineLookup processEngineLookup;

    public void beforeBeanDiscovery(@Observes final BeforeBeanDiscovery event) {
        event.addScope(BusinessProcessScoped.class, true, true);
    }

    public void afterBeanDiscovery(@Observes AfterBeanDiscovery event, BeanManager manager) {
        BeanManagerLookup.localInstance = manager;
        event.addContext(new BusinessProcessContext(manager));
    }

    public void afterDeploymentValidation(@Observes AfterDeploymentValidation event, BeanManager beanManager) {
        try {
            LOGGER.info("Initializing flowable-cdi.");
            // initialize the process engine
            ProcessEngine processEngine = lookupProcessEngine(beanManager);
            // deploy the processes if engine was set up correctly
            deployProcesses(processEngine);
        } catch (Exception e) {
            // interpret engine initialization problems as definition errors
            event.addDeploymentProblem(e);
        }
    }

    protected ProcessEngine lookupProcessEngine(BeanManager beanManager) {
        ServiceLoader processEngineServiceLoader = ServiceLoader.load(ProcessEngineLookup.class);
        Iterator serviceIterator = processEngineServiceLoader.iterator();
        List discoveredLookups = new ArrayList<>();
        while (serviceIterator.hasNext()) {
            ProcessEngineLookup serviceInstance = serviceIterator.next();
            discoveredLookups.add(serviceInstance);
        }

        Collections.sort(discoveredLookups, new Comparator() {
            @Override
            public int compare(ProcessEngineLookup o1, ProcessEngineLookup o2) {
                return (-1) * ((Integer) o1.getPrecedence()).compareTo(o2.getPrecedence());
            }
        });

        ProcessEngine processEngine = null;

        for (ProcessEngineLookup processEngineLookup : discoveredLookups) {
            processEngine = processEngineLookup.getProcessEngine();
            if (processEngine != null) {
                this.processEngineLookup = processEngineLookup;
                LOGGER.debug("ProcessEngineLookup service {} returned process engine.", processEngineLookup.getClass());
                break;
            } else {
                LOGGER.debug("ProcessEngineLookup service {} returned 'null' value.", processEngineLookup.getClass());
            }
        }

        if (processEngineLookup == null) {
            throw new FlowableException("Could not find an implementation of the org.flowable.cdi.spi.ProcessEngineLookup service " + "returning a non-null processEngine. Giving up.");
        }

        FlowableServices services = ProgrammaticBeanLookup.lookup(FlowableServices.class, beanManager);
        services.setProcessEngine(processEngine);

        return processEngine;
    }

    private void deployProcesses(ProcessEngine processEngine) {
        new ProcessDeployer(processEngine).deployProcesses();
    }

    public void beforeShutdown(@Observes BeforeShutdown event) {
        if (processEngineLookup != null) {
            processEngineLookup.ungetProcessEngine();
            processEngineLookup = null;
        }
        LOGGER.info("Shutting down flowable-cdi");
    }

}