• Home
• org.apache.solr
• solr-core
• 9.6.0
• source code
• SolrXmlConfig.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.apache.solr.core.SolrXmlConfig Maven / Gradle / Ivy

/*
 * 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.core;

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

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.lang.invoke.MethodHandles;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.function.Consumer;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import javax.management.MBeanServer;
import org.apache.solr.client.solrj.impl.HttpClientUtil;
import org.apache.solr.cloud.ClusterSingleton;
import org.apache.solr.cluster.placement.PlacementPluginFactory;
import org.apache.solr.common.ConfigNode;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.util.CollectionUtil;
import org.apache.solr.common.util.DOMUtil;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.common.util.StrUtils;
import org.apache.solr.common.util.Utils;
import org.apache.solr.logging.LogWatcherConfig;
import org.apache.solr.metrics.reporters.SolrJmxReporter;
import org.apache.solr.search.CacheConfig;
import org.apache.solr.servlet.SolrDispatchFilter;
import org.apache.solr.update.UpdateShardHandlerConfig;
import org.apache.solr.util.DOMConfigNode;
import org.apache.solr.util.DataConfigNode;
import org.apache.solr.util.JmxUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.InputSource;

/** Loads {@code solr.xml}. */
public class SolrXmlConfig {

  // TODO should these from* methods return a NodeConfigBuilder so that the caller (a test) can make
  // further manipulations like add properties and set the CorePropertiesLocator and "async" mode?

  public static final String ZK_HOST = "zkHost";
  public static final String SOLR_XML_FILE = "solr.xml";
  public static final String SOLR_DATA_HOME = "solr.data.home";

  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  private static final Pattern COMMA_SEPARATED_PATTERN = Pattern.compile("\\s*,\\s*");

  /**
   * Given some node Properties, checks if non-null and a 'zkHost' is already included. If so, the
   * Properties are returned as is. If not, then the returned value will be a new Properties,
   * wrapping the original Properties, with the 'zkHost' value set based on the value of the
   * corresponding System property (if set)
   *
   * 
In theory we only need this logic once, ideally in SolrDispatchFilter, but we put it here to
   * re-use redundantly because of how much surface area our API has for various tests to poke at
   * us.
   */
  public static Properties wrapAndSetZkHostFromSysPropIfNeeded(final Properties props) {
    if (null != props && StrUtils.isNotNullOrEmpty(props.getProperty(ZK_HOST))) {
      // nothing to do...
      return props;
    }
    // we always wrap if we might set a property -- never mutate the original props
    final Properties results = (null == props ? new Properties() : new Properties(props));
    final String sysprop = System.getProperty(ZK_HOST);
    if (StrUtils.isNotNullOrEmpty(sysprop)) {
      results.setProperty(ZK_HOST, sysprop);
    }
    return results;
  }

  public static NodeConfig fromConfig(
      Path solrHome,
      Properties substituteProperties,
      boolean fromZookeeper,
      ConfigNode root,
      SolrResourceLoader loader) {

    checkForIllegalConfig(root);

    // sanity check: if our config came from zookeeper, then there *MUST* be Node Properties that
    // tell us what zkHost was used to read it (either via webapp context attribute, or that
    // SolrDispatchFilter filled in for us from system properties)
    assert ((!fromZookeeper)
        || (null != substituteProperties && null != substituteProperties.getProperty(ZK_HOST)));

    // Regardless of where/how we this XmlConfigFile was loaded from, if it contains a zkHost
    // property, we're going to use that as our "default" and only *directly* check the system
    // property if it's not specified.
    //
    // (checking the sys prop here is really just for tests that by-pass SolrDispatchFilter. In
    // non-test situations, SolrDispatchFilter will check the system property if needed in order to
    // try and load solr.xml from ZK, and should have put the sys prop value in the node properties
    // for us)
    final String defaultZkHost =
        wrapAndSetZkHostFromSysPropIfNeeded(substituteProperties).getProperty(ZK_HOST);

    CloudConfig cloudConfig = null;
    UpdateShardHandlerConfig deprecatedUpdateConfig = null;

    if (root.get("solrcloud").exists()) {
      NamedList