001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.master.procedure;
019
020import org.apache.hadoop.hbase.TableName;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Procedures that operates on a specific Table (e.g. create, delete, snapshot, ...)
025 * must implement this interface to allow the system handle the lock/concurrency problems.
026 */
027@InterfaceAudience.Private
028public interface TableProcedureInterface {
029  public enum TableOperationType {
030    CREATE, DELETE, DISABLE, EDIT, ENABLE, READ,
031    REGION_EDIT, REGION_SPLIT, REGION_MERGE, REGION_ASSIGN, REGION_UNASSIGN,
032      REGION_GC, MERGED_REGIONS_GC/* region operations */
033  };
034
035  /**
036   * @return the name of the table the procedure is operating on
037   */
038  TableName getTableName();
039
040  /**
041   * Given an operation type we can take decisions about what to do with pending operations.
042   * e.g. if we get a delete and we have some table operation pending (e.g. add column)
043   * we can abort those operations.
044   * @return the operation type that the procedure is executing.
045   */
046  TableOperationType getTableOperationType();
047}