org.apache.hadoop.hbase.rsgroup.RSGroupInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbase-common Show documentation
Show all versions of hbase-common Show documentation
Common functionality for HBase
/*
* 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.rsgroup;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.net.Address;
import org.apache.yetus.audience.InterfaceAudience;
/**
* Stores the group information of region server groups.
*/
@InterfaceAudience.Public
public class RSGroupInfo {
public static final String DEFAULT_GROUP = "default";
public static final String NAMESPACE_DESC_PROP_GROUP = "hbase.rsgroup.name";
public static final String TABLE_DESC_PROP_GROUP = "hbase.rsgroup.name";
private final String name;
// Keep servers in a sorted set so has an expected ordering when displayed.
private final SortedSet servers;
// Keep tables sorted too.
/**
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
private final SortedSet tables;
private final Map configuration;
public RSGroupInfo(String name) {
this(name, new TreeSet(), new TreeSet());
}
RSGroupInfo(String name, Set servers) {
this.name = name;
this.servers = servers == null ? new TreeSet<>() : new TreeSet<>(servers);
this.tables = new TreeSet<>();
configuration = new HashMap<>();
}
/**
* Constructor
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information for a table will be
* stored in the configuration of a table so this will be removed.
*/
@Deprecated
RSGroupInfo(String name, Set servers, Set tables) {
this.name = name;
this.servers = (servers == null) ? new TreeSet<>() : new TreeSet<>(servers);
this.tables = (tables == null) ? new TreeSet<>() : new TreeSet<>(tables);
configuration = new HashMap<>();
}
public RSGroupInfo(RSGroupInfo src) {
this(src.name, src.servers, src.tables);
}
/** Get group name. */
public String getName() {
return name;
}
/** Adds the given server to the group. */
public void addServer(Address hostPort) {
servers.add(hostPort);
}
/** Adds the given servers to the group. */
public void addAllServers(Collection hostPort) {
servers.addAll(hostPort);
}
/** Returns true if a server with hostPort is found */
public boolean containsServer(Address hostPort) {
return servers.contains(hostPort);
}
/** Get list of servers. */
public Set getServers() {
return servers;
}
/** Remove given server from the group. */
public boolean removeServer(Address hostPort) {
return servers.remove(hostPort);
}
/** Getter for fetching an unmodifiable {@link #configuration} map. */
public Map getConfiguration() {
// shallow pointer copy
return Collections.unmodifiableMap(configuration);
}
/**
* Setter for storing a configuration setting in {@link #configuration} map.
* @param key Config key.
* @param value String value.
*/
public void setConfiguration(String key, String value) {
configuration.put(key, Objects.requireNonNull(value));
}
/** Remove a config setting represented by the key from the {@link #configuration} map */
public void removeConfiguration(final String key) {
configuration.remove(key);
}
/**
* Get set of tables that are members of the group.
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
public SortedSet getTables() {
return tables;
}
/**
* Add a table
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
public void addTable(TableName table) {
tables.add(table);
}
/**
* Add a collection of tables
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
public void addAllTables(Collection arg) {
tables.addAll(arg);
}
/**
* Check if the group contains a table
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
public boolean containsTable(TableName table) {
return tables.contains(table);
}
/**
* Remove a table
* @deprecated Since 3.0.0, will be removed in 4.0.0. The rsgroup information will be stored in
* the configuration of a table so this will be removed.
*/
@Deprecated
public boolean removeTable(TableName table) {
return tables.remove(table);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("Name:");
sb.append(this.name);
sb.append(", ");
sb.append(" Servers:");
sb.append(this.servers);
sb.append(", ");
sb.append(" Tables:");
sb.append(this.tables);
sb.append(", ");
sb.append(" Configurations:");
sb.append(this.configuration);
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof RSGroupInfo)) {
return false;
}
RSGroupInfo rsGroupInfo = (RSGroupInfo) o;
if (!name.equals(rsGroupInfo.name)) {
return false;
}
if (!servers.equals(rsGroupInfo.servers)) {
return false;
}
if (!tables.equals(rsGroupInfo.tables)) {
return false;
}
if (!configuration.equals(rsGroupInfo.configuration)) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = servers.hashCode();
result = 31 * result + tables.hashCode();
result = 31 * result + name.hashCode();
result = 31 * result + configuration.hashCode();
return result;
}
}