View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.exceptions;
19  
20  import org.apache.hadoop.classification.InterfaceAudience;
21  import org.apache.hadoop.classification.InterfaceStability;
22  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription;
23  
24  /**
25   * General exception base class for when a snapshot fails
26   */
27  @SuppressWarnings("serial")
28  @InterfaceAudience.Public
29  @InterfaceStability.Evolving
30  public class HBaseSnapshotException extends HBaseIOException {
31  
32    private SnapshotDescription description;
33  
34    /**
35     * Some exception happened for a snapshot and don't even know the snapshot that it was about
36     * @param msg Full description of the failure
37     */
38    public HBaseSnapshotException(String msg) {
39      super(msg);
40    }
41  
42    /**
43     * Exception for the given snapshot that has no previous root cause
44     * @param msg reason why the snapshot failed
45     * @param desc description of the snapshot that is being failed
46     */
47    public HBaseSnapshotException(String msg, SnapshotDescription desc) {
48      super(msg);
49      this.description = desc;
50    }
51  
52    /**
53     * Exception for the given snapshot due to another exception
54     * @param msg reason why the snapshot failed
55     * @param cause root cause of the failure
56     * @param desc description of the snapshot that is being failed
57     */
58    public HBaseSnapshotException(String msg, Throwable cause, SnapshotDescription desc) {
59      super(msg, cause);
60      this.description = desc;
61    }
62  
63    /**
64     * Exception when the description of the snapshot cannot be determined, due to some root other
65     * root cause
66     * @param message description of what caused the failure
67     * @param e root cause
68     */
69    public HBaseSnapshotException(String message, Exception e) {
70      super(message, e);
71    }
72  
73    public SnapshotDescription getSnapshotDescription() {
74      return this.description;
75    }
76  }