org.apache.phoenix.hbase.index.exception.SingleIndexWriteFailureException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phoenix-mapreduce-byo-shaded-hbase-hbase-2.6
Phoenix Mapreduce JAR for use with the "hbase mapredcp" classpath
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.phoenix.hbase.index.exception;

import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.hadoop.hbase.client.Mutation;
import org.apache.phoenix.thirdparty.com.google.common.base.MoreObjects;
import org.apache.phoenix.thirdparty.com.google.common.base.Objects;

/**
 * Exception thrown if we cannot successfully write to an index table.
 */
@SuppressWarnings("serial")
public class SingleIndexWriteFailureException extends IndexWriteException {

  public static final String FAILED_MSG = "Failed to make index update:";
  private String table;
  private String mutationsMsg;

  /**
   * Cannot reach the index, but not sure of the table or the mutations that caused the failure
   * @param msg more description of what happened
   * @param cause original cause
   */
  public SingleIndexWriteFailureException(String msg, Throwable cause) {
    super(msg, cause);
  }

  /**
   * Failed to write the passed mutations to an index table for some reason.
   * @param targetTableName index table to which we attempted to write
   * @param mutations mutations that were attempted
   * @param cause underlying reason for the failure
   */
  public SingleIndexWriteFailureException(String targetTableName, List mutations,
      Exception cause, boolean disableIndexOnFailure) {
    super(cause, disableIndexOnFailure);
    this.table = targetTableName;
    this.mutationsMsg = mutations.toString();
  }

  /**
   * This constructor used to rematerialize this exception when receiving
   * an rpc exception from the server
   * @param msg detail message
   */
  public SingleIndexWriteFailureException(String msg) {
      super(IndexWriteException.parseDisableIndexOnFailure(msg));
      Pattern pattern = Pattern.compile(FAILED_MSG + ".* table: ([\\S]*)\\s.*", Pattern.DOTALL);
      Matcher m = pattern.matcher(msg);
      if (m.find()) {
          this.table = m.group(1);
      }
  }

  /**
   * @return The table to which we failed to write the index updates. If unknown, returns
   *         null
   */
  public String getTableName() {
    return this.table;
  }

  @Override
    public String getMessage() {
      return MoreObjects.firstNonNull(super.getMessage(), "") + " " + FAILED_MSG + "\n\t table: " + this.table + "\n\t edits: " + mutationsMsg
      + "\n\tcause: " + getCause() == null ? "UNKNOWN" : getCause().getMessage();
    }
}