org.apache.hadoop.hbase

Class HBaseConfiguration

java.lang.Object

org.apache.hadoop.conf.Configuration

org.apache.hadoop.hbase.HBaseConfiguration

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>, org.apache.hadoop.io.Writable

@InterfaceAudience.Public
public class HBaseConfiguration
extends org.apache.hadoop.conf.Configuration

Adds HBase configuration files to a Configuration

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.conf.Configuration

org.apache.hadoop.conf.Configuration.DeprecationDelta, org.apache.hadoop.conf.Configuration.IntegerRanges

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
HBaseConfiguration() Deprecated. since 0.90.0. Please use create() instead.
HBaseConfiguration(org.apache.hadoop.conf.Configuration c) Deprecated. since 0.90.0. Please use create(Configuration) instead.

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.conf.Configuration	addHbaseResources(org.apache.hadoop.conf.Configuration conf)
private static void	applyClusterKeyToConf(org.apache.hadoop.conf.Configuration conf, String key) Apply the settings in the given key to the given configuration, this is used to communicate with distant clusters
private static void	checkDefaultsVersion(org.apache.hadoop.conf.Configuration conf)
static org.apache.hadoop.conf.Configuration	create() Creates a Configuration with HBase resources
static org.apache.hadoop.conf.Configuration	create(org.apache.hadoop.conf.Configuration that)
static org.apache.hadoop.conf.Configuration	createClusterConf(org.apache.hadoop.conf.Configuration baseConf, String clusterKey) Generates a Configuration instance by applying the ZooKeeper cluster key to the base Configuration.
static org.apache.hadoop.conf.Configuration	createClusterConf(org.apache.hadoop.conf.Configuration baseConf, String clusterKey, String overridePrefix) Generates a Configuration instance by applying property overrides prefixed by a cluster profile key to the base Configuration.
static int	getInt(org.apache.hadoop.conf.Configuration conf, String name, String deprecatedName, int defaultValue) Deprecated. it will be removed in 3.0.0. Use Configuration.addDeprecation(String, String) instead.
static String	getPassword(org.apache.hadoop.conf.Configuration conf, String alias, String defPass) Get the password from the Configuration instance using the getPassword method if it exists.
static boolean	isShowConfInServlet()
static void	main(String[] args) For debugging.
static void	merge(org.apache.hadoop.conf.Configuration destConf, org.apache.hadoop.conf.Configuration srcConf) Merge two configurations.
static void	setWithPrefix(org.apache.hadoop.conf.Configuration conf, String prefix, Iterable<Map.Entry<String,String>> properties) Sets all the entries in the provided Map<String, String> as properties in the given Configuration.
static org.apache.hadoop.conf.Configuration	subset(org.apache.hadoop.conf.Configuration srcConf, String prefix) Returns a subset of the configuration properties, matching the given key prefix.

Methods inherited from class org.apache.hadoop.conf.Configuration

addDefaultResource, addDeprecation, addDeprecation, addDeprecation, addDeprecation, addDeprecations, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, clear, dumpConfiguration, dumpConfiguration, dumpDeprecatedKeys, get, get, getBoolean, getClass, getClass, getClassByName, getClassByNameOrNull, getClasses, getClassLoader, getConfResourceAsInputStream, getConfResourceAsReader, getDouble, getEnum, getFile, getFinalParameters, getFloat, getInstances, getInt, getInts, getLocalPath, getLong, getLongBytes, getPassword, getPasswordFromConfig, getPasswordFromCredentialProviders, getPattern, getPropertySources, getProps, getPropsWithPrefix, getRange, getRaw, getResource, getSocketAddr, getSocketAddr, getStringCollection, getStrings, getStrings, getTimeDuration, getTimeDurations, getTrimmed, getTrimmed, getTrimmedStringCollection, getTrimmedStrings, getTrimmedStrings, getValByRegex, hasWarnedDeprecation, isDeprecated, iterator, onlyKeyExists, readFields, reloadConfiguration, reloadExistingConfigurations, set, set, setAllowNullValueProperties, setBoolean, setBooleanIfUnset, setClass, setClassLoader, setDeprecatedProperties, setDouble, setEnum, setFloat, setIfUnset, setInt, setLong, setPattern, setQuietMode, setRestrictSystemProperties, setRestrictSystemPropertiesDefault, setRestrictSystemProps, setSocketAddr, setStrings, setTimeDuration, size, toString, unset, updateConnectAddr, updateConnectAddr, write, writeXml, writeXml, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG

private static final org.slf4j.Logger LOG

Constructor Detail

HBaseConfiguration

@Deprecated
public HBaseConfiguration()

Deprecated. since 0.90.0. Please use create() instead.

Instantiating HBaseConfiguration() is deprecated. Please use HBaseConfiguration#create() to construct a plain Configuration

See Also:

create(), HBASE-2036

HBaseConfiguration

@Deprecated
public HBaseConfiguration(org.apache.hadoop.conf.Configuration c)

Deprecated. since 0.90.0. Please use create(Configuration) instead.

Instantiating HBaseConfiguration() is deprecated. Please use HBaseConfiguration#create(conf) to construct a plain Configuration

See Also:

create(Configuration), HBASE-2036

Method Detail

checkDefaultsVersion

private static void checkDefaultsVersion(org.apache.hadoop.conf.Configuration conf)

addHbaseResources

public static org.apache.hadoop.conf.Configuration addHbaseResources(org.apache.hadoop.conf.Configuration conf)

create

public static org.apache.hadoop.conf.Configuration create()

Creates a Configuration with HBase resources

Returns:

a Configuration with HBase resources

create

public static org.apache.hadoop.conf.Configuration create(org.apache.hadoop.conf.Configuration that)

Parameters:

that - Configuration to clone.

Returns:

a Configuration created with the hbase-*.xml files plus the given configuration.

merge

public static void merge(org.apache.hadoop.conf.Configuration destConf,
                         org.apache.hadoop.conf.Configuration srcConf)

Merge two configurations.

Parameters:

destConf - the configuration that will be overwritten with items from the srcConf

srcConf - the source configuration

subset

public static org.apache.hadoop.conf.Configuration subset(org.apache.hadoop.conf.Configuration srcConf,
                                                          String prefix)

Returns a subset of the configuration properties, matching the given key prefix. The prefix is stripped from the return keys, ie. when calling with a prefix of "myprefix", the entry "myprefix.key1 = value1" would be returned as "key1 = value1". If an entry's key matches the prefix exactly ("myprefix = value2"), it will not be included in the results, since it would show up as an entry with an empty key.

setWithPrefix

public static void setWithPrefix(org.apache.hadoop.conf.Configuration conf,
                                 String prefix,
                                 Iterable<Map.Entry<String,String>> properties)

Sets all the entries in the provided Map<String, String> as properties in the given Configuration. Each property will have the specified prefix prepended, so that the configuration entries are keyed by prefix + entry.getKey().

isShowConfInServlet

public static boolean isShowConfInServlet()

Returns:

whether to show HBase Configuration in servlet

getInt

@Deprecated
public static int getInt(org.apache.hadoop.conf.Configuration conf,
                                     String name,
                                     String deprecatedName,
                                     int defaultValue)

Deprecated. it will be removed in 3.0.0. Use Configuration.addDeprecation(String, String) instead.

Get the value of the name property as an int, possibly referring to the deprecated name of the configuration property. If no such property exists, the provided default value is returned, or if the specified value is not a valid int, then an error is thrown.

Parameters:

name - property name.

deprecatedName - a deprecatedName for the property to use if non-deprecated name is not used

defaultValue - default value.

Returns:

property value as an int, or defaultValue.

Throws:

NumberFormatException - when the value is invalid

getPassword

public static String getPassword(org.apache.hadoop.conf.Configuration conf,
                                 String alias,
                                 String defPass)
                          throws IOException

Get the password from the Configuration instance using the getPassword method if it exists. If not, then fall back to the general get method for configuration elements.

Parameters:

conf - configuration instance for accessing the passwords

alias - the name of the password element

defPass - the default password

Returns:

String password or default password

Throws:

IOException

createClusterConf

public static org.apache.hadoop.conf.Configuration createClusterConf(org.apache.hadoop.conf.Configuration baseConf,
                                                                     String clusterKey)
                                                              throws IOException

Generates a Configuration instance by applying the ZooKeeper cluster key to the base Configuration. Note that additional configuration properties may be needed for a remote cluster, so it is preferable to use createClusterConf(Configuration, String, String).

Parameters:

baseConf - the base configuration to use, containing prefixed override properties

clusterKey - the ZooKeeper quorum cluster key to apply, or null if none

Returns:

the merged configuration with override properties and cluster key applied

Throws:

IOException

See Also:

createClusterConf(Configuration, String, String)

createClusterConf

public static org.apache.hadoop.conf.Configuration createClusterConf(org.apache.hadoop.conf.Configuration baseConf,
                                                                     String clusterKey,
                                                                     String overridePrefix)
                                                              throws IOException

Generates a Configuration instance by applying property overrides prefixed by a cluster profile key to the base Configuration. Override properties are extracted by the subset(Configuration, String) method, then the merged on top of the base Configuration and returned.

Parameters:

baseConf - the base configuration to use, containing prefixed override properties

clusterKey - the ZooKeeper quorum cluster key to apply, or null if none

overridePrefix - the property key prefix to match for override properties, or null if none

Returns:

the merged configuration with override properties and cluster key applied

Throws:

IOException

applyClusterKeyToConf

private static void applyClusterKeyToConf(org.apache.hadoop.conf.Configuration conf,
                                          String key)
                                   throws IOException

Apply the settings in the given key to the given configuration, this is used to communicate with distant clusters

Parameters:

conf - configuration object to configure

key - string that contains the 3 required configuratins

Throws:

IOException

main

public static void main(String[] args)
                 throws Exception

For debugging. Dump configurations to system output as xml format. Master and RS configurations can also be dumped using http services. e.g. "curl http://master:16010/dump"

Throws:

Exception