View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.regionserver;
20  
21  import org.apache.hadoop.classification.InterfaceAudience;
22  import org.apache.hadoop.hbase.HConstants.OperationStatusCode;
23  /**
24   * 
25   * This class stores the Operation status code and the exception message
26   * that occurs in case of failure of operations like put, delete, etc.
27   * This class is added with a purpose of adding more details or info regarding
28   * the operation status in future.
29   *
30   */
31  @InterfaceAudience.Private
32  public class OperationStatus {
33  
34    /** Singleton for successful operations.  */
35    static final OperationStatus SUCCESS =
36      new OperationStatus(OperationStatusCode.SUCCESS);
37  
38    /** Singleton for failed operations.  */
39    static final OperationStatus FAILURE =
40      new OperationStatus(OperationStatusCode.FAILURE);
41  
42    /** Singleton for operations not yet run.  */
43    static final OperationStatus NOT_RUN =
44      new OperationStatus(OperationStatusCode.NOT_RUN);
45  
46    private final OperationStatusCode code;
47  
48    private final String exceptionMsg;
49  
50    public OperationStatus(OperationStatusCode code) {
51      this(code, "");
52    }
53  
54    public OperationStatus(OperationStatusCode code, String exceptionMsg) {
55      this.code = code;
56      this.exceptionMsg = exceptionMsg;
57    }
58  
59    public OperationStatus(OperationStatusCode code, Exception e) {
60      this.code = code;
61      this.exceptionMsg = (e == null) ? "" : e.getClass().getName() + ": " + e.getMessage();
62    }
63  
64    /**
65     * @return OperationStatusCode
66     */
67    public OperationStatusCode getOperationStatusCode() {
68      return code;
69    }
70  
71    /**
72     * @return ExceptionMessge
73     */
74    public String getExceptionMsg() {
75      return exceptionMsg;
76    }
77  }