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.ServerName;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Procedures that handle servers -- e.g. server crash -- must implement this Interface. It is used
025 * by the procedure runner to figure locking and what queuing.
026 */
027@InterfaceAudience.Private
028public interface ServerProcedureInterface {
029  public enum ServerOperationType {
030    CRASH_HANDLER,
031    SWITCH_RPC_THROTTLE,
032
033    /**
034     * help find a available region server as worker and release worker after task done invoke
035     * SPLIT_WAL_REMOTE operation to send real WAL splitting request to worker manage the split wal
036     * task flow, will retry if SPLIT_WAL_REMOTE failed
037     */
038    SPLIT_WAL,
039
040    /**
041     * send the split WAL request to region server and handle the response
042     */
043    SPLIT_WAL_REMOTE,
044
045    /**
046     * Get all the replication queues of a crash server and assign them to other region servers
047     */
048    CLAIM_REPLICATION_QUEUES,
049
050    /**
051     * send the claim replication queue request to region server to actually assign it
052     */
053    CLAIM_REPLICATION_QUEUE_REMOTE,
054
055    /**
056     * send verify snapshot request to region server and handle the response
057     */
058    VERIFY_SNAPSHOT
059  }
060
061  /** Returns Name of this server instance. */
062  ServerName getServerName();
063
064  /** Returns True if this server has an hbase:meta table region. */
065  boolean hasMetaTableRegion();
066
067  /**
068   * Given an operation type we can take decisions about what to do with pending operations. e.g. if
069   * we get a crash handler and we have some assignment operation pending we can abort those
070   * operations.
071   * @return the operation type that the procedure is executing.
072   */
073  ServerOperationType getServerOperationType();
074}