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.snapshot;
19  
20  import org.apache.hadoop.hbase.classification.InterfaceAudience;
21  import org.apache.hadoop.hbase.classification.InterfaceStability;
22  
23  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription;
24  
25  /**
26   * Thrown when a snapshot could not be created due to a server-side error when
27   * taking the snapshot.
28   */
29  @SuppressWarnings("serial")
30  @InterfaceAudience.Public
31  @InterfaceStability.Evolving
32  public class SnapshotCreationException extends HBaseSnapshotException {
33    /**
34     * Used internally by the RPC engine to pass the exception back to the client.
35     *
36     * @param message error message to pass back
37     */
38    public SnapshotCreationException(String message) {
39      super(message);
40    }
41  
42    /**
43     * Failure to create the specified snapshot.
44     *
45     * @param message reason why the snapshot couldn't be completed
46     * @param snapshotDescription description of the snapshot attempted
47     */
48    public SnapshotCreationException(String message, SnapshotDescription snapshotDescription) {
49      super(message, snapshotDescription);
50    }
51  
52    /**
53     * Failure to create the specified snapshot due to an external cause.
54     *
55     * @param message reason why the snapshot couldn't be completed
56     * @param cause the root cause of the failure
57     * @param snapshotDescription description of the snapshot attempted
58     * @deprecated since 1.3.0, will be removed in 3.0.0
59     */
60    @Deprecated
61    public SnapshotCreationException(String message, Throwable cause,
62        SnapshotDescription snapshotDescription) {
63      super(message, cause, snapshotDescription);
64    }
65  }