org.semanticweb.owlapi.OWLAPIServiceLoaderModule Maven / Gradle / Ivy

/* This file is part of the OWL API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright 2014, The University of Manchester
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * 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.semanticweb.owlapi;

import java.util.Collection;
import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;

import javax.inject.Provider;

import org.semanticweb.owlapi.annotations.OwlapiModule;
import org.semanticweb.owlapi.io.OWLParser;
import org.semanticweb.owlapi.io.OWLParserFactory;
import org.semanticweb.owlapi.model.OWLDocumentFormat;
import org.semanticweb.owlapi.model.OWLDocumentFormatFactory;
import org.semanticweb.owlapi.model.OWLOntologyFactory;
import org.semanticweb.owlapi.model.OWLOntologyIRIMapper;
import org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration;
import org.semanticweb.owlapi.model.OWLOntologyManagerFactory;
import org.semanticweb.owlapi.model.OWLRuntimeException;
import org.semanticweb.owlapi.model.OWLStorer;
import org.semanticweb.owlapi.model.OWLStorerFactory;

import com.google.common.collect.Sets;
import com.google.inject.AbstractModule;
import com.google.inject.multibindings.Multibinder;

/**
 * owlapi module for dynamic loading - uses ServiceLoader to add extra bindings
 * for OWLParser, OWLOntologyStorer, OWLOntologyFactory, OWLOntologyIRIMapper
 */
@OwlapiModule
public class OWLAPIServiceLoaderModule extends AbstractModule {

    @Override
    protected void configure() {
        loadInstancesFromServiceLoader(OWLParser.class);
        loadInstancesFromServiceLoader(OWLStorer.class);
        loadInstancesFromServiceLoader(OWLOntologyFactory.class);
        loadInstancesFromServiceLoader(OWLOntologyIRIMapper.class);
        loadFactories(OWLDocumentFormatFactory.class, OWLDocumentFormat.class);
        loadFactories(OWLParserFactory.class, OWLParser.class);
        loadFactories(OWLStorerFactory.class, OWLStorer.class);
        loadOntologyManagerFactory();
        bind(OWLOntologyLoaderConfiguration.class).toProvider(
                OWLAPIConfigProvider.class);
    }

    protected  void loadInstancesFromServiceLoader(Class type) {
        try {
            Multibinder binder = Multibinder.newSetBinder(binder(), type);
            for (T o : load(type)) {
                binder.addBinding().toInstance(o);
            }
        } catch (ServiceConfigurationError e) {
            e.printStackTrace(System.out);
            throw new OWLRuntimeException("Injection failed for " + type, e);
        }
    }

    /**
     * @param type
     *        type to load
     * @return itrable over T implementations
     */
    protected  Iterable load(Class type) {
        // J2EE compatible search
        Collection list = Sets.newHashSet(ServiceLoader.load(type));
        // in OSGi, the context class loader is likely null.
        // This would trigger the use of the system class loader, which would
        // not see the OWLAPI jar, nor any other jar containing implementations.
        // In that case, use this class classloader to load, at a minimum, the
        // services provided by the OWLAPI jar itself.
        if (list.isEmpty()) {
            list = Sets.newHashSet(ServiceLoader.load(type, getClass()
                    .getClassLoader()));
        }
        return list;
    }

    protected > void loadFactories(Class factory,
            Class type) {
        try {
            Multibinder factoryBinder = Multibinder.newSetBinder(binder(),
                    factory);
            Multibinder binder = Multibinder.newSetBinder(binder(), type);
            for (F o : load(factory)) {
                factoryBinder.addBinding().toInstance(o);
                binder.addBinding().toInstance(o.get());
            }
        } catch (ServiceConfigurationError e) {
            e.printStackTrace(System.out);
            throw new OWLRuntimeException("Injection failed for factory: "
                    + factory + " type: " + type, e);
        }
    }

    protected void loadOntologyManagerFactory() {
        try {
            Multibinder binder = Multibinder
                    .newSetBinder(binder(), OWLOntologyManagerFactory.class);
            for (OWLOntologyManagerFactory o : load(OWLOntologyManagerFactory.class)) {
                binder.addBinding().toInstance(o);
            }
        } catch (ServiceConfigurationError e) {
            e.printStackTrace(System.out);
            throw new OWLRuntimeException(
                    "Injection failed for OWLOntologyManager factory", e);
        }
    }
}