org.apache.solr.search.CacheConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * 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.solr.search;

import static org.apache.solr.common.params.CommonParams.NAME;

import java.lang.invoke.MethodHandles;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
import org.apache.solr.common.ConfigNode;
import org.apache.solr.common.MapSerializable;
import org.apache.solr.common.util.CollectionUtil;
import org.apache.solr.core.PluginInfo;
import org.apache.solr.core.SolrConfig;
import org.apache.solr.core.SolrResourceLoader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Contains the knowledge of how cache config is stored in the solrconfig.xml file, and implements a
 * factory to create caches.
 */
public class CacheConfig implements MapSerializable {
  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  private String nodeName;

  /**
   * When this object is created, the core is not yet available . So, if the class is to be loaded
   * from a package we should have a corresponding core
   */
  @SuppressWarnings({"rawtypes"})
  private Supplier> clazz;

  private Map args;
  private CacheRegenerator regenerator;

  private String cacheImpl;

  private Object[] persistence = new Object[1];

  private String regenImpl;

  public CacheConfig() {}

  @SuppressWarnings({"rawtypes"})
  public CacheConfig(
      Class clazz, Map args, CacheRegenerator regenerator) {
    this.clazz = () -> clazz;
    this.args = args;
    this.regenerator = regenerator;
    this.nodeName = args.get(NAME);
  }

  public CacheRegenerator getRegenerator() {
    return regenerator;
  }

  public void setRegenerator(CacheRegenerator regenerator) {
    this.regenerator = regenerator;
  }

  public static Map getMultipleConfigs(
      SolrResourceLoader loader, SolrConfig solrConfig, String configPath, List nodes) {
    if (nodes == null || nodes.isEmpty()) {
      return new LinkedHashMap<>();
    }
    Map result = CollectionUtil.newHashMap(nodes.size());
    for (ConfigNode node : nodes) {
      if (node.boolAttr("enabled", true)) {
        CacheConfig config =
            getConfig(loader, solrConfig, node.name(), node.attributes().asMap(), configPath);
        result.put(config.args.get(NAME), config);
      }
    }
    return result;
  }

  public static CacheConfig getConfig(SolrConfig solrConfig, ConfigNode node, String xpath) {
    if (!node.boolAttr("enabled", true) || !node.exists()) {
      return null;
    }
    return getConfig(solrConfig, node.name(), node.attributes().asMap(), xpath);
  }

  public static CacheConfig getConfig(
      SolrConfig solrConfig, String nodeName, Map attrs, String xpath) {
    return getConfig(solrConfig.getResourceLoader(), solrConfig, nodeName, attrs, xpath);
  }

  public static CacheConfig getConfig(
      SolrResourceLoader loader,
      SolrConfig solrConfig,
      String nodeName,
      Map attrs,
      String xpath) {
    CacheConfig config = new CacheConfig();
    config.nodeName = nodeName;
    Map attrsCopy = CollectionUtil.newLinkedHashMap(attrs.size());
    for (Map.Entry e : attrs.entrySet()) {
      attrsCopy.put(e.getKey(), String.valueOf(e.getValue()));
    }
    attrs = attrsCopy;
    config.args = attrs;

    Map map =
        xpath == null ? null : solrConfig.getOverlay().getEditableSubProperties(xpath);
    if (map != null) {
      HashMap mapCopy = new HashMap<>(config.args);
      for (Map.Entry e : map.entrySet()) {
        mapCopy.put(e.getKey(), String.valueOf(e.getValue()));
      }
      config.args = mapCopy;
    }
    String nameAttr = config.args.get(NAME); // OPTIONAL
    if (nameAttr == null) {
      config.args.put(NAME, config.nodeName);
    }

    config.cacheImpl = config.args.get("class");
    if (config.cacheImpl == null) config.cacheImpl = "solr.CaffeineCache";
    config.clazz =
        new Supplier<>() {
          @SuppressWarnings("rawtypes")
          Class loadedClass;

          @Override
          @SuppressWarnings("rawtypes")
          public Class get() {
            if (loadedClass != null) return loadedClass;
            return loadedClass =
                loader.findClass(
                    new PluginInfo("cache", Collections.singletonMap("class", config.cacheImpl)),
                    SolrCache.class,
                    true);
          }
        };
    config.regenImpl = config.args.get("regenerator");
    if (config.regenImpl != null) {
      config.regenerator = loader.newInstance(config.regenImpl, CacheRegenerator.class);
    }

    return config;
  }

  @SuppressWarnings({"rawtypes"})
  public SolrCache newInstance() {
    try {
      SolrCache cache = clazz.get().getConstructor().newInstance();
      persistence[0] = cache.init(args, persistence[0], regenerator);
      return cache;
    } catch (Exception e) {
      log.error("Error instantiating cache", e);
      // we can carry on without a cache... but should we?
      // in some cases (like an OOM) we probably should try to continue.
      return null;
    }
  }

  @Override
  public Map toMap(Map argsMap) {
    // TODO: Should not create new HashMap?
    return new HashMap<>(args);
  }

  public String getNodeName() {
    return nodeName;
  }
}