com.datastax.driver.core.exceptions.WriteFailureException Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * Licensed 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 com.datastax.driver.core.exceptions;

import com.datastax.driver.core.ConsistencyLevel;
import com.datastax.driver.core.EndPoint;
import com.datastax.driver.core.WriteType;
import java.net.InetAddress;
import java.util.Collections;
import java.util.Map;

/**
 * A non-timeout error during a write query.
 *
 * This happens when some of the replicas that were contacted by the coordinator replied with an
 * error.
 */
@SuppressWarnings("serial")
public class WriteFailureException extends QueryConsistencyException {
  private final WriteType writeType;
  private final int failed;
  private final Map failuresMap;

  /**
   * This constructor should only be used internally by the driver when decoding error responses.
   */
  public WriteFailureException(
      ConsistencyLevel consistency,
      WriteType writeType,
      int received,
      int required,
      int failed,
      Map failuresMap) {
    this(null, consistency, writeType, received, required, failed, failuresMap);
  }

  /** @deprecated Legacy constructor for backward compatibility. */
  @Deprecated
  public WriteFailureException(
      ConsistencyLevel consistency, WriteType writeType, int received, int required, int failed) {
    this(
        null,
        consistency,
        writeType,
        received,
        required,
        failed,
        Collections.emptyMap());
  }

  public WriteFailureException(
      EndPoint endPoint,
      ConsistencyLevel consistency,
      WriteType writeType,
      int received,
      int required,
      int failed,
      Map failuresMap) {
    super(
        endPoint,
        String.format(
            "Cassandra failure during write query at consistency %s "
                + "(%d responses were required but only %d replica responded, %d failed)",
            consistency, required, received, failed),
        consistency,
        received,
        required);
    this.writeType = writeType;
    this.failed = failed;
    this.failuresMap = failuresMap;
  }

  /** @deprecated Legacy constructor for backward compatibility. */
  @Deprecated
  public WriteFailureException(
      EndPoint endPoint,
      ConsistencyLevel consistency,
      WriteType writeType,
      int received,
      int required,
      int failed) {
    this(
        endPoint,
        consistency,
        writeType,
        received,
        required,
        failed,
        Collections.emptyMap());
  }

  private WriteFailureException(
      EndPoint endPoint,
      String msg,
      Throwable cause,
      ConsistencyLevel consistency,
      WriteType writeType,
      int received,
      int required,
      int failed,
      Map failuresMap) {
    super(endPoint, msg, cause, consistency, received, required);
    this.writeType = writeType;
    this.failed = failed;
    this.failuresMap = failuresMap;
  }

  /**
   * The type of the write for which a timeout was raised.
   *
   * @return the type of the write for which a timeout was raised.
   */
  public WriteType getWriteType() {
    return writeType;
  }

  /**
   * Returns the number of replicas that experienced a failure while executing the request.
   *
   * @return the number of failures.
   */
  public int getFailures() {
    return failed;
  }

  /**
   * Returns the a failure reason code for each node that failed.
   *
   * 
At the time of writing, the existing reason codes are:
   *
   * 

   *   {@code 0x0000}: the error does not have a specific code assigned yet, or the cause is
   *       unknown.
   *   
{@code 0x0001}: The read operation scanned too many tombstones (as defined by {@code
   *       tombstone_failure_threshold} in {@code cassandra.yaml}, causing a {@code
   *       TombstoneOverwhelmingException}.
   * 
   *
   * (please refer to the Cassandra documentation for your version for the most up-to-date list of
   * errors)
   *
   * This feature is available for protocol v5 or above only. With lower protocol versions, the
   * map will always be empty.
   *
   * @return a map of IP addresses to failure codes.
   */
  public Map getFailuresMap() {
    return failuresMap;
  }

  @Override
  public WriteFailureException copy() {
    return new WriteFailureException(
        getEndPoint(),
        getMessage(),
        this,
        getConsistencyLevel(),
        getWriteType(),
        getReceivedAcknowledgements(),
        getRequiredAcknowledgements(),
        getFailures(),
        failuresMap);
  }

  public WriteFailureException copy(EndPoint endPoint) {
    return new WriteFailureException(
        endPoint,
        getMessage(),
        this,
        getConsistencyLevel(),
        getWriteType(),
        getReceivedAcknowledgements(),
        getRequiredAcknowledgements(),
        failed,
        failuresMap);
  }
}