org.apache.solr.handler.component.QueryCancellationHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Show all versions of solr-core Show documentation
Apache Solr (module: core)
/*
* 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.component;
import static org.apache.solr.common.params.CommonParams.QUERY_UUID;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.solr.api.AnnotatedApi;
import org.apache.solr.api.Api;
import org.apache.solr.handler.admin.api.CancelTaskAPI;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.request.SolrRequestHandler;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.security.AuthorizationContext;
import org.apache.solr.security.PermissionNameProvider;
/** Handles requests for query cancellation for cancellable queries */
public class QueryCancellationHandler extends TaskManagementHandler {
// This can be a parent level member but we keep it here to allow future handlers to have
// a custom list of components
private List components;
@Override
public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception {
ResponseBuilder rb = buildResponseBuilder(req, rsp, getComponentsList());
Map extraParams = null;
rb.setCancellation(true);
String cancellationUUID = req.getParams().get(QUERY_UUID, null);
if (cancellationUUID == null) {
throw new IllegalArgumentException(
"Query cancellation was requested but no query UUID for cancellation was given");
}
if (rb.isDistrib) {
extraParams = new HashMap<>();
extraParams.put(QUERY_UUID, cancellationUUID);
}
// Let this be visible to handleResponses in the handling component
rb.setCancellationUUID(cancellationUUID);
processRequest(req, rb, extraParams);
}
@Override
public String getDescription() {
return "Cancel queries";
}
@Override
public Category getCategory() {
return Category.ADMIN;
}
@Override
public PermissionNameProvider.Name getPermissionName(AuthorizationContext ctx) {
return PermissionNameProvider.Name.READ_PERM;
}
@Override
public SolrRequestHandler getSubHandler(String path) {
if (path.startsWith("/tasks/cancel")) {
return this;
}
return null;
}
@Override
public Boolean registerV2() {
return Boolean.TRUE;
}
@Override
public Collection getApis() {
return AnnotatedApi.getApis(new CancelTaskAPI(this));
}
private List getComponentsList() {
if (components == null) {
components = buildComponentsList();
}
return components;
}
}