org.jboss.weld.xml.BeansXmlParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weld-servlet-shaded Show documentation
This jar bundles all the bits of Weld and CDI required for running in a Servlet container.
There is a newer version: 6.0.0.Beta4
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2018, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.jboss.weld.xml;

import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;

import org.jboss.weld.bootstrap.spi.BeanDeploymentArchive;
import org.jboss.weld.bootstrap.spi.BeanDiscoveryMode;
import org.jboss.weld.bootstrap.spi.BeansXml;
import org.jboss.weld.bootstrap.spi.Filter;
import org.jboss.weld.bootstrap.spi.Metadata;
import org.jboss.weld.config.SystemPropertiesConfiguration;
import org.jboss.weld.metadata.BeansXmlImpl;
import org.jboss.weld.metadata.ScanningImpl;

/**
 * Retained for backward compatibility with Arquillian and WildFly which incorrectly rely on Weld internals!
 *
 * 
 * Also contains various merging utils.
 * 
 *
 * @author Martin Kouba
 */
public class BeansXmlParser {

    private final BeansXmlValidator beansXmlValidator;

    public BeansXmlParser() {
        beansXmlValidator = SystemPropertiesConfiguration.INSTANCE.isXmlValidationDisabled() ? null : new BeansXmlValidator();
    }

    public BeansXml parse(final URL beansXml) {
        BeansXmlHandler handler = getHandler(beansXml);
        if (beansXmlValidator != null) {
            beansXmlValidator.validate(beansXml, handler);
        }
        return handler != null ? new BeansXmlStreamParser(beansXml, text -> handler.interpolate(text)).parse() : new BeansXmlStreamParser(beansXml).parse();
    }

    public BeansXml parse(Iterable urls) {
        return parse(urls, false);
    }

    public BeansXml parse(Iterable urls, boolean removeDuplicates) {
        return merge(urls, this::parse, removeDuplicates);
    }

    protected BeansXmlHandler getHandler(final URL beansXml) {
        return null;
    }

    // Merging utils

    public static  BeansXml merge(Iterable items, Function function, boolean removeDuplicates) {
        List> alternatives = new ArrayList<>();
        List> alternativeStereotypes = new ArrayList<>();
        List> decorators = new ArrayList<>();
        List> interceptors = new ArrayList<>();
        List> includes = new ArrayList<>();
        List> excludes = new ArrayList<>();
        boolean isTrimmed = false;
        URL beansXmlUrl = null;
        for (T item : items) {
            BeansXml beansXml = function.apply(item);
            addTo(alternatives, beansXml.getEnabledAlternativeClasses(), removeDuplicates);
            addTo(alternativeStereotypes, beansXml.getEnabledAlternativeStereotypes(), removeDuplicates);
            addTo(decorators, beansXml.getEnabledDecorators(), removeDuplicates);
            addTo(interceptors, beansXml.getEnabledInterceptors(), removeDuplicates);
            includes.addAll(beansXml.getScanning().getIncludes());
            excludes.addAll(beansXml.getScanning().getExcludes());
            isTrimmed = beansXml.isTrimmed();
            /*
             * provided we are merging the content of multiple XML files, getBeansXml() returns an InputStream representing the last one
             */
            beansXmlUrl = beansXml.getUrl();
        }
        return new BeansXmlImpl(alternatives, alternativeStereotypes, decorators, interceptors, new ScanningImpl(includes, excludes), beansXmlUrl,
                BeanDiscoveryMode.ALL, null, isTrimmed);
    }

    private static void addTo(List> list, List> listToAdd, boolean removeDuplicates) {
        if (removeDuplicates) {
            List> filteredListToAdd = new ArrayList<>(listToAdd.size());
            for (Metadata metadata : listToAdd) {
                if (!alreadyAdded(metadata, list)) {
                    filteredListToAdd.add(metadata);
                }
            }
            listToAdd = filteredListToAdd;
        }
        list.addAll(listToAdd);
    }

    private static boolean alreadyAdded(Metadata metadata, List> list) {
        for (Metadata existing : list) {
            if (existing.getValue().equals(metadata.getValue())) {
                return true;
            }
        }
        return false;
    }

    public static BeansXml mergeExisting(final Iterable beanArchives, final boolean removeDuplicates) {
        return merge(beanArchives, bda -> bda.getBeansXml(), removeDuplicates);
    }

    public static BeansXml mergeExistingDescriptors(final Iterable beanArchives, final boolean removeDuplicates) {
        return merge(beanArchives, Function.identity(), removeDuplicates);
    }

}