uk.gov.gchq.gaffer.rest.config.GremlinConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-rest Show documentation
There is a newer version: 2.3.2
/*
 * Copyright 2024 Crown Copyright
 *
 * 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 uk.gov.gchq.gaffer.rest.config;

import org.apache.commons.configuration2.PropertiesConfiguration;
import org.apache.commons.configuration2.builder.fluent.Configurations;
import org.apache.commons.configuration2.ex.ConfigurationException;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.structure.Graph;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import uk.gov.gchq.gaffer.rest.factory.GraphFactory;
import uk.gov.gchq.gaffer.tinkerpop.GafferPopGraph;

@Configuration
public class GremlinConfig {
    private static final Logger LOGGER = LoggerFactory.getLogger(GremlinConfig.class);

    /**
     * Default path to look for a GafferPop properties file if not defined in the store properties.
     */
    private static final String DEFAULT_PROPERTIES = "/gaffer/gafferpop.properties";

    /**
     * Default timeout for executing gremlin queries (2 min).
     */
    private static final Long DEFAULT_REQUEST_TIMEOUT = 120000L;

    /**
     * Key for GafferPop properties file to specify the timeout on gremlin queries to the REST API.
     */
    private static final String REQUEST_TIMEOUT_KEY = "gaffer.rest.timeout";

    @Bean
    public GraphTraversalSource graphTraversalSource(final GraphFactory graphFactory) {
        // Obtain the graph traversal
        Graph graph = GafferPopGraph.open(findPropertiesFile(graphFactory), graphFactory.getGraph());
        return graph.traversal();
    }

    @Bean
    public Long requestTimeout(final GraphFactory graphFactory) {
        return findPropertiesFile(graphFactory).getLong(REQUEST_TIMEOUT_KEY, DEFAULT_REQUEST_TIMEOUT);
    }

    /**
     * Finds and loads the correct config file for gafferpop.
     *
     * @param graphFactory The graph factory.
     * @return Loaded properties from file.
     * @throws ConfigurationException If problem loading.
     */
    private PropertiesConfiguration findPropertiesFile(final GraphFactory graphFactory) {
        try {
            // Determine where to look for the GafferPop properties
            String gafferPopProperties = graphFactory.getGraph().getStoreProperties().get(GafferPopGraph.GAFFERPOP_PROPERTIES);
            if (gafferPopProperties == null) {
                LOGGER.warn("GafferPop properties file was not specified. Using default location: {}", DEFAULT_PROPERTIES);
                gafferPopProperties = DEFAULT_PROPERTIES;
            }
            return new Configurations().properties(gafferPopProperties);
        } catch (final ConfigurationException e) {
            LOGGER.warn("Using default values for GafferPop, failed to load a GafferPop config: {}", e.getMessage());
            return new PropertiesConfiguration();
        }
    }
}