All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.apache.solr.client.solrj.response.SolrResponseBase Maven / Gradle / Ivy

    The newest version!
    /*
 * 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.client.solrj.response;

import java.io.IOException;
import java.util.Map;
import org.apache.solr.client.solrj.SolrResponse;
import org.apache.solr.common.MapWriter;
import org.apache.solr.common.util.NamedList;

/**
 * @since solr 1.3
 */
public class SolrResponseBase extends SolrResponse implements MapWriter {
  private long elapsedTime = -1;
  private NamedList response = null;
  private String requestUrl = null;

  @Override
  public void writeMap(EntryWriter ew) throws IOException {
    if (response != null) response.writeMap(ew);
  }

  @Override
  public long getElapsedTime() {
    return elapsedTime;
  }

  @Override
  public void setElapsedTime(long elapsedTime) {
    this.elapsedTime = elapsedTime;
  }

  @Override
  public NamedList getResponse() {
    return response;
  }

  @Override
  public void setResponse(NamedList response) {
    this.response = response;
  }

  @Override
  public String toString() {
    return response.toString();
  }

  /**
   * Return a {@link NamedList} object representing the 'responseHeader' section of Solr's response
   *
   * 
    This method may return null, if no responseHeader can be found. If a value is returned, it
   * should not be modified. Any modifications made are not guaranteed to be durable.
   */
  @SuppressWarnings("unchecked")
  public NamedList getResponseHeader() {
    // ResponseParser implementations vary in what types they use when deserializing responses, so
    // we need to be a bit flexible in inspecting types within the NamedList.  See SOLR-17316 for
    // details.
    final var responseHeader = response.get("responseHeader");
    if (responseHeader == null) {
      return null;
    }

    if (responseHeader instanceof NamedList) {
      return (NamedList) responseHeader;
    } else if (responseHeader instanceof Map) {
      final var responseHeaderAsMap = (Map) responseHeader;
      return new NamedList<>(responseHeaderAsMap);
    }
    throw new IllegalStateException(
        "'responseHeader' key was an unexpected type ["
            + responseHeader.getClass().getSimpleName()
            + "]");
  }

  // these two methods are based on the logic in SolrCore.setResponseHeaderValues(...)
  public int getStatus() {
    NamedList header = getResponseHeader();
    if (header != null) {
      return (Integer) header.get("status");
    } else {
      return 0;
    }
  }

  public int getQTime() {
    NamedList header = getResponseHeader();
    if (header != null) {
      return (Integer) header.get("QTime");
    } else {
      return 0;
    }
  }

  public String getRequestUrl() {
    return requestUrl;
  }

  public void setRequestUrl(String requestUrl) {
    this.requestUrl = requestUrl;
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy