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
24 /**
25 * Thrown when a snapshot could not be created due to a server-side error when
26 * taking the snapshot.
27 */
28 @SuppressWarnings("serial")
29 @InterfaceAudience.Public
30 @InterfaceStability.Evolving
31 public class SnapshotCreationException extends HBaseSnapshotException {
32
33 /**
34 * Used internally by the RPC engine to pass the exception back to the client.
35 * @param msg error message to pass back
36 */
37 public SnapshotCreationException(String msg) {
38 super(msg);
39 }
40
41 /**
42 * Failure to create the specified snapshot
43 * @param msg reason why the snapshot couldn't be completed
44 * @param desc description of the snapshot attempted
45 */
46 public SnapshotCreationException(String msg, SnapshotDescription desc) {
47 super(msg, desc);
48 }
49
50 /**
51 * Failure to create the specified snapshot due to an external cause
52 * @param msg reason why the snapshot couldn't be completed
53 * @param cause root cause of the failure
54 * @param desc description of the snapshot attempted
55 */
56 public SnapshotCreationException(String msg, Throwable cause, SnapshotDescription desc) {
57 super(msg, cause, desc);
58 }
59 }