org.apache.qpid.proton.ProtonFactoryLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proton-api Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.qpid.proton;

import java.util.Iterator;
import java.util.ServiceLoader;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.qpid.proton.ProtonFactory.ImplementationType;

/**
 * A thin wrapper around {@link ServiceLoader} intended for loading Proton object factories.
 *
 * If system property {@value #IMPLEMENTATION_TYPE_PROPERTY} if set, loads a factory
 * whose {@link ImplementationType} matches its value.
 */
public class ProtonFactoryLoader
{
    public static final String IMPLEMENTATION_TYPE_PROPERTY = "qpid.proton.implementationtype";

    private static final Logger LOGGER = Logger.getLogger(ProtonFactoryLoader.class.getName());
    private final Class _factoryInterface;
    private final ImplementationType _implementationType;

    /**
     * Use this constructor if you intend to explicitly provide factory interface later,
     * i.e. by calling {@link #loadFactory(Class)}. This is useful if you want to use the same
     * ProtonFactoryLoader instance for loading multiple factory types.
     */
    public ProtonFactoryLoader()
    {
        this(null);
    }

    public ProtonFactoryLoader(Class factoryInterface)
    {
        this(factoryInterface, getImpliedImplementationType());
    }

    static ImplementationType getImpliedImplementationType()
    {
        String implementationTypeFromSystemProperty = System.getProperty(IMPLEMENTATION_TYPE_PROPERTY);
        if(implementationTypeFromSystemProperty != null)
        {
            return ImplementationType.valueOf(implementationTypeFromSystemProperty);
        }
        else
        {
            return ImplementationType.ANY;
        }
    }

    /**
     * @param factoryInterface will be used as the factory interface class in calls to {@link #loadFactory()}.
     */
    public ProtonFactoryLoader(Class factoryInterface, ImplementationType implementationType)
    {
        _factoryInterface = factoryInterface;
        _implementationType = implementationType;
    }

    /**
     * Returns the Proton factory that implements the stored {@link ProtonFactoryLoader#_factoryInterface} class.
     */
    public C loadFactory()
    {
        return loadFactory(_factoryInterface);
    }

    public C loadFactory(Class factoryInterface)
    {
        if(factoryInterface == null)
        {
            throw new IllegalStateException("factoryInterface has not been set.");
        }
        ServiceLoader serviceLoader = ServiceLoader.load(factoryInterface);
        Iterator serviceLoaderIterator = serviceLoader.iterator();
        while(serviceLoaderIterator.hasNext())
        {
            C factory = serviceLoaderIterator.next();
            if(_implementationType == ImplementationType.ANY || factory.getImplementationType() == _implementationType)
            {
                if(LOGGER.isLoggable(Level.FINE))
                {
                    LOGGER.fine("loadFactory returning " + factory + " for loader's implementation type " + _implementationType);
                }
                return factory;
            }
        }
        throw new IllegalStateException("Can't find service loader for " + factoryInterface.getName() +
                                        " for implementation type " + _implementationType);
    }

}