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, ...) must implement
025 * this interface to allow the system handle the lock/concurrency problems.
026 */
027@InterfaceAudience.Private
028public interface TableProcedureInterface {
029
030  /**
031   * Used for acquire/release lock for namespace related operations, just a place holder as we do
032   * not have namespace table any more.
033   */
034  public static final TableName DUMMY_NAMESPACE_TABLE_NAME = TableName.NAMESPACE_TABLE_NAME;
035
036  public enum TableOperationType {
037    CREATE,
038    DELETE,
039    DISABLE,
040    EDIT,
041    ENABLE,
042    READ,
043    SNAPSHOT,
044    REGION_SNAPSHOT,
045    REGION_EDIT,
046    REGION_SPLIT,
047    REGION_MERGE,
048    REGION_ASSIGN,
049    REGION_UNASSIGN,
050    REGION_GC,
051    MERGED_REGIONS_GC/* region operations */
052  }
053
054  /**
055   * @return the name of the table the procedure is operating on
056   */
057  TableName getTableName();
058
059  /**
060   * Given an operation type we can take decisions about what to do with pending operations. e.g. if
061   * we get a delete and we have some table operation pending (e.g. add column) we can abort those
062   * operations.
063   * @return the operation type that the procedure is executing.
064   */
065  TableOperationType getTableOperationType();
066}