org.arquillian.droidium.multiplecontainers.MultipleLocalContainersRegistry Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.arquillian.droidium.multiplecontainers;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.jboss.arquillian.config.descriptor.api.ContainerDef;
import org.jboss.arquillian.container.impl.ContainerCreationException;
import org.jboss.arquillian.container.impl.ContainerImpl;
import org.jboss.arquillian.container.spi.ConfigurationException;
import org.jboss.arquillian.container.spi.Container;
import org.jboss.arquillian.container.spi.ContainerRegistry;
import org.jboss.arquillian.container.spi.client.container.DeployableContainer;
import org.jboss.arquillian.container.spi.client.deployment.TargetDescription;
import org.jboss.arquillian.core.api.Injector;
import org.jboss.arquillian.core.spi.ServiceLoader;
import org.jboss.arquillian.core.spi.Validate;

/**
 * This class registers all adapters which are specified in the arquillian.xml.
 *
 * In the case there is only one adapter implementation on the classpath, it is not necessary to specify it in the container
 * configuration since it will be used automatically. You have to specify it only in the case you are going to use more than one
 * container.
 *
 * @author Dominik Pospisil 
 * @author Stefan Miklosovic 
 */
public class MultipleLocalContainersRegistry implements ContainerRegistry {

    private List containers;

    private Injector injector;

    private static final Logger logger = Logger.getLogger(MultipleContainerRegistryCreator.class.getName());

    public MultipleLocalContainersRegistry(Injector injector) {
        this.containers = new ArrayList();
        this.injector = injector;
    }

    @Override
    public Container create(ContainerDef definition, ServiceLoader loader) {
        Validate.notNull(definition, "Definition must be specified");

        try {
            logger.log(Level.INFO, "Registering container: {0}", definition.getContainerName());

            @SuppressWarnings("rawtypes")
            Collection containers = loader.all(DeployableContainer.class);

            DeployableContainer dcService = null;

            if (containers.size() == 1) {
                // just one container on cp
                dcService = containers.iterator().next();
            } else {
                dcService = ContainerGuesser.guessDeployableContainer(definition, containers);

                // double check if it is not Droidium by accident since we can guess more precisely from underlying properties
                if (ContainerGuesser.isDroidiumContainer(definition, containers)) {
                    dcService = ContainerGuesser.parseContainer(ContainerType.DROIDIUM, containers);
                }

                // we were not able to guess it but "create" method is reached from MultipleContainerRegistryCreator
                // only if we can guess it OR that container definition has adapterImplClass present in properties and that
                // class exists and it is an instance of DeployableContainer
                if (dcService == null) {
                    dcService = ContainerGuesser.getContainerAdapter(ContainerGuesser.getAdapterImplClassValue(definition), containers);
                }

                // if it is still null for any reason
                if (dcService == null) {
                    throw new ConfigurationException("Unable to get container adapter from Arquillian configuration.");
                }
            }

            // before a Container is added to a collection of containers, inject into its injection point
            return addContainer(injector.inject(new ContainerImpl(definition.getContainerName(), dcService, definition)));
        } catch (Exception e) {
            throw new ContainerCreationException("Could not create Container " + definition.getContainerName(), e);
        }
    }

    @Override
    public List getContainers() {
        return Collections.unmodifiableList(new ArrayList(containers));
    }

    @Override
    public Container getContainer(TargetDescription target) {
        Validate.notNull(target, "Target must be specified");
        if (TargetDescription.DEFAULT.equals(target)) {
            return findDefaultContainer();
        }
        return findMatchingContainer(target.getName());
    }

    /**
     *
     * @param type
     */
    public void remove(ContainerType type) {
        List containersToRemove = new ArrayList();

        String adapterClassString = ContainerType.getAdapterClassNamePrefix(type);

        for (Container container : containers) {
            if (container.getDeployableContainer().getClass().getName().startsWith(adapterClassString)) {
                containersToRemove.add(container);
            }
        }

        remove(containersToRemove);
    }

    /**
     * Removes all containers from this registry
     */
    public void removeAll() {
        containers.clear();
    }

    /**
     * Removes container from this registry
     *
     * @param containerQualifier container qualifier as specified in arquillian.xml to remove
     * @return true if container was removed, false otherwise
     * @throws IllegalArgumentException if {@code containerQualifier} is a null object or an empty string
     */
    public boolean remove(String containerQualifier) {
        Validate.notNullOrEmpty(containerQualifier, "Container qualifier marking the container to be removed can not be a "
            + "null object nor an empty string!");
        Container containerToRemove = null;

        for (Container container : containers) {
            if (container.getName().equals(containerQualifier)) {
                containerToRemove = container;
            }
        }
        return remove(containerToRemove);
    }

    /**
     * Removes container from this registry.
     *
     * @param container container to delete
     * @return true if container was removed, false otherwise
     */
    public boolean remove(Container container) {
        return containers.remove(container);
    }

    private Container addContainer(Container contianer) {
        containers.add(contianer);
        return contianer;
    }

    private void remove(List containersToRemove) {
        for (Container container : containersToRemove) {
            remove(container);
        }
    }

    private Container findDefaultContainer() {
        if (containers.size() == 1) {
            return containers.get(0);
        }
        for (Container container : containers) {
            if (container.getContainerConfiguration().isDefault()) {
                return container;
            }
        }
        return null;
    }

    private Container findMatchingContainer(String name) {
        for (Container container : containers) {
            if (container.getName().equals(name)) {
                return container;
            }
        }
        return null;
    }

    @Override
    public Container getContainer(String name) {
        return findMatchingContainer(name);
    }

}