Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-18112: SolrDispatchFilter is now SolrServlet (#4119)

David Smileyb3b2f83fe97e
diff --git a/changelog/unreleased/SOLR-18112-SolrDispatchFilterServlet.yml b/changelog/unreleased/SOLR-18112-SolrDispatchFilterServlet.yml
new file mode 100644
index 00000000000..3acba548f49
--- /dev/null
+++ b/changelog/unreleased/SOLR-18112-SolrDispatchFilterServlet.yml
@@ -0,0 +1,7 @@
+title: SolrDispatchFilter is now SolrServlet; isn't a Filter
+type: other
+authors:
+ - name: David Smiley
+links:
+ - name: SOLR-18112
+ url: https://issues.apache.org/jira/browse/SOLR-18112
diff --git a/solr/core/src/java/org/apache/solr/api/CoordinatorV2HttpSolrCall.java b/solr/core/src/java/org/apache/solr/api/CoordinatorV2HttpSolrCall.java
index 4fb2e888d50..c2b17be5ef7 100644
--- a/solr/core/src/java/org/apache/solr/api/CoordinatorV2HttpSolrCall.java
+++ b/solr/core/src/java/org/apache/solr/api/CoordinatorV2HttpSolrCall.java
@@ -22,7 +22,7 @@ import jakarta.servlet.http.HttpServletResponse;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.core.SolrCore;
import org.apache.solr.servlet.CoordinatorHttpSolrCall;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.HttpSolrCall;
public class CoordinatorV2HttpSolrCall extends V2HttpCall {
private String collectionName;
@@ -30,12 +30,11 @@ public class CoordinatorV2HttpSolrCall extends V2HttpCall {
public CoordinatorV2HttpSolrCall(
CoordinatorHttpSolrCall.Factory factory,
- SolrDispatchFilter solrDispatchFilter,
CoreContainer cc,
HttpServletRequest request,
HttpServletResponse response,
boolean retry) {
- super(solrDispatchFilter, cc, request, response, retry);
+ super(cc, request, response, retry);
this.factory = factory;
}
@@ -51,7 +50,7 @@ public class CoordinatorV2HttpSolrCall extends V2HttpCall {
@Override
protected void init() throws Exception {
super.init();
- if (action == SolrDispatchFilter.Action.PROCESS && core != null) {
+ if (action == HttpSolrCall.Action.PROCESS && core != null) {
solrReq = CoordinatorHttpSolrCall.wrappedReq(solrReq, collectionName, this);
}
}
diff --git a/solr/core/src/java/org/apache/solr/api/V2HttpCall.java b/solr/core/src/java/org/apache/solr/api/V2HttpCall.java
index 04ea7c6ee9e..ba2b6fa7af8 100644
--- a/solr/core/src/java/org/apache/solr/api/V2HttpCall.java
+++ b/solr/core/src/java/org/apache/solr/api/V2HttpCall.java
@@ -18,10 +18,10 @@
package org.apache.solr.api;
import static org.apache.solr.common.cloud.ZkStateReader.COLLECTION_PROP;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.ADMIN;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.ADMIN_OR_REMOTEPROXY;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.PROCESS;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.REMOTEPROXY;
+import static org.apache.solr.servlet.HttpSolrCall.Action.ADMIN;
+import static org.apache.solr.servlet.HttpSolrCall.Action.ADMIN_OR_REMOTEPROXY;
+import static org.apache.solr.servlet.HttpSolrCall.Action.PROCESS;
+import static org.apache.solr.servlet.HttpSolrCall.Action.REMOTEPROXY;
import io.opentelemetry.api.trace.Span;
import jakarta.servlet.http.HttpServletRequest;
@@ -56,7 +56,6 @@ import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.security.AuthorizationContext;
import org.apache.solr.servlet.HttpSolrCall;
-import org.apache.solr.servlet.SolrDispatchFilter;
import org.apache.solr.servlet.SolrRequestParsers;
import org.apache.solr.servlet.cache.Method;
import org.apache.solr.util.tracing.TraceUtils;
@@ -78,12 +77,8 @@ public class V2HttpCall extends HttpSolrCall {
static final Set<String> knownPrefixes = Set.of("cluster", "node", "collections", "cores", "c");
public V2HttpCall(
- SolrDispatchFilter solrDispatchFilter,
- CoreContainer cc,
- HttpServletRequest request,
- HttpServletResponse response,
- boolean retry) {
- super(solrDispatchFilter, cc, request, response, retry);
+ CoreContainer cc, HttpServletRequest request, HttpServletResponse response, boolean retry) {
+ super(cc, request, response, retry);
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java b/solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java
index 67146509da5..3001fd2afd5 100644
--- a/solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java
+++ b/solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java
@@ -16,7 +16,7 @@
*/
package org.apache.solr.cli;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE;
+import static org.apache.solr.servlet.CoreContainerProvider.SOLR_INSTALL_DIR;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
@@ -76,7 +76,7 @@ public class SolrProcessManager {
ph.pid(), parsePortFromProcess(ph).orElseThrow(), isProcessSsl(ph))));
portProcessMap =
pidProcessMap.values().stream().collect(Collectors.toUnmodifiableMap(p -> p.port, p -> p));
- String solrInstallDir = EnvUtils.getProperty(SOLR_INSTALL_DIR_ATTRIBUTE);
+ String solrInstallDir = EnvUtils.getProperty(SOLR_INSTALL_DIR);
pidDir =
Path.of(
EnvUtils.getProperty(
diff --git a/solr/core/src/java/org/apache/solr/cloud/SolrZkServer.java b/solr/core/src/java/org/apache/solr/cloud/SolrZkServer.java
index 84617c70027..cdd3ae90f86 100644
--- a/solr/core/src/java/org/apache/solr/cloud/SolrZkServer.java
+++ b/solr/core/src/java/org/apache/solr/cloud/SolrZkServer.java
@@ -27,7 +27,7 @@ import java.util.Properties;
import java.util.concurrent.atomic.AtomicReference;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.util.EnvUtils;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.util.AddressUtils;
import org.apache.zookeeper.server.ServerConfig;
import org.apache.zookeeper.server.ZooKeeperServerMain;
@@ -104,12 +104,12 @@ public class SolrZkServer {
var zooCfgPath = Path.of(confHome).resolve("zoo.cfg");
if (!Files.exists(zooCfgPath)) {
log.info("Zookeeper configuration not found in {}, using built-in default", confHome);
- String solrInstallDir = System.getProperty(SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ String solrInstallDir = System.getProperty(CoreContainerProvider.SOLR_INSTALL_DIR);
if (solrInstallDir == null) {
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR,
"Could not find default zoo.cfg file due to missing "
- + SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ + CoreContainerProvider.SOLR_INSTALL_DIR);
}
zooCfgPath = Path.of(solrInstallDir).resolve("server").resolve("solr").resolve("zoo.cfg");
}
diff --git a/solr/core/src/java/org/apache/solr/core/ConfigSetService.java b/solr/core/src/java/org/apache/solr/core/ConfigSetService.java
index 409809a7d98..99d237f9e38 100644
--- a/solr/core/src/java/org/apache/solr/core/ConfigSetService.java
+++ b/solr/core/src/java/org/apache/solr/core/ConfigSetService.java
@@ -38,7 +38,7 @@ import org.apache.solr.common.util.StrUtils;
import org.apache.solr.handler.admin.ConfigSetsHandler;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.schema.IndexSchemaFactory;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -48,6 +48,7 @@ public abstract class ConfigSetService {
public static final String UPLOAD_FILENAME_EXCLUDE_REGEX = "^\\..*$";
public static final Pattern UPLOAD_FILENAME_EXCLUDE_PATTERN =
Pattern.compile(UPLOAD_FILENAME_EXCLUDE_REGEX);
+ public static final String SOLR_CONFIGSET_DEFAULT_CONFDIR = "solr.configset.default.confdir";
public static final String FORBIDDEN_FILE_TYPES_PROP = "solr.configset.forbidden.file.types";
public static final Set<String> DEFAULT_FORBIDDEN_FILE_TYPES =
@@ -136,7 +137,7 @@ public abstract class ConfigSetService {
log.warn(
"The _default configset could not be uploaded. Please provide 'solr.configset.default.confdir' parameter that points to a configset {} {}",
"intended to be the default. Current 'solr.configset.default.confdir' value:",
- System.getProperty(SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE));
+ System.getProperty(SOLR_CONFIGSET_DEFAULT_CONFDIR));
} else {
this.uploadConfig(ConfigSetsHandler.DEFAULT_CONFIGSET_NAME, configDirPath);
}
@@ -161,11 +162,10 @@ public abstract class ConfigSetService {
* to the sysprop "solr.install.dir". Returns null if not found anywhere.
*
* @lucene.internal
- * @see SolrDispatchFilter#SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE
+ * @see ConfigSetService#SOLR_CONFIGSET_DEFAULT_CONFDIR
*/
public static Path getDefaultConfigDirPath() {
- String confDir =
- System.getProperty(SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE);
+ String confDir = System.getProperty(SOLR_CONFIGSET_DEFAULT_CONFDIR);
if (confDir != null) {
Path path = Path.of(confDir);
if (Files.exists(path)) {
@@ -173,7 +173,7 @@ public abstract class ConfigSetService {
}
}
- String installDir = System.getProperty(SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ String installDir = System.getProperty(CoreContainerProvider.SOLR_INSTALL_DIR);
if (installDir != null) {
Path subPath = Path.of("server", "solr", "configsets", "_default", "conf");
Path path = Path.of(installDir).resolve(subPath);
diff --git a/solr/core/src/java/org/apache/solr/core/NodeConfig.java b/solr/core/src/java/org/apache/solr/core/NodeConfig.java
index c52cb54e60e..1634c2c29e8 100644
--- a/solr/core/src/java/org/apache/solr/core/NodeConfig.java
+++ b/solr/core/src/java/org/apache/solr/core/NodeConfig.java
@@ -43,7 +43,7 @@ import org.apache.solr.common.util.EnvUtils;
import org.apache.solr.common.util.StrUtils;
import org.apache.solr.logging.LogWatcherConfig;
import org.apache.solr.search.CacheConfig;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.update.UpdateShardHandlerConfig;
import org.apache.solr.util.ModuleUtils;
import org.slf4j.Logger;
@@ -294,7 +294,7 @@ public class NodeConfig {
* @return path to install dir or null if solr.install.dir not set.
*/
public static Path getSolrInstallDir() {
- String prop = System.getProperty(SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ String prop = System.getProperty(CoreContainerProvider.SOLR_INSTALL_DIR);
if (prop == null || prop.isBlank()) {
log.debug("solr.install.dir property not initialized.");
return null;
@@ -451,7 +451,7 @@ public class NodeConfig {
if (solrInstallDir == null) {
log.warn(
"Unable to add $SOLR_HOME/lib for shared lib since {} was not set.",
- SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ CoreContainerProvider.SOLR_INSTALL_DIR);
} else {
// Always add $SOLR_TIP/lib to the shared resource loader
libDirs.add(solrInstallDir.resolve("lib").toAbsolutePath().normalize().toString());
@@ -524,7 +524,7 @@ public class NodeConfig {
"Unable to setup modules "
+ moduleNames
+ " because "
- + SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE
+ + CoreContainerProvider.SOLR_INSTALL_DIR
+ " was not set.");
}
return;
diff --git a/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java b/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java
index 14e87a52701..c4b801a28bc 100644
--- a/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java
+++ b/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java
@@ -49,7 +49,7 @@ import org.apache.solr.common.util.StrUtils;
import org.apache.solr.common.util.Utils;
import org.apache.solr.logging.LogWatcherConfig;
import org.apache.solr.search.CacheConfig;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.update.UpdateShardHandlerConfig;
import org.apache.solr.util.DOMConfigNode;
import org.apache.solr.util.DataConfigNode;
@@ -77,9 +77,8 @@ public class SolrXmlConfig {
* wrapping the original Properties, with the 'zkHost' value set based on the value of the
* corresponding System property (if set)
*
- * <p>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.
+ * <p>In theory we only need this logic once, ideally in SolrServlet, 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))) {
@@ -104,8 +103,8 @@ public class SolrXmlConfig {
// *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
+ // (checking the sys prop here is really just for tests that by-pass SolrServlet. In
+ // non-test situations, SolrServlet 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 =
@@ -180,12 +179,12 @@ public class SolrXmlConfig {
"solr.xml does not exist in " + configFile.getParent() + " cannot start Solr");
}
log.info("solr.xml not found in SOLR_HOME, using built-in default");
- String solrInstallDir = System.getProperty(SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ String solrInstallDir = System.getProperty(CoreContainerProvider.SOLR_INSTALL_DIR);
if (solrInstallDir == null) {
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR,
"Could not find default solr.xml file due to missing "
- + SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE);
+ + CoreContainerProvider.SOLR_INSTALL_DIR);
}
configFile = Path.of(solrInstallDir).resolve("server").resolve("solr").resolve("solr.xml");
}
diff --git a/solr/core/src/java/org/apache/solr/request/SolrRequestInfo.java b/solr/core/src/java/org/apache/solr/request/SolrRequestInfo.java
index a7d92859d26..fe3b6a69742 100644
--- a/solr/core/src/java/org/apache/solr/request/SolrRequestInfo.java
+++ b/solr/core/src/java/org/apache/solr/request/SolrRequestInfo.java
@@ -32,7 +32,7 @@ import org.apache.solr.common.util.ExecutorUtil;
import org.apache.solr.handler.component.ResponseBuilder;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.search.QueryLimits;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.HttpSolrCall;
import org.apache.solr.util.TimeZoneUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -54,7 +54,7 @@ public class SolrRequestInfo {
private TimeZone tz;
private ResponseBuilder rb;
private List<AutoCloseable> closeHooks;
- private SolrDispatchFilter.Action action;
+ private HttpSolrCall.Action action;
private boolean useServerToken = false;
private Principal principal;
@@ -154,8 +154,7 @@ public class SolrRequestInfo {
this.principal = req != null ? req.getUserPrincipal() : null;
}
- public SolrRequestInfo(
- SolrQueryRequest req, SolrQueryResponse rsp, SolrDispatchFilter.Action action) {
+ public SolrRequestInfo(SolrQueryRequest req, SolrQueryResponse rsp, HttpSolrCall.Action action) {
this(req, rsp);
this.setAction(action);
}
@@ -166,7 +165,7 @@ public class SolrRequestInfo {
}
public SolrRequestInfo(
- HttpServletRequest httpReq, SolrQueryResponse rsp, SolrDispatchFilter.Action action) {
+ HttpServletRequest httpReq, SolrQueryResponse rsp, HttpSolrCall.Action action) {
this(httpReq, rsp);
this.action = action;
}
@@ -259,11 +258,11 @@ public class SolrRequestInfo {
request.getContext().computeIfAbsent(LIMITS_KEY, (k) -> new QueryLimits(request, response));
}
- public SolrDispatchFilter.Action getAction() {
+ public HttpSolrCall.Action getAction() {
return action;
}
- public void setAction(SolrDispatchFilter.Action action) {
+ public void setAction(HttpSolrCall.Action action) {
this.action = action;
}
diff --git a/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java b/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
index 2591a9f1fe3..873a2aadc37 100644
--- a/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
@@ -80,8 +80,8 @@ public abstract class BaseSolrResource {
}
/**
- * Pulls the SolrQueryRequest constructed in SolrDispatchFilter from the SolrRequestInfo thread
- * local, then gets the SolrCore and IndexSchema and sets up the response. writer.
+ * Pulls the SolrQueryRequest constructed in SolrServlet from the SolrRequestInfo thread local,
+ * then gets the SolrCore and IndexSchema and sets up the response. writer.
*/
public void doInit(SolrQueryRequest solrRequest, SolrQueryResponse solrResponse) {
try {
diff --git a/solr/core/src/java/org/apache/solr/servlet/CoordinatorHttpSolrCall.java b/solr/core/src/java/org/apache/solr/servlet/CoordinatorHttpSolrCall.java
index f28ffdafaaf..450d6c2c652 100644
--- a/solr/core/src/java/org/apache/solr/servlet/CoordinatorHttpSolrCall.java
+++ b/solr/core/src/java/org/apache/solr/servlet/CoordinatorHttpSolrCall.java
@@ -58,12 +58,11 @@ public class CoordinatorHttpSolrCall extends HttpSolrCall {
public CoordinatorHttpSolrCall(
Factory factory,
- SolrDispatchFilter solrDispatchFilter,
CoreContainer cores,
HttpServletRequest request,
HttpServletResponse response,
boolean retry) {
- super(solrDispatchFilter, cores, request, response, retry);
+ super(cores, request, response, retry);
this.factory = factory;
}
@@ -150,7 +149,7 @@ public class CoordinatorHttpSolrCall extends HttpSolrCall {
@Override
protected void init() throws Exception {
super.init();
- if (action == SolrDispatchFilter.Action.PROCESS && core != null) {
+ if (action == HttpSolrCall.Action.PROCESS && core != null) {
solrReq = wrappedReq(solrReq, collectionName, this);
}
}
@@ -199,24 +198,23 @@ public class CoordinatorHttpSolrCall extends HttpSolrCall {
}
// The factory that creates an instance of HttpSolrCall
- public static class Factory implements SolrDispatchFilter.HttpSolrCallFactory {
+ public static class Factory implements SolrServlet.HttpSolrCallFactory {
private final Map<String, String> collectionVsCoreNameMapping = new ConcurrentHashMap<>();
@Override
public HttpSolrCall createInstance(
- SolrDispatchFilter filter,
String path,
CoreContainer cores,
HttpServletRequest request,
HttpServletResponse response,
boolean retry) {
if ((path.startsWith("/____v2/") || path.equals("/____v2"))) {
- return new CoordinatorV2HttpSolrCall(this, filter, cores, request, response, retry);
+ return new CoordinatorV2HttpSolrCall(this, cores, request, response, retry);
} else if (path.startsWith("/" + SYNTHETIC_COLL_PREFIX)) {
- return SolrDispatchFilter.HttpSolrCallFactory.super.createInstance(
- filter, path, cores, request, response, retry);
+ return SolrServlet.HttpSolrCallFactory.super.createInstance(
+ path, cores, request, response, retry);
} else {
- return new CoordinatorHttpSolrCall(this, filter, cores, request, response, retry);
+ return new CoordinatorHttpSolrCall(this, cores, request, response, retry);
}
}
}
diff --git a/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java b/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java
index c718ef0e569..19d06f392b7 100644
--- a/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java
+++ b/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java
@@ -17,11 +17,6 @@
package org.apache.solr.servlet;
import static org.apache.solr.core.NodeConfig.loadNodeConfig;
-import static org.apache.solr.servlet.SolrDispatchFilter.PROPERTIES_ATTRIBUTE;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLRHOME_ATTRIBUTE;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLR_LOG_LEVEL;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLR_LOG_MUTECONSOLE;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletContextEvent;
@@ -61,6 +56,12 @@ import org.slf4j.LoggerFactory;
* instance of solr.
*/
public class CoreContainerProvider implements ServletContextListener {
+ public static final String SOLR_PROPERTIES = "solr.properties";
+ public static final String SOLR_SOLR_HOME = "solr.solr.home";
+ public static final String SOLR_INSTALL_DIR = "solr.install.dir";
+ public static final String SOLR_LOG_MUTECONSOLE = "solr.log.muteconsole";
+ public static final String SOLR_LOG_LEVEL = "solr.log.level";
+
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
private CoreContainer cores;
@@ -90,10 +91,8 @@ public class CoreContainerProvider implements ServletContextListener {
// could remove ourselves from ctx but why bother
}
- /**
- * @see SolrDispatchFilter#getCores()
- */
- CoreContainer getCoreContainer() throws UnavailableException {
+ /** The CoreContainer. Never null. */
+ public CoreContainer getCoreContainer() throws UnavailableException {
checkReady();
return cores;
}
@@ -145,7 +144,7 @@ public class CoreContainerProvider implements ServletContextListener {
// caller
Properties extraProperties =
SolrXmlConfig.wrapAndSetZkHostFromSysPropIfNeeded(
- (Properties) servletContext.getAttribute(PROPERTIES_ATTRIBUTE));
+ (Properties) servletContext.getAttribute(SOLR_PROPERTIES));
StartupLoggingUtils.checkLogDir();
if (log.isInfoEnabled()) {
@@ -209,8 +208,7 @@ public class CoreContainerProvider implements ServletContextListener {
getSolrPort());
}
if (log.isInfoEnabled()) {
- log.info(
- "\\__ \\/ _ \\ | '_| Install dir: {}", System.getProperty(SOLR_INSTALL_DIR_ATTRIBUTE));
+ log.info("\\__ \\/ _ \\ | '_| Install dir: {}", System.getProperty(SOLR_INSTALL_DIR));
}
if (log.isInfoEnabled()) {
log.info("|___/\\___/_|_| Start time: {}", Instant.now());
@@ -295,8 +293,8 @@ public class CoreContainerProvider implements ServletContextListener {
private static Path computeSolrHome(ServletContext servletContext) {
// start with explicit check of servlet config...
- String source = "servlet config: " + SOLRHOME_ATTRIBUTE;
- String home = (String) servletContext.getAttribute(SOLRHOME_ATTRIBUTE);
+ String source = "servlet config: " + SOLR_SOLR_HOME;
+ String home = (String) servletContext.getAttribute(SOLR_SOLR_HOME);
if (null == home) {
final String lookup = "java:comp/env/solr/home";
diff --git a/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java b/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java
index ae042c7343b..cfcc58907e8 100644
--- a/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java
+++ b/solr/core/src/java/org/apache/solr/servlet/HttpSolrCall.java
@@ -21,13 +21,12 @@ import static org.apache.solr.common.cloud.ZkStateReader.CORE_NAME_PROP;
import static org.apache.solr.common.cloud.ZkStateReader.NODE_NAME_PROP;
import static org.apache.solr.security.AuditEvent.EventType.COMPLETED;
import static org.apache.solr.security.AuditEvent.EventType.ERROR;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.ADMIN;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.FORWARD;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.PASSTHROUGH;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.PROCESS;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.REMOTEPROXY;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.RETRY;
-import static org.apache.solr.servlet.SolrDispatchFilter.Action.RETURN;
+import static org.apache.solr.servlet.HttpSolrCall.Action.ADMIN;
+import static org.apache.solr.servlet.HttpSolrCall.Action.FORWARD;
+import static org.apache.solr.servlet.HttpSolrCall.Action.PROCESS;
+import static org.apache.solr.servlet.HttpSolrCall.Action.REMOTEPROXY;
+import static org.apache.solr.servlet.HttpSolrCall.Action.RETRY;
+import static org.apache.solr.servlet.HttpSolrCall.Action.RETURN;
import io.opentelemetry.api.trace.Span;
import jakarta.servlet.http.HttpServletRequest;
@@ -99,7 +98,6 @@ import org.apache.solr.security.AuthorizationContext.RequestType;
import org.apache.solr.security.AuthorizationUtils;
import org.apache.solr.security.HttpServletAuthorizationContext;
import org.apache.solr.security.PublicKeyHandler;
-import org.apache.solr.servlet.SolrDispatchFilter.Action;
import org.apache.solr.servlet.cache.HttpCacheHeaderUtil;
import org.apache.solr.servlet.cache.Method;
import org.apache.solr.update.processor.DistributingUpdateProcessorFactory;
@@ -117,7 +115,6 @@ public class HttpSolrCall {
public static final String INTERNAL_REQUEST_COUNT = "_forwardedCount";
- protected final SolrDispatchFilter solrDispatchFilter;
protected final CoreContainer cores;
protected final HttpServletRequest req;
protected final HttpServletResponse response;
@@ -143,13 +140,28 @@ public class HttpSolrCall {
protected RequestType requestType;
+ /** Enum to define action that needs to be processed. */
+ public enum Action {
+ /** Forwards the request via {@link jakarta.servlet.RequestDispatcher}. */
+ FORWARD,
+ /**
+ * Returns the control, and no further specific processing is needed. This is generally when an
+ * error is set and returned.
+ */
+ RETURN,
+ /** Retry the request. Currently used when a core isn't found, we refresh state, and retry. */
+ RETRY,
+ ADMIN,
+ REMOTEPROXY,
+ PROCESS,
+ ADMIN_OR_REMOTEPROXY
+ }
+
public HttpSolrCall(
- SolrDispatchFilter solrDispatchFilter,
CoreContainer cores,
HttpServletRequest request,
HttpServletResponse response,
boolean retry) {
- this.solrDispatchFilter = solrDispatchFilter;
this.cores = cores;
this.req = request;
this.response = response;
@@ -304,9 +316,11 @@ public class HttpSolrCall {
return; // we are done with a valid handler
}
}
- log.debug("no handler or core retrieved for {}, follow through...", path);
- action = PASSTHROUGH;
+ String msg = "no handler, collection, or core for " + path;
+ sendError(404, msg);
+ log.info(msg); // not "error" since Solr isn't necessarily at fault
+ action = RETURN;
}
/**
@@ -422,12 +436,6 @@ public class HttpSolrCall {
return RETURN;
}
- if (solrDispatchFilter.abortErrorMessage != null) {
- sendError(500, solrDispatchFilter.abortErrorMessage);
- cores.audit(() -> new AuditEvent(ERROR, getReq()), ERROR);
- return RETURN;
- }
-
try {
init();
diff --git a/solr/core/src/java/org/apache/solr/servlet/LoadAdminUiServlet.java b/solr/core/src/java/org/apache/solr/servlet/LoadAdminUiServlet.java
index 1c381f06f8c..316e0eb59ca 100644
--- a/solr/core/src/java/org/apache/solr/servlet/LoadAdminUiServlet.java
+++ b/solr/core/src/java/org/apache/solr/servlet/LoadAdminUiServlet.java
@@ -16,9 +16,8 @@
*/
package org.apache.solr.servlet;
-import static org.apache.solr.servlet.RequiredSolrRequestFilter.CORE_CONTAINER_REQUEST_ATTRIBUTE;
-
import com.google.common.net.HttpHeaders;
+import jakarta.servlet.UnavailableException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
@@ -31,7 +30,6 @@ import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.commons.io.output.CloseShieldOutputStream;
-import org.apache.solr.core.CoreContainer;
import org.apache.solr.core.SolrCore;
/**
@@ -62,11 +60,11 @@ public final class LoadAdminUiServlet extends HttpServlet {
response.addHeader(
"X-Frame-Options", "DENY"); // security: SOLR-7966 - avoid clickjacking for admin interface
- // This attribute is set by the SolrDispatchFilter
String admin = request.getRequestURI().substring(request.getContextPath().length());
- CoreContainer cores = (CoreContainer) request.getAttribute(CORE_CONTAINER_REQUEST_ATTRIBUTE);
try (InputStream in = getServletContext().getResourceAsStream(admin)) {
- if (in != null && cores != null) {
+ CoreContainerProvider.serviceForContext(getServletConfig().getServletContext())
+ .getCoreContainer();
+ if (in != null) {
response.setCharacterEncoding("UTF-8");
response.setContentType("text/html");
String connectSrc = generateCspConnectSrc();
@@ -88,6 +86,8 @@ public final class LoadAdminUiServlet extends HttpServlet {
} else {
response.sendError(404);
}
+ } catch (UnavailableException e) { // from CoreContainer being unavailable
+ response.sendError(404);
}
}
diff --git a/solr/core/src/java/org/apache/solr/servlet/RequiredSolrRequestFilter.java b/solr/core/src/java/org/apache/solr/servlet/RequiredSolrRequestFilter.java
index 7cdddfb2c5b..01b135d5f8c 100644
--- a/solr/core/src/java/org/apache/solr/servlet/RequiredSolrRequestFilter.java
+++ b/solr/core/src/java/org/apache/solr/servlet/RequiredSolrRequestFilter.java
@@ -73,7 +73,6 @@ public class RequiredSolrRequestFilter extends CoreContainerAwareHttpFilter {
req.setAttribute(SolrRequestParsers.REQUEST_TIMER_SERVLET_ATTRIBUTE, new RTimerTree());
// put the core container in request attribute
- // This is required for the LoadAdminUiServlet class. Removing it will cause 404
req.setAttribute(CORE_CONTAINER_REQUEST_ATTRIBUTE, getCores());
// we want to prevent any attempts to close our request or response prematurely
diff --git a/solr/core/src/java/org/apache/solr/servlet/SolrRequestParsers.java b/solr/core/src/java/org/apache/solr/servlet/SolrRequestParsers.java
index e835d844db8..82ef9ec2341 100644
--- a/solr/core/src/java/org/apache/solr/servlet/SolrRequestParsers.java
+++ b/solr/core/src/java/org/apache/solr/servlet/SolrRequestParsers.java
@@ -466,10 +466,9 @@ public class SolrRequestParsers {
@Override
public InputStream getStream() throws IOException {
- // we explicitly protect this servlet stream from being closed
- // so that it does not trip our test assert in our close shield
- // in SolrDispatchFilter - we must allow closes from getStream
- // due to the other impls of ContentStream
+ // We explicitly protect this servlet stream from being closed so it does not trip our test
+ // assert in ServletUtils.closeShield; we must allow closes from getStream due to other
+ // ContentStream impls.
return new CloseShieldInputStream(inputStream);
}
}
@@ -668,10 +667,11 @@ public class SolrRequestParsers {
public static SolrException getParameterIncompatibilityException() {
return new SolrException(
ErrorCode.SERVER_ERROR,
- "Solr requires that request parameters sent using application/x-www-form-urlencoded "
- + "content-type can be read through the request input stream. Unfortunately, the "
- + "stream was empty / not available. This may be caused by another servlet filter calling "
- + "ServletRequest.getParameter*() before SolrDispatchFilter, please remove it.");
+ """
+ Solr requires that request parameters sent using application/x-www-form-urlencoded \
+ content-type can be read through the request input stream. Unfortunately, the \
+ stream was empty / not available. This may be caused by a servlet filter calling \
+ ServletRequest.getParameter*(). Please remove it.""");
}
public boolean isFormData(HttpServletRequest req) {
diff --git a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java b/solr/core/src/java/org/apache/solr/servlet/SolrServlet.java
similarity index 53%
rename from solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java
rename to solr/core/src/java/org/apache/solr/servlet/SolrServlet.java
index 300c54ac562..3722ea2a26a 100644
--- a/solr/core/src/java/org/apache/solr/servlet/SolrDispatchFilter.java
+++ b/solr/core/src/java/org/apache/solr/servlet/SolrServlet.java
@@ -18,10 +18,10 @@ package org.apache.solr.servlet;
import static org.apache.solr.util.tracing.TraceUtils.getSpan;
-import jakarta.servlet.FilterChain;
-import jakarta.servlet.FilterConfig;
+import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.UnavailableException;
+import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
@@ -37,80 +37,58 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * This filter instantiates an instance of {@link HttpSolrCall}, invokes it and then based on the
- * action returned handles retry/forward/passthrough dispatch decisions.
- *
- * @since solr 1.2
+ * Solr's interface to Jetty, and passes requests to {@link HttpSolrCall}. Formerly known as {@code
+ * SolrDispatchFilter}.
*/
-public class SolrDispatchFilter extends CoreContainerAwareHttpFilter {
+public class SolrServlet extends HttpServlet {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- protected String abortErrorMessage = null;
-
private HttpSolrCallFactory solrCallFactory;
-
- public final boolean isV2Enabled = V2ApiUtils.isEnabled();
-
- /**
- * Enum to define action that needs to be processed. PASSTHROUGH: Pass through to another filter
- * via webapp. FORWARD: Forward rewritten URI (without path prefix and core/collection name) to
- * another filter in the chain RETURN: Returns the control, and no further specific processing is
- * needed. This is generally when an error is set and returned. RETRY:Retry the request. In cases
- * when a core isn't found to work with, this is set.
- */
- public enum Action {
- PASSTHROUGH,
- FORWARD,
- RETURN,
- RETRY,
- ADMIN,
- REMOTEPROXY,
- PROCESS,
- ADMIN_OR_REMOTEPROXY
- }
-
- public SolrDispatchFilter() {}
-
- public static final String PROPERTIES_ATTRIBUTE = "solr.properties";
-
- public static final String SOLRHOME_ATTRIBUTE = "solr.solr.home";
-
- public static final String SOLR_INSTALL_DIR_ATTRIBUTE = "solr.install.dir";
-
- public static final String SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE =
- "solr.configset.default.confdir";
-
- public static final String SOLR_LOG_MUTECONSOLE = "solr.log.muteconsole";
-
- public static final String SOLR_LOG_LEVEL = "solr.log.level";
+ private CoreContainerProvider containerProvider;
@Override
- public void init(FilterConfig config) throws ServletException {
+ public void init(ServletConfig config) throws ServletException {
try {
super.init(config);
+ containerProvider = CoreContainerProvider.serviceForContext(config.getServletContext());
boolean isCoordinator =
NodeRoles.MODE_ON.equals(getCores().nodeRoles.getRoleMode(NodeRoles.Role.COORDINATOR));
solrCallFactory =
isCoordinator ? new CoordinatorHttpSolrCall.Factory() : new HttpSolrCallFactory() {};
if (log.isTraceEnabled()) {
- log.trace("SolrDispatchFilter.init(): {}", this.getClass().getClassLoader());
+ log.trace("init(): {}", this.getClass().getClassLoader());
}
} catch (Throwable t) {
- // catch this so our filter still works
- log.error("Could not start Dispatch Filter.", t);
+ // catch this so our servlet still works
+ log.error("Could not start Servlet.", t);
if (t instanceof Error) {
throw (Error) t;
}
} finally {
- log.trace("SolrDispatchFilter.init() done");
+ log.trace("init() done");
}
}
+ /**
+ * The CoreContainer. It's guaranteed to be constructed before this servlet is initialized, but
+ * could have been shut down. Never null.
+ */
+ public CoreContainer getCores() throws UnavailableException {
+ return containerProvider.getCoreContainer();
+ }
+
@Override
- public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
+ protected void service(HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
- // internal version of doFilter that tracks if we are in a retry
- dispatch(chain, request, response, false);
+ // Handle root path specially - forward to index.html to trigger welcome-file mechanism
+ String path = ServletUtils.getPathAfterContext(request);
+ if (path.isEmpty() || path.equals("/")) {
+ request.getRequestDispatcher("/index.html").forward(request, response);
+ return;
+ }
+
+ // internal version that tracks if we are in a retry
+ dispatch(request, response, false);
}
/*
@@ -119,15 +97,13 @@ public class SolrDispatchFilter extends CoreContainerAwareHttpFilter {
For over a decade this class did anything and everything
In late 2021 SOLR-15590 moved container startup to CoreContainerProvider
In late 2025 SOLR-18040 moved request wrappers to independent ServletFilters
- such as PathExclusionFilter see web.xml for a full, up-to-date list
- This class is only handling dispatch, please think twice before adding anything else to it.
- */
+ This class is now basically only passing the request to HttpSolrCall.
+ Please think twice before adding anything else to it.
+ */
- private void dispatch(
- FilterChain chain, HttpServletRequest request, HttpServletResponse response, boolean retry)
+ private void dispatch(HttpServletRequest request, HttpServletResponse response, boolean retry)
throws IOException, ServletException {
- var span = getSpan(request);
HttpSolrCall call = getHttpSolrCall(request, response, retry);
// this flag LOOKS like it should be in RequiredSolrRequestFilter, but
@@ -136,27 +112,17 @@ public class SolrDispatchFilter extends CoreContainerAwareHttpFilter {
// BUG? Important timing?
ExecutorUtil.setServerThreadFlag(Boolean.TRUE);
try {
- Action result = call.call();
- switch (result) {
- case PASSTHROUGH:
- span.addEvent("SolrDispatchFilter PASSTHROUGH");
- chain.doFilter(request, response);
- break;
- case RETRY:
- span.addEvent("SolrDispatchFilter RETRY");
+ switch (call.call()) {
+ case RETRY -> {
+ getSpan(request).addEvent("Action RETRY");
// RECURSION
- dispatch(chain, request, response, true);
- break;
- case FORWARD:
- span.addEvent("SolrDispatchFilter FORWARD");
+ dispatch(request, response, true);
+ }
+ case FORWARD -> {
+ getSpan(request).addEvent("Action FORWARD");
request.getRequestDispatcher(call.getPath()).forward(request, response);
- break;
- case ADMIN:
- case PROCESS:
- case REMOTEPROXY:
- case ADMIN_OR_REMOTEPROXY:
- case RETURN:
- break;
+ }
+ default -> {}
}
} finally {
call.destroy();
@@ -177,22 +143,23 @@ public class SolrDispatchFilter extends CoreContainerAwareHttpFilter {
} catch (UnavailableException e) {
throw new SolrException(ErrorCode.SERVER_ERROR, "Core Container Unavailable");
}
- return solrCallFactory.createInstance(this, path, cores, request, response, retry);
+ return solrCallFactory.createInstance(path, cores, request, response, retry);
}
- /** internal API */
+ /**
+ * @lucene.internal
+ */
public interface HttpSolrCallFactory {
default HttpSolrCall createInstance(
- SolrDispatchFilter filter,
String path,
CoreContainer cores,
HttpServletRequest request,
HttpServletResponse response,
boolean retry) {
- if (filter.isV2Enabled && (path.startsWith("/____v2/") || path.equals("/____v2"))) {
- return new V2HttpCall(filter, cores, request, response, retry);
+ if (V2ApiUtils.isEnabled() && (path.startsWith("/____v2/") || path.equals("/____v2"))) {
+ return new V2HttpCall(cores, request, response, retry);
} else {
- return new HttpSolrCall(filter, cores, request, response, retry);
+ return new HttpSolrCall(cores, request, response, retry);
}
}
}
diff --git a/solr/core/src/test/org/apache/solr/cloud/DeleteReplicaTest.java b/solr/core/src/test/org/apache/solr/cloud/DeleteReplicaTest.java
index a328fad5589..2932553c6d2 100644
--- a/solr/core/src/test/org/apache/solr/cloud/DeleteReplicaTest.java
+++ b/solr/core/src/test/org/apache/solr/cloud/DeleteReplicaTest.java
@@ -486,7 +486,7 @@ public class DeleteReplicaTest extends SolrCloudTestCase {
/**
* see SOLR-16848 working around a timing issue where the callback will be faster than the
- * dispatchFilter's init
+ * SolrServlet's init
*/
private void waitForJettyInit(JettySolrRunner replica1Jetty, String replica1JettyNodeName)
throws InterruptedException {
diff --git a/solr/core/src/test/org/apache/solr/cloud/TestCloudSearcherWarming.java b/solr/core/src/test/org/apache/solr/cloud/TestCloudSearcherWarming.java
index bc44ef1ba00..3e2089af36c 100644
--- a/solr/core/src/test/org/apache/solr/cloud/TestCloudSearcherWarming.java
+++ b/solr/core/src/test/org/apache/solr/cloud/TestCloudSearcherWarming.java
@@ -35,7 +35,6 @@ import org.apache.solr.core.SolrCore;
import org.apache.solr.core.SolrEventListener;
import org.apache.solr.embedded.JettySolrRunner;
import org.apache.solr.search.SolrIndexSearcher;
-import org.apache.solr.servlet.SolrDispatchFilter;
import org.apache.solr.util.LogLevel;
import org.apache.solr.util.RefCounted;
import org.apache.solr.util.TestInjection;
@@ -294,8 +293,7 @@ public class TestCloudSearcherWarming extends SolrCloudTestCase {
log.info("Checking node: {}", jettySolrRunner.getNodeName());
}
if (jettySolrRunner.getNodeName().equals(replica.getNodeName())) {
- SolrDispatchFilter solrDispatchFilter = jettySolrRunner.getSolrDispatchFilter();
- try (SolrCore core = solrDispatchFilter.getCores().getCore(coreName)) {
+ try (SolrCore core = jettySolrRunner.getCoreContainer().getCore(coreName)) {
assertFalse(
"useColdSearcher is enabled! It should not be enabled for this test!",
core.getSolrConfig().useColdSearcher);
diff --git a/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java b/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java
index 5dc13d0ca3a..6bc03e5ef31 100644
--- a/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java
+++ b/solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java
@@ -100,7 +100,6 @@ import org.apache.solr.security.AuthorizationContext;
import org.apache.solr.security.AuthorizationPlugin;
import org.apache.solr.security.AuthorizationResponse;
import org.apache.solr.security.BasicAuthPlugin;
-import org.apache.solr.servlet.SolrDispatchFilter;
import org.apache.solr.util.ExternalPaths;
import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.KeeperException;
@@ -1650,12 +1649,12 @@ public class TestConfigSetsAPI extends SolrCloudTestCase {
* the real directory which matches what {@link ZkController} finds and uses to bootstrap ZK in
* cloud based tests.
*
- * <p>This assumes the {@link SolrDispatchFilter#SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE} system
- * property has not been externally set in the environment where this test is being run -- which
- * should <b>never</b> be the case, since it would prevent the test-framework from using {@link
+ * <p>This assumes the {@link ConfigSetService#SOLR_CONFIGSET_DEFAULT_CONFDIR} system property has
+ * not been externally set in the environment where this test is being run -- which should
+ * <b>never</b> be the case, since it would prevent the test-framework from using {@link
* ExternalPaths#DEFAULT_CONFIGSET}
*
- * @see SolrDispatchFilter#SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE
+ * @see ConfigSetService#SOLR_CONFIGSET_DEFAULT_CONFDIR
* @see #beforeSolrTestCase
* @see ConfigSetService#getDefaultConfigDirPath
*/
diff --git a/solr/core/src/test/org/apache/solr/core/TestCoreContainer.java b/solr/core/src/test/org/apache/solr/core/TestCoreContainer.java
index 2ded0c3ff4e..221da96aee2 100644
--- a/solr/core/src/test/org/apache/solr/core/TestCoreContainer.java
+++ b/solr/core/src/test/org/apache/solr/core/TestCoreContainer.java
@@ -16,7 +16,7 @@
*/
package org.apache.solr.core;
-import static org.apache.solr.servlet.SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE;
+import static org.apache.solr.servlet.CoreContainerProvider.SOLR_INSTALL_DIR;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.CoreMatchers.nullValue;
@@ -43,7 +43,7 @@ import org.apache.solr.handler.admin.CollectionsHandler;
import org.apache.solr.handler.admin.ConfigSetsHandler;
import org.apache.solr.handler.admin.CoreAdminHandler;
import org.apache.solr.handler.admin.InfoHandler;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.util.ModuleUtils;
import org.junit.Assume;
import org.junit.BeforeClass;
@@ -429,8 +429,7 @@ public class TestCoreContainer extends SolrTestCaseJ4 {
jar1.closeEntry();
}
- System.setProperty(
- SolrDispatchFilter.SOLR_INSTALL_DIR_ATTRIBUTE, tmpRoot.toAbsolutePath().toString());
+ System.setProperty(CoreContainerProvider.SOLR_INSTALL_DIR, tmpRoot.toAbsolutePath().toString());
final CoreContainer cc1 = init(tmpRoot, "<solr></solr>");
try {
assertThrows(
@@ -466,7 +465,7 @@ public class TestCoreContainer extends SolrTestCaseJ4 {
jar1.closeEntry();
}
- System.setProperty(SOLR_INSTALL_DIR_ATTRIBUTE, installDirPath.toString());
+ System.setProperty(SOLR_INSTALL_DIR, installDirPath.toString());
final CoreContainer cores = init(CONFIGSETS_SOLR_XML);
try {
diff --git a/solr/core/src/test/org/apache/solr/servlet/HttpSolrCallCloudTest.java b/solr/core/src/test/org/apache/solr/servlet/HttpSolrCallCloudTest.java
index c3db96528dd..3ee4555797a 100644
--- a/solr/core/src/test/org/apache/solr/servlet/HttpSolrCallCloudTest.java
+++ b/solr/core/src/test/org/apache/solr/servlet/HttpSolrCallCloudTest.java
@@ -33,6 +33,7 @@ import org.apache.solr.cloud.AbstractFullDistribZkTestBase;
import org.apache.solr.cloud.SolrCloudTestCase;
import org.apache.solr.common.util.SuppressForbidden;
import org.apache.solr.embedded.JettySolrRunner;
+import org.apache.solr.util.LogListener;
import org.junit.BeforeClass;
import org.junit.Test;
import org.mockito.Mockito;
@@ -75,16 +76,37 @@ public class HttpSolrCallCloudTest extends SolrCloudTestCase {
assertEquals(400, connection.getResponseCode());
}
+ @Test
+ public void test404() throws Exception {
+ // once upon a time, Jetty (not Solr) handled 404. Now Solr does.
+ try (LogListener log = LogListener.info(HttpSolrCall.class)) {
+ var baseUrl = cluster.getJettySolrRunner(0).getBaseUrl();
+ final var collection = "nonExistentColl";
+ final var handler = random().nextBoolean() ? "/select" : "/update"; // doesn't matter
+ final var queryKeyVal = "q=myQuery";
+ var request =
+ new URI(baseUrl.toString() + "/" + collection + handler + "?" + queryKeyVal).toURL();
+ var connection = (HttpURLConnection) request.openConnection();
+ assertEquals(404, connection.getResponseCode());
+ assertEquals(1, log.getCount());
+ final var msg = log.pollMessage();
+ // super basic test that merely shows Solr logs contain some basic info
+ // assertTrue(msg, msg.contains("status"));
+ // assertTrue(msg, msg.contains("404"));
+ assertTrue(msg, msg.contains(collection));
+ assertTrue(msg, msg.contains(handler));
+ // assertTrue(msg, msg.contains(queryKeyVal));
+ }
+ }
+
private void assertCoreChosen(int numCores, HttpServletRequest testRequest)
throws UnavailableException {
JettySolrRunner jettySolrRunner = cluster.getJettySolrRunner(0);
Set<String> coreNames = new HashSet<>();
- SolrDispatchFilter dispatchFilter = jettySolrRunner.getSolrDispatchFilter();
for (int i = 0; i < NUM_SHARD * REPLICA_FACTOR * 20; i++) {
if (coreNames.size() == numCores) return;
HttpSolrCall httpSolrCall =
- new HttpSolrCall(
- dispatchFilter, dispatchFilter.getCores(), testRequest, newResponse(), false);
+ new HttpSolrCall(jettySolrRunner.getCoreContainer(), testRequest, newResponse(), false);
try {
httpSolrCall.init();
} catch (Exception e) {
diff --git a/solr/core/src/test/org/apache/solr/servlet/LoadAdminUiServletTest.java b/solr/core/src/test/org/apache/solr/servlet/LoadAdminUiServletTest.java
index f22292e6474..dccd954e1be 100644
--- a/solr/core/src/test/org/apache/solr/servlet/LoadAdminUiServletTest.java
+++ b/solr/core/src/test/org/apache/solr/servlet/LoadAdminUiServletTest.java
@@ -52,6 +52,7 @@ public class LoadAdminUiServletTest extends SolrTestCaseJ4 {
@Mock private ServletConfig servletConfig;
@Mock private ServletContext mockServletContext;
@Mock private ServletOutputStream mockOutputStream;
+ @Mock private CoreContainerProvider coreContainerProvider;
private static final Set<String> CSP_URLS =
Set.of(
@@ -72,6 +73,9 @@ public class LoadAdminUiServletTest extends SolrTestCaseJ4 {
InputStream mockInputStream =
new ByteArrayInputStream("mock content".getBytes(StandardCharsets.UTF_8));
when(mockServletContext.getResourceAsStream(anyString())).thenReturn(mockInputStream);
+ when(mockServletContext.getAttribute(CoreContainerProvider.class.getName()))
+ .thenReturn(coreContainerProvider);
+ when(coreContainerProvider.getCoreContainer()).thenReturn(coreContainer);
}
@BeforeClass
diff --git a/solr/server/solr/configsets/_default/conf/solrconfig.xml b/solr/server/solr/configsets/_default/conf/solrconfig.xml
index 25ca1e5c3c6..236304a74cb 100644
--- a/solr/server/solr/configsets/_default/conf/solrconfig.xml
+++ b/solr/server/solr/configsets/_default/conf/solrconfig.xml
@@ -505,12 +505,6 @@
</query>
- <!-- Request Dispatcher
-
- This section contains instructions for how the SolrDispatchFilter
- should behave when processing requests for this SolrCore.
-
- -->
<requestDispatcher>
<!-- Request Parsing
@@ -895,7 +889,7 @@
<str name="fieldType">pdoubles</str>
</lst>
</updateProcessor>
-
+
<!-- The update.autoCreateFields property can be turned to false to disable schemaless mode -->
<updateRequestProcessorChain name="add-unknown-fields-to-the-schema" default="${update.autoCreateFields:true}"
diff --git a/solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml b/solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml
index 739a1a7e462..a6214acf2ee 100644
--- a/solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml
+++ b/solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml
@@ -516,12 +516,6 @@
</query>
- <!-- Request Dispatcher
-
- This section contains instructions for how the SolrDispatchFilter
- should behave when processing requests for this SolrCore.
-
- -->
<requestDispatcher>
<!-- Request Parsing
diff --git a/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java b/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
index a29e3d0da43..d7a0475fc7b 100644
--- a/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
+++ b/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
@@ -36,7 +36,7 @@ import org.apache.lucene.tests.util.QuickPatchThreadsFilter;
import org.apache.lucene.tests.util.VerifyTestClassNamingConvention;
import org.apache.solr.common.util.EnvUtils;
import org.apache.solr.common.util.ObjectReleaseTracker;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.core.ConfigSetService;
import org.apache.solr.util.ExternalPaths;
import org.apache.solr.util.LogLevelTestRule;
import org.apache.solr.util.RevertDefaultThreadHandlerRule;
@@ -116,16 +116,16 @@ public class SolrTestCase extends LuceneTestCase {
*
* <p>Logs INFO/WARNing messages as appropriate based on these 2 conditions.
*
- * @see SolrDispatchFilter#SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE
+ * @see ConfigSetService#SOLR_CONFIGSET_DEFAULT_CONFDIR
*/
@BeforeClass
public static void beforeSolrTestCase() {
final String existingValue =
- EnvUtils.getProperty(SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE);
+ EnvUtils.getProperty(ConfigSetService.SOLR_CONFIGSET_DEFAULT_CONFDIR);
if (null != existingValue) {
log.info(
"Test env includes configset dir system property '{}'='{}'",
- SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE,
+ ConfigSetService.SOLR_CONFIGSET_DEFAULT_CONFDIR,
existingValue);
return;
}
@@ -133,18 +133,18 @@ public class SolrTestCase extends LuceneTestCase {
if (Files.isReadable(extPath /* implies exists() */) && Files.isDirectory(extPath)) {
log.info(
"Setting '{}' system property to test-framework derived value of '{}'",
- SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE,
+ ConfigSetService.SOLR_CONFIGSET_DEFAULT_CONFDIR,
ExternalPaths.DEFAULT_CONFIGSET);
assert null == existingValue;
System.setProperty(
- SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE,
+ ConfigSetService.SOLR_CONFIGSET_DEFAULT_CONFDIR,
ExternalPaths.DEFAULT_CONFIGSET.toString());
} else {
log.warn(
"System property '{}' is not already set, but test-framework derived value ('{}') either "
+ "does not exist or is not a readable directory, you may need to set the property yourself "
+ "for tests to run properly",
- SolrDispatchFilter.SOLR_CONFIGSET_DEFAULT_CONFDIR_ATTRIBUTE,
+ ConfigSetService.SOLR_CONFIGSET_DEFAULT_CONFDIR,
ExternalPaths.DEFAULT_CONFIGSET);
}
diff --git a/solr/test-framework/src/java/org/apache/solr/client/solrj/apache/HttpSolrClient.java b/solr/test-framework/src/java/org/apache/solr/client/solrj/apache/HttpSolrClient.java
index 3e184f5ef3f..e2a849cd4cf 100644
--- a/solr/test-framework/src/java/org/apache/solr/client/solrj/apache/HttpSolrClient.java
+++ b/solr/test-framework/src/java/org/apache/solr/client/solrj/apache/HttpSolrClient.java
@@ -703,7 +703,7 @@ public class HttpSolrClient extends SolrClient {
}
// When raising an error using HTTP sendError, mime types can be mismatched. This is specifically
- // true when SolrDispatchFilter uses the sendError mechanism since the expected MIME type of
+ // true when SolrServlet uses the sendError mechanism since the expected MIME type of
// response is not HTML but HTTP sendError generates an HTML output, which can lead to mismatch
private boolean isUnmatchedErrorCode(String mimeType, int httpStatus) {
if (mimeType == null) {
diff --git a/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java b/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java
index 05405b37d3c..43261fa7fd9 100644
--- a/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java
+++ b/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java
@@ -66,7 +66,7 @@ import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.servlet.PathExclusionFilter;
import org.apache.solr.servlet.RateLimitFilter;
import org.apache.solr.servlet.RequiredSolrRequestFilter;
-import org.apache.solr.servlet.SolrDispatchFilter;
+import org.apache.solr.servlet.SolrServlet;
import org.apache.solr.servlet.TracingFilter;
import org.apache.solr.util.SocketProxy;
import org.apache.solr.util.TimeOut;
@@ -120,7 +120,7 @@ public class JettySolrRunner {
volatile FilterHolder requiredFilter;
volatile FilterHolder rateLimitFilter;
volatile FilterHolder authFilter;
- volatile FilterHolder dispatchFilter;
+ volatile ServletHolder solrServlet;
private FilterHolder tracingFilter;
private int jettyPort = -1;
@@ -387,9 +387,8 @@ public class JettySolrRunner {
nodeProperties.setProperty("hostPort", Integer.toString(port));
root.getServletContext()
- .setAttribute(SolrDispatchFilter.PROPERTIES_ATTRIBUTE, nodeProperties);
- root.getServletContext()
- .setAttribute(SolrDispatchFilter.SOLRHOME_ATTRIBUTE, solrHome);
+ .setAttribute(CoreContainerProvider.SOLR_PROPERTIES, nodeProperties);
+ root.getServletContext().setAttribute(CoreContainerProvider.SOLR_SOLR_HOME, solrHome);
SSLConfigurationsFactory.current().init(); // normally happens in jetty-ssl.xml
@@ -434,17 +433,17 @@ public class JettySolrRunner {
authFilter = root.getServletHandler().newFilterHolder(Source.EMBEDDED);
authFilter.setHeldClass(AuthenticationFilter.class);
- // This is our main workhorse
- dispatchFilter = root.getServletHandler().newFilterHolder(Source.EMBEDDED);
- dispatchFilter.setHeldClass(SolrDispatchFilter.class);
-
- // Map dispatchFilter in same path as in web.xml
+ // Map filters in same path as in web.xml
root.addFilter(pathExcludeFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
root.addFilter(requiredFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
root.addFilter(rateLimitFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
root.addFilter(tracingFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
root.addFilter(authFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
- root.addFilter(dispatchFilter, "/*", EnumSet.of(DispatcherType.REQUEST));
+
+ // This is our main workhorse - now a servlet instead of filter
+ solrServlet = root.getServletHandler().newServletHolder(Source.EMBEDDED);
+ solrServlet.setHeldClass(SolrServlet.class);
+ root.addServlet(solrServlet, "/*");
// Default servlet as a fall-through
ServletHolder defaultHolder = root.getServletHandler().newServletHolder(Source.EMBEDDED);
@@ -494,14 +493,7 @@ public class JettySolrRunner {
}
/**
- * @return the {@link SolrDispatchFilter} for this node
- */
- public SolrDispatchFilter getSolrDispatchFilter() {
- return (SolrDispatchFilter) dispatchFilter.getFilter();
- }
-
- /**
- * @return the {@link SolrDispatchFilter} for this node
+ * @return the {@link RateLimitFilter} for this node
*/
public RateLimitFilter getSolrRateLimitFilter() {
return (RateLimitFilter) rateLimitFilter.getFilter();
@@ -511,12 +503,17 @@ public class JettySolrRunner {
* @return the {@link CoreContainer} for this node
*/
public CoreContainer getCoreContainer() {
- final var solrDispatchFilter = getSolrDispatchFilter();
- if (solrDispatchFilter == null) {
+ SolrServlet servlet;
+ try {
+ servlet = (SolrServlet) solrServlet.getServlet();
+ } catch (ServletException e1) {
+ throw new RuntimeException(e1);
+ }
+ if (servlet == null) {
return null;
}
try {
- return solrDispatchFilter.getCores();
+ return servlet.getCores();
} catch (UnavailableException e) {
return null;
}
@@ -530,13 +527,13 @@ public class JettySolrRunner {
}
public boolean isRunning() {
- return server.isRunning() && dispatchFilter != null && dispatchFilter.isRunning();
+ return server.isRunning() && solrServlet != null && solrServlet.isRunning();
}
public boolean isStopped() {
- return (server.isStopped() && dispatchFilter == null)
+ return (server.isStopped() && solrServlet == null)
|| (server.isStopped()
- && dispatchFilter.isStopped()
+ && solrServlet.isStopped()
&& ((QueuedThreadPool) server.getThreadPool()).isStopped());
}
@@ -584,7 +581,7 @@ public class JettySolrRunner {
server.start();
}
}
- assert dispatchFilter.isRunning();
+ assert solrServlet.isRunning();
if (config.waitForLoadingCoresToFinishMs != null
&& config.waitForLoadingCoresToFinishMs > 0L) {
@@ -900,18 +897,11 @@ public class JettySolrRunner {
}
private void waitForLoadingCoresToFinish(long timeoutMs) {
- if (dispatchFilter != null) {
- SolrDispatchFilter solrFilter = (SolrDispatchFilter) dispatchFilter.getFilter();
- CoreContainer cores;
- try {
- cores = solrFilter.getCores();
- } catch (UnavailableException e) {
- throw new IllegalStateException("The CoreContainer is unavailable!");
- }
- cores.waitForLoadingCoresToFinish(timeoutMs);
- } else {
- throw new IllegalStateException("The dispatchFilter is not set!");
+ CoreContainer cores = getCoreContainer();
+ if (cores == null) {
+ throw new IllegalStateException("solrServlet/coreContainer is not set/available!");
}
+ cores.waitForLoadingCoresToFinish(timeoutMs);
}
static class Delay {
diff --git a/solr/test-framework/src/java/org/apache/solr/util/TestHarness.java b/solr/test-framework/src/java/org/apache/solr/util/TestHarness.java
index 8a6abff7a10..d4ff7bc3195 100644
--- a/solr/test-framework/src/java/org/apache/solr/util/TestHarness.java
+++ b/solr/test-framework/src/java/org/apache/solr/util/TestHarness.java
@@ -48,6 +48,7 @@ import org.apache.solr.request.SolrRequestInfo;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.schema.IndexSchemaFactory;
+import org.apache.solr.servlet.CoreContainerProvider;
import org.apache.solr.update.UpdateShardHandlerConfig;
/**
@@ -113,16 +114,16 @@ public class TestHarness extends BaseTestHarness {
}
/**
- * Helper method to let us do some home sys prop check in delegated constructor. in "real" code
- * SolrDispatchFilter takes care of checking this sys prop when building NodeConfig/CoreContainer
+ * Helper method to let us do a solr-home sys prop check in a delegated constructor. in "real"
+ * code {@link CoreContainerProvider} takes care of checking this sys prop when building
+ * NodeConfig/CoreContainer
*/
private static Path checkAndReturnSolrHomeSysProp() {
- final String SOLR_HOME = "solr.solr.home";
- final String home = System.getProperty(SOLR_HOME);
+ final String home = System.getProperty(CoreContainerProvider.SOLR_SOLR_HOME);
if (null == home) {
throw new IllegalStateException(
"This TestHarness constructor requires "
- + SOLR_HOME
+ + CoreContainerProvider.SOLR_SOLR_HOME
+ " sys prop to be set by test first");
}
return Path.of(home).toAbsolutePath().normalize();
diff --git a/solr/webapp/web/WEB-INF/web.xml b/solr/webapp/web/WEB-INF/web.xml
index 287321efb16..201a88156c3 100644
--- a/solr/webapp/web/WEB-INF/web.xml
+++ b/solr/webapp/web/WEB-INF/web.xml
@@ -83,15 +83,16 @@
<filter-name>AuthenticationFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
- <filter>
- <filter-name>SolrRequestFilter</filter-name>
- <filter-class>org.apache.solr.servlet.SolrDispatchFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>SolrRequestFilter</filter-name>
+ <servlet>
+ <servlet-name>SolrServlet</servlet-name>
+ <servlet-class>org.apache.solr.servlet.SolrServlet</servlet-class>
+ </servlet>
+
+ <servlet-mapping>
+ <servlet-name>SolrServlet</servlet-name>
<url-pattern>/*</url-pattern>
- </filter-mapping>
+ </servlet-mapping>
<servlet>
<servlet-name>LoadAdminUI</servlet-name>