org.apache.solr.handler.admin.api.GetNodeCommandStatus 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.handler.admin.api;

import static org.apache.solr.handler.admin.CoreAdminHandler.CoreAdminAsyncTracker.COMPLETED;
import static org.apache.solr.handler.admin.CoreAdminHandler.CoreAdminAsyncTracker.FAILED;
import static org.apache.solr.handler.admin.CoreAdminHandler.CoreAdminAsyncTracker.RUNNING;

import jakarta.inject.Inject;
import org.apache.solr.client.api.endpoint.GetNodeCommandStatusApi;
import org.apache.solr.client.api.model.GetNodeCommandStatusResponse;
import org.apache.solr.common.params.CoreAdminParams;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.handler.admin.CoreAdminHandler;
import org.apache.solr.jersey.PermissionName;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.security.PermissionNameProvider;

/**
 * Implementation of V2 API interface {@link GetNodeCommandStatusApi} for checking the status of a
 * core-level asynchronous command.
 */
public class GetNodeCommandStatus extends CoreAdminAPIBase implements GetNodeCommandStatusApi {

  @Inject
  public GetNodeCommandStatus(
      CoreContainer coreContainer,
      CoreAdminHandler.CoreAdminAsyncTracker coreAdminAsyncTracker,
      SolrQueryRequest req,
      SolrQueryResponse rsp) {
    super(coreContainer, coreAdminAsyncTracker, req, rsp);
  }

  @Override
  @PermissionName(PermissionNameProvider.Name.CORE_READ_PERM)
  public GetNodeCommandStatusResponse getCommandStatus(String requestId) {
    ensureRequiredParameterProvided(CoreAdminParams.REQUESTID, requestId);
    var requestStatusResponse = new GetNodeCommandStatusResponse();
    if (coreAdminAsyncTracker.getRequestStatusMap(RUNNING).containsKey(requestId)) {
      requestStatusResponse.status = RUNNING;
    } else if (coreAdminAsyncTracker.getRequestStatusMap(COMPLETED).containsKey(requestId)) {
      requestStatusResponse.status = COMPLETED;
      requestStatusResponse.response =
          coreAdminAsyncTracker.getRequestStatusMap(COMPLETED).get(requestId).getRspObject();
      requestStatusResponse.response =
          coreAdminAsyncTracker
              .getRequestStatusMap(COMPLETED)
              .get(requestId)
              .getOperationRspObject();
    } else if (coreAdminAsyncTracker.getRequestStatusMap(FAILED).containsKey(requestId)) {
      requestStatusResponse.status = FAILED;
      requestStatusResponse.response =
          coreAdminAsyncTracker.getRequestStatusMap(FAILED).get(requestId).getRspObject();
    } else {
      requestStatusResponse.status = "notfound";
      requestStatusResponse.msg = "No task found in running, completed or failed tasks";
    }
    return requestStatusResponse;
  }
}