org.apache.solr.handler.configsets.ConfigSetAPIBase Maven / Gradle / Ivy
Show all versions of solr-core Show documentation
/*
* 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.handler.configsets;
import static org.apache.solr.cloud.Overseer.QUEUE_OPERATION;
import static org.apache.solr.cloud.OverseerConfigSetMessageHandler.CONFIGSETS_ACTION_PREFIX;
import static org.apache.solr.handler.admin.ConfigSetsHandler.CONFIG_SET_TIMEOUT;
import java.io.IOException;
import java.io.InputStream;
import java.lang.invoke.MethodHandles;
import java.security.Principal;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import org.apache.solr.client.solrj.SolrResponse;
import org.apache.solr.cloud.OverseerSolrResponseSerializer;
import org.apache.solr.cloud.OverseerTaskQueue;
import org.apache.solr.cloud.api.collections.DistributedCollectionConfigSetCommandRunner;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.cloud.ZkNodeProps;
import org.apache.solr.common.params.ConfigSetParams;
import org.apache.solr.common.util.ContentStream;
import org.apache.solr.common.util.SimpleOrderedMap;
import org.apache.solr.common.util.Utils;
import org.apache.solr.core.ConfigSetService;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.security.AuthenticationPlugin;
import org.apache.zookeeper.KeeperException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Parent class for all APIs that manipulate configsets
*
* Contains utilities for tasks common in configset manipulation, including running configset
* "commands" and checking configset "trusted-ness".
*/
public class ConfigSetAPIBase {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
protected final CoreContainer coreContainer;
protected final Optional
distributedCollectionConfigSetCommandRunner;
protected final ConfigSetService configSetService;
public ConfigSetAPIBase(CoreContainer coreContainer) {
this.coreContainer = coreContainer;
this.distributedCollectionConfigSetCommandRunner =
coreContainer.getDistributedCollectionCommandRunner();
this.configSetService = coreContainer.getConfigSetService();
}
protected void runConfigSetCommand(
SolrQueryResponse rsp,
ConfigSetParams.ConfigSetAction action,
Map messageToSend)
throws Exception {
if (log.isInfoEnabled()) {
log.info("Invoked ConfigSet Action :{} with params {} ", action.toLower(), messageToSend);
}
if (distributedCollectionConfigSetCommandRunner.isPresent()) {
distributedCollectionConfigSetCommandRunner
.get()
.runConfigSetCommand(rsp, action, messageToSend, CONFIG_SET_TIMEOUT);
} else {
sendToOverseer(rsp, action, messageToSend);
}
}
protected void ensureConfigSetUploadEnabled() {
if (!"true".equals(System.getProperty("configset.upload.enabled", "true"))) {
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST,
"Configset upload feature is disabled. To enable this, start Solr with '-Dconfigset.upload.enabled=true'.");
}
}
protected InputStream ensureNonEmptyInputStream(SolrQueryRequest req) throws IOException {
Iterator contentStreamsIterator = req.getContentStreams().iterator();
if (!contentStreamsIterator.hasNext()) {
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST,
"No stream found for the config data to be uploaded");
}
return contentStreamsIterator.next().getStream();
}
public static boolean isTrusted(Principal userPrincipal, AuthenticationPlugin authPlugin) {
if (authPlugin != null && userPrincipal != null) {
log.debug("Trusted configset request");
return true;
}
log.debug("Untrusted configset request");
return false;
}
protected void createBaseNode(
ConfigSetService configSetService,
boolean overwritesExisting,
boolean requestIsTrusted,
String configName)
throws IOException {
Map metadata = Collections.singletonMap("trusted", requestIsTrusted);
if (overwritesExisting) {
if (!requestIsTrusted) {
ensureOverwritingUntrustedConfigSet(configName);
}
// If the request is trusted and cleanup=true, then the configSet will be set to trusted after
// the overwriting has been done.
} else {
configSetService.setConfigMetadata(configName, metadata);
}
}
/*
* Fail if an untrusted request tries to update a trusted ConfigSet
*/
private void ensureOverwritingUntrustedConfigSet(String configName) throws IOException {
boolean isCurrentlyTrusted = configSetService.isConfigSetTrusted(configName);
if (isCurrentlyTrusted) {
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST,
"Trying to make an untrusted ConfigSet update on a trusted configSet");
}
}
private void sendToOverseer(
SolrQueryResponse rsp, ConfigSetParams.ConfigSetAction action, Map result)
throws KeeperException, InterruptedException {
// We need to differentiate between collection and configsets actions since they currently
// use the same underlying queue.
result.put(QUEUE_OPERATION, CONFIGSETS_ACTION_PREFIX + action.toLower());
ZkNodeProps props = new ZkNodeProps(result);
handleResponse(action.toLower(), props, rsp, CONFIG_SET_TIMEOUT);
}
private void handleResponse(String operation, ZkNodeProps m, SolrQueryResponse rsp, long timeout)
throws KeeperException, InterruptedException {
long time = System.nanoTime();
OverseerTaskQueue.QueueEvent event =
coreContainer.getZkController().getOverseerConfigSetQueue().offer(Utils.toJSON(m), timeout);
if (event.getBytes() != null) {
SolrResponse response = OverseerSolrResponseSerializer.deserialize(event.getBytes());
rsp.getValues().addAll(response.getResponse());
SimpleOrderedMap exp = (SimpleOrderedMap) response.getResponse().get("exception");
if (exp != null) {
Integer code = (Integer) exp.get("rspCode");
rsp.setException(
new SolrException(
code != null && code != -1
? SolrException.ErrorCode.getErrorCode(code)
: SolrException.ErrorCode.SERVER_ERROR,
(String) exp.get("msg")));
}
} else {
if (System.nanoTime() - time
>= TimeUnit.NANOSECONDS.convert(timeout, TimeUnit.MILLISECONDS)) {
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR,
operation + " the configset time out:" + timeout / 1000 + "s");
} else if (event.getWatchedEvent() != null) {
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR,
operation
+ " the configset error [Watcher fired on path: "
+ event.getWatchedEvent().getPath()
+ " state: "
+ event.getWatchedEvent().getState()
+ " type "
+ event.getWatchedEvent().getType()
+ "]");
} else {
throw new SolrException(
SolrException.ErrorCode.SERVER_ERROR, operation + " the configset unknown case");
}
}
}
}