graphdb/titan0/src/main/java/org/apache/atlas/repository/graphdb/titan0/Titan0GraphDatabase.java

/**
 * 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.atlas.repository.graphdb.titan0;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.Map;

import org.apache.atlas.ApplicationProperties;
import org.apache.atlas.AtlasException;
import org.apache.atlas.repository.graphdb.AtlasGraph;
import org.apache.atlas.repository.graphdb.GraphDatabase;
import org.apache.commons.configuration.Configuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.collect.ImmutableMap;
import com.thinkaurelius.titan.core.TitanFactory;
import com.thinkaurelius.titan.core.TitanGraph;
import com.thinkaurelius.titan.core.schema.TitanManagement;
import com.thinkaurelius.titan.core.util.TitanCleanup;
import com.thinkaurelius.titan.diskstorage.StandardIndexProvider;
import com.thinkaurelius.titan.diskstorage.solr.Solr5Index;

/**
 * Titan 0.5.4 implementation of GraphDatabase.
 */
public class Titan0GraphDatabase implements GraphDatabase<Titan0Vertex, Titan0Edge> {

    private static final Logger LOG = LoggerFactory.getLogger(Titan0GraphDatabase.class);

    /**
     * Constant for the configuration property that indicates the prefix.
     */
    public static final String GRAPH_PREFIX = "atlas.graph";

    public static final String INDEX_BACKEND_CONF = "index.search.backend";

    public static final String INDEX_BACKEND_LUCENE = "lucene";

    public static final String INDEX_BACKEND_ES = "elasticsearch";

    private static volatile Titan0Graph atlasGraphInstance = null;
    private static volatile TitanGraph graphInstance = null;

    public static Configuration getConfiguration() throws AtlasException {
        Configuration configProperties = ApplicationProperties.get();
        return ApplicationProperties.getSubsetConfiguration(configProperties, GRAPH_PREFIX);
    }

    static {
        addSolr5Index();
    }

    /**
     * Titan loads index backend name to implementation using
     * StandardIndexProvider.ALL_MANAGER_CLASSES But
     * StandardIndexProvider.ALL_MANAGER_CLASSES is a private static final
     * ImmutableMap Only way to inject Solr5Index is to modify this field. So,
     * using hacky reflection to add Sol5Index
     */
    private static void addSolr5Index() {
        try {
            Field field = StandardIndexProvider.class.getDeclaredField("ALL_MANAGER_CLASSES");
            field.setAccessible(true);

            Field modifiersField = Field.class.getDeclaredField("modifiers");
            modifiersField.setAccessible(true);
            modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL);

            Map<String, String> customMap = new HashMap<>(StandardIndexProvider.getAllProviderClasses());
            customMap.put("solr", Solr5Index.class.getName()); // for
                                                               // consistency
                                                               // with Titan
                                                               // 1.0.0
            customMap.put("solr5", Solr5Index.class.getName()); // for backward
                                                                // compatibility
            ImmutableMap<String, String> immap = ImmutableMap.copyOf(customMap);
            field.set(null, immap);

            LOG.debug("Injected solr5 index - {}", Solr5Index.class.getName());
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    public static TitanGraph getGraphInstance() {
        if (graphInstance == null) {
            synchronized (Titan0GraphDatabase.class) {
                if (graphInstance == null) {
                    Configuration config;
                    try {
                        config = getConfiguration();
                    } catch (AtlasException e) {
                        throw new RuntimeException(e);
                    }

                    graphInstance = TitanFactory.open(config);
                    atlasGraphInstance = new Titan0Graph();
                    validateIndexBackend(config);
                }
            }
        }
        return graphInstance;
    }

    public static void unload() {

        synchronized (Titan0GraphDatabase.class) {
            if (graphInstance == null) {
                return;
            }

            graphInstance.commit();
            //shutdown invalidates the graph instance
            graphInstance.shutdown();
            graphInstance = null;
        }
    }

    static void validateIndexBackend(Configuration config) {
        String configuredIndexBackend = config.getString(INDEX_BACKEND_CONF);
        TitanManagement managementSystem = null;

        try {
            managementSystem = getGraphInstance().getManagementSystem();
            String currentIndexBackend = managementSystem.get(INDEX_BACKEND_CONF);

            if (!equals(configuredIndexBackend, currentIndexBackend)) {
                throw new RuntimeException("Configured Index Backend " + configuredIndexBackend
                        + " differs from earlier configured Index Backend " + currentIndexBackend + ". Aborting!");
            }

        } finally {
            if (managementSystem != null) {
                managementSystem.commit();
            }
        }


    }

    private static boolean equals(Object o1, Object o2) {
        if (o1 == null) {
            return o2 == null;
        }
        return o1.equals(o2);
    }

    @Override
    public AtlasGraph<Titan0Vertex, Titan0Edge> getGraph() {
        // force graph loading up front to avoid bootstrapping
        // issues
        getGraphInstance();
        return atlasGraphInstance;
    }

    @Override
    public boolean isGraphLoaded() {
        return graphInstance != null;
    }


    @Override
    public void initializeTestGraph() {

       //nothing to do
    }

    @Override
    public void cleanup() {
        try {
            getGraphInstance().shutdown();
        } catch(Throwable t) {
            LOG.warn("Could not shutdown test TitanGraph", t);
            t.printStackTrace();
        }

        try {
            TitanCleanup.clear(getGraphInstance());
        } catch(Throwable t) {
            LOG.warn("Could not clear test TitanGraph", t);
            t.printStackTrace();
        }
    }

}