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