apoc.cache.Static Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apoc Show documentation
A collection of useful Neo4j Procedures
There is a newer version: 4.4.0.32
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * 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 apoc.cache;

import apoc.ApocConfig;
import apoc.Extended;
import apoc.result.KeyValueResult;
import apoc.result.ObjectResult;
import apoc.util.Util;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Stream;
import org.neo4j.internal.helpers.collection.Iterators;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.procedure.*;

/**
 * @author mh
 * @since 22.05.16
 */
@Extended
public class Static {

    @Context
    public GraphDatabaseAPI db;

    @Context
    public ApocConfig apocConfig;

    private static Map storage = new HashMap<>();

    @Procedure("apoc.static.get")
    @Deprecated
    @Description(
            "apoc.static.get(name) - returns statically stored value from config (apoc.static.) or server lifetime storage")
    public Stream getProcedure(@Name("key") String key) {
        return Stream.of(new ObjectResult(storage.getOrDefault(key, fromConfig(key))));
    }

    @UserFunction("apoc.static.get")
    @Description(
            "apoc.static.get(name) - returns statically stored value from config (apoc.static.) or server lifetime storage")
    public Object get(@Name("key") String key) {
        return storage.getOrDefault(key, fromConfig(key));
    }

    @UserFunction("apoc.static.getAll")
    @Description(
            "apoc.static.getAll(prefix) - returns statically stored values from config (apoc.static..*) or server lifetime storage")
    public Map getAll(@Name("prefix") String prefix) {
        return getFromConfigAndStorage(prefix);
    }

    private HashMap getFromConfigAndStorage(@Name("prefix") String prefix) {

        HashMap result = new HashMap<>();
        String configPrefix = prefix.isEmpty() ? "apoc.static" : "apoc.static." + prefix;
        Iterators.stream(apocConfig.getKeys(configPrefix))
                .forEach(s -> result.put(s.substring(configPrefix.length() + 1), apocConfig.getString(s)));
        result.putAll(Util.subMap(storage, prefix));
        return result;
    }

    @Procedure("apoc.static.list")
    @Description(
            "apoc.static.list(prefix) - returns statically stored values from config (apoc.static..*) or server lifetime storage")
    public Stream list(@Name("prefix") String prefix) {
        HashMap result = getFromConfigAndStorage(prefix);
        return result.entrySet().stream().map(e -> new KeyValueResult(e.getKey(), e.getValue()));
    }

    private Object fromConfig(@Name("key") String key) {
        return apocConfig.getString("apoc.static." + key);
    }

    @Procedure("apoc.static.set")
    @Description(
            "apoc.static.set(name, value) - stores value under key for server lifetime storage, returns previously stored or configured value")
    public Stream set(@Name("key") String key, @Name("value") Object value) {
        Object previous = value == null ? storage.remove(key) : storage.put(key, value);
        return Stream.of(new ObjectResult(previous == null ? fromConfig(key) : previous));
    }

    public static void clear() {
        storage.clear();
    }
}