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  
19  package org.apache.hadoop.hbase.master.procedure;
20  
21  import org.apache.hadoop.hbase.TableName;
22  import org.apache.hadoop.hbase.classification.InterfaceAudience;
23  import org.apache.hadoop.hbase.classification.InterfaceStability;
24  
25  /**
26   * Procedures that operates on a specific Table (e.g. create, delete, snapshot, ...)
27   * must implement this interface to allow the system handle the lock/concurrency problems.
28   */
29  @InterfaceAudience.Private
30  @InterfaceStability.Evolving
31  public interface TableProcedureInterface {
32    public enum TableOperationType {
33      CREATE, DELETE, DISABLE, EDIT, ENABLE, READ,
34    };
35  
36    /**
37     * @return the name of the table the procedure is operating on
38     */
39    TableName getTableName();
40  
41    /**
42     * Given an operation type we can take decisions about what to do with pending operations.
43     * e.g. if we get a delete and we have some table operation pending (e.g. add column)
44     * we can abort those operations.
45     * @return the operation type that the procedure is executing.
46     */
47    TableOperationType getTableOperationType();
48  }