/**
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hbase.master;
import java.io.IOException;
import java.util.List;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HRegionInfo;
import org.apache.hadoop.hbase.HTableDescriptor;
import org.apache.hadoop.hbase.ProcedureInfo;
import org.apache.hadoop.hbase.Server;
import org.apache.hadoop.hbase.ServerName;
import org.apache.hadoop.hbase.TableDescriptors;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.TableNotDisabledException;
import org.apache.hadoop.hbase.TableNotFoundException;
import org.apache.hadoop.hbase.classification.InterfaceAudience;
import org.apache.hadoop.hbase.executor.ExecutorService;
import org.apache.hadoop.hbase.master.locking.LockManager;
import org.apache.hadoop.hbase.favored.FavoredNodesManager;
import org.apache.hadoop.hbase.master.normalizer.RegionNormalizer;
import org.apache.hadoop.hbase.master.procedure.MasterProcedureEnv;
import org.apache.hadoop.hbase.master.snapshot.SnapshotManager;
import org.apache.hadoop.hbase.procedure.MasterProcedureManagerHost;
import org.apache.hadoop.hbase.procedure2.LockInfo;
import org.apache.hadoop.hbase.procedure2.ProcedureExecutor;
import org.apache.hadoop.hbase.quotas.MasterQuotaManager;
import org.apache.hadoop.hbase.replication.ReplicationException;
import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;
import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;
import com.google.protobuf.Service;
/**
* Services Master supplies
*/
@InterfaceAudience.Private
public interface MasterServices extends Server {
/**
* @return the underlying snapshot manager
*/
SnapshotManager getSnapshotManager();
/**
* @return the underlying MasterProcedureManagerHost
*/
MasterProcedureManagerHost getMasterProcedureManagerHost();
/**
* @return Master's instance of {@link ClusterSchema}
*/
ClusterSchema getClusterSchema();
/**
* @return Master's instance of the {@link AssignmentManager}
*/
AssignmentManager getAssignmentManager();
/**
* @return Master's filesystem {@link MasterFileSystem} utility class.
*/
MasterFileSystem getMasterFileSystem();
/**
* @return Master's WALs {@link MasterWalManager} utility class.
*/
MasterWalManager getMasterWalManager();
/**
* @return Master's {@link ServerManager} instance.
*/
ServerManager getServerManager();
/**
* @return Master's instance of {@link ExecutorService}
*/
ExecutorService getExecutorService();
/**
* @return Master's instance of {@link TableStateManager}
*/
TableStateManager getTableStateManager();
/**
* @return Master's instance of {@link MasterCoprocessorHost}
*/
MasterCoprocessorHost getMasterCoprocessorHost();
/**
* @return Master's instance of {@link MasterQuotaManager}
*/
MasterQuotaManager getMasterQuotaManager();
/**
* @return Master's instance of {@link RegionNormalizer}
*/
RegionNormalizer getRegionNormalizer();
/**
* @return Master's instance of {@link CatalogJanitor}
*/
CatalogJanitor getCatalogJanitor();
/**
* @return Master's instance of {@link ProcedureExecutor}
*/
ProcedureExecutor<MasterProcedureEnv> getMasterProcedureExecutor();
/**
* Check table is modifiable; i.e. exists and is offline.
* @param tableName Name of table to check.
* @throws TableNotDisabledException
* @throws TableNotFoundException
* @throws IOException
*/
// We actually throw the exceptions mentioned in the
void checkTableModifiable(final TableName tableName)
throws IOException, TableNotFoundException, TableNotDisabledException;
/**
* Create a table using the given table definition.
* @param desc The table definition
* @param splitKeys Starting row keys for the initial table regions. If null
* @param nonceGroup
* @param nonce
* a single region is created.
*/
long createTable(
final HTableDescriptor desc,
final byte[][] splitKeys,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Create a system table using the given table definition.
* @param hTableDescriptor The system table definition
* a single region is created.
*/
long createSystemTable(final HTableDescriptor hTableDescriptor) throws IOException;
/**
* Delete a table
* @param tableName The table name
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long deleteTable(
final TableName tableName,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Truncate a table
* @param tableName The table name
* @param preserveSplits True if the splits should be preserved
* @param nonceGroup
* @param nonce
* @throws IOException
*/
public long truncateTable(
final TableName tableName,
final boolean preserveSplits,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Modify the descriptor of an existing table
* @param tableName The table name
* @param descriptor The updated table descriptor
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long modifyTable(
final TableName tableName,
final HTableDescriptor descriptor,
final long nonceGroup,
final long nonce)
throws IOException;
/**
* Enable an existing table
* @param tableName The table name
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long enableTable(
final TableName tableName,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Disable an existing table
* @param tableName The table name
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long disableTable(
final TableName tableName,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Add a new column to an existing table
* @param tableName The table name
* @param column The column definition
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long addColumn(
final TableName tableName,
final HColumnDescriptor column,
final long nonceGroup,
final long nonce)
throws IOException;
/**
* Modify the column descriptor of an existing column in an existing table
* @param tableName The table name
* @param descriptor The updated column definition
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long modifyColumn(
final TableName tableName,
final HColumnDescriptor descriptor,
final long nonceGroup,
final long nonce)
throws IOException;
/**
* Delete a column from an existing table
* @param tableName The table name
* @param columnName The column name
* @param nonceGroup
* @param nonce
* @throws IOException
*/
long deleteColumn(
final TableName tableName,
final byte[] columnName,
final long nonceGroup,
final long nonce)
throws IOException;
/**
* Merge regions in a table.
* @param regionsToMerge daughter regions to merge
* @param forcible whether to force to merge even two regions are not adjacent
* @param nonceGroup used to detect duplicate
* @param nonce used to detect duplicate
* @return procedure Id
* @throws IOException
*/
long mergeRegions(
final HRegionInfo[] regionsToMerge,
final boolean forcible,
final long nonceGroup,
final long nonce) throws IOException;
/**
* Split a region.
* @param regionInfo region to split
* @param splitRow split point
* @param nonceGroup used to detect duplicate
* @param nonce used to detect duplicate
* @return procedure Id
* @throws IOException
*/
long splitRegion(
final HRegionInfo regionInfo,
final byte [] splitRow,
final long nonceGroup,
final long nonce) throws IOException;
/**
* @return Return table descriptors implementation.
*/
TableDescriptors getTableDescriptors();
/**
* @return true if master enables ServerShutdownHandler;
*/
boolean isServerCrashProcessingEnabled();
/**
* Registers a new protocol buffer {@link Service} subclass as a master coprocessor endpoint.
*
* <p>
* Only a single instance may be registered for a given {@link Service} subclass (the
* instances are keyed on {@link com.google.protobuf.Descriptors.ServiceDescriptor#getFullName()}.
* After the first registration, subsequent calls with the same service name will fail with
* a return value of {@code false}.
* </p>
* @param instance the {@code Service} subclass instance to expose as a coprocessor endpoint
* @return {@code true} if the registration was successful, {@code false}
* otherwise
*/
boolean registerService(Service instance);
/**
* @return true if master is the active one
*/
boolean isActiveMaster();
/**
* @return true if master is initialized
*/
boolean isInitialized();
/**
* @return true if master is in maintanceMode
*/
boolean isInMaintenanceMode();
/**
* Abort a procedure.
* @param procId ID of the procedure
* @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?
* @return true if aborted, false if procedure already completed or does not exist
* @throws IOException
*/
public boolean abortProcedure(final long procId, final boolean mayInterruptIfRunning)
throws IOException;
/**
* List procedures
* @return procedure list
* @throws IOException
*/
public List<ProcedureInfo> listProcedures() throws IOException;
/**
* List locks
* @return lock list
* @throws IOException
*/
public List<LockInfo> listLocks() throws IOException;
/**
* Get list of table descriptors by namespace
* @param name namespace name
* @return descriptors
* @throws IOException
*/
public List<HTableDescriptor> listTableDescriptorsByNamespace(String name) throws IOException;
/**
* Get list of table names by namespace
* @param name namespace name
* @return table names
* @throws IOException
*/
public List<TableName> listTableNamesByNamespace(String name) throws IOException;
/**
* @param table the table for which last successful major compaction time is queried
* @return the timestamp of the last successful major compaction for the passed table,
* or 0 if no HFile resulting from a major compaction exists
* @throws IOException
*/
public long getLastMajorCompactionTimestamp(TableName table) throws IOException;
/**
* @param regionName
* @return the timestamp of the last successful major compaction for the passed region
* or 0 if no HFile resulting from a major compaction exists
* @throws IOException
*/
public long getLastMajorCompactionTimestampForRegion(byte[] regionName) throws IOException;
/**
* @return load balancer
*/
public LoadBalancer getLoadBalancer();
/**
* @return True if this master is stopping.
*/
boolean isStopping();
/**
* @return Favored Nodes Manager
*/
public FavoredNodesManager getFavoredNodesManager();
/**
* Add a new replication peer for replicating data to slave cluster
* @param peerId a short name that identifies the peer
* @param peerConfig configuration for the replication slave cluster
*/
void addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig)
throws ReplicationException, IOException;
/**
* Removes a peer and stops the replication
* @param peerId a short name that identifies the peer
*/
void removeReplicationPeer(String peerId) throws ReplicationException, IOException;
/**
* Restart the replication stream to the specified peer
* @param peerId a short name that identifies the peer
*/
void enableReplicationPeer(String peerId) throws ReplicationException, IOException;
/**
* Stop the replication stream to the specified peer
* @param peerId a short name that identifies the peer
*/
void disableReplicationPeer(String peerId) throws ReplicationException, IOException;
/**
* Returns the configured ReplicationPeerConfig for the specified peer
* @param peerId a short name that identifies the peer
* @return ReplicationPeerConfig for the peer
*/
ReplicationPeerConfig getReplicationPeerConfig(String peerId) throws ReplicationException,
IOException;
/**
* Update the peerConfig for the specified peer
* @param peerId a short name that identifies the peer
* @param peerConfig new config for the peer
*/
void updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)
throws ReplicationException, IOException;
/**
* Return a list of replication peers.
* @param regex The regular expression to match peer id
* @return a list of replication peers description
*/
List<ReplicationPeerDescription> listReplicationPeers(String regex) throws ReplicationException,
IOException;
/**
* Mark a region server as draining to prevent additional regions from getting assigned to it.
* @param server Region servers to drain.
*/
void drainRegionServer(final ServerName server);
/**
* List region servers marked as draining to not get additional regions assigned to them.
* @return List of draining servers.
*/
List<ServerName> listDrainingRegionServers();
/**
* Remove drain from a region server to allow additional regions assignments.
* @param server Region server to remove drain from.
*/
void removeDrainFromRegionServer(final ServerName server);
/**
* @return {@link LockManager} to lock namespaces/tables/regions.
*/
LockManager getLockManager();
}