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.snapshot;
19
20 import org.apache.hadoop.hbase.classification.InterfaceAudience;
21 import org.apache.hadoop.hbase.classification.InterfaceStability;
22 import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription;
23 import org.apache.hadoop.hbase.DoNotRetryIOException;
24
25 /**
26 * General exception base class for when a snapshot fails
27 */
28 @SuppressWarnings("serial")
29 @InterfaceAudience.Public
30 @InterfaceStability.Evolving
31 public class HBaseSnapshotException extends DoNotRetryIOException {
32
33 private SnapshotDescription description;
34
35 /**
36 * Some exception happened for a snapshot and don't even know the snapshot that it was about
37 * @param msg Full description of the failure
38 */
39 public HBaseSnapshotException(String msg) {
40 super(msg);
41 }
42
43 /**
44 * Exception for the given snapshot that has no previous root cause
45 * @param msg reason why the snapshot failed
46 * @param desc description of the snapshot that is being failed
47 */
48 public HBaseSnapshotException(String msg, SnapshotDescription desc) {
49 super(msg);
50 this.description = desc;
51 }
52
53 /**
54 * Exception for the given snapshot due to another exception
55 * @param msg reason why the snapshot failed
56 * @param cause root cause of the failure
57 * @param desc description of the snapshot that is being failed
58 */
59 public HBaseSnapshotException(String msg, Throwable cause, SnapshotDescription desc) {
60 super(msg, cause);
61 this.description = desc;
62 }
63
64 /**
65 * Exception when the description of the snapshot cannot be determined, due to some root other
66 * root cause
67 * @param message description of what caused the failure
68 * @param e root cause
69 */
70 public HBaseSnapshotException(String message, Exception e) {
71 super(message, e);
72 }
73
74 public SnapshotDescription getSnapshotDescription() {
75 return this.description;
76 }
77 }