org.apache.hadoop.hive.conf

Class HiveConfUtil

java.lang.Object

org.apache.hadoop.hive.conf.HiveConfUtil

@InterfaceAudience.Private
public class HiveConfUtil
extends Object

Hive Configuration utils

Constructor Summary

Constructors

Constructor and Description
HiveConfUtil()

Method Summary

Modifier and Type	Method and Description
static void	dumpConfig(org.apache.hadoop.conf.Configuration originalConf, StringBuilder sb)
static StringBuilder	dumpConfig(HiveConf conf) Dumps all HiveConf for debugging.
static Set<String>	getHiddenSet(org.apache.hadoop.conf.Configuration configuration) Getting the set of the hidden configurations
static String	getJobCredentialProviderPassword(org.apache.hadoop.conf.Configuration conf)
static boolean	isEmbeddedMetaStore(String msUri) Check if metastore is being used in embedded mode.
static void	stripConfigurations(org.apache.hadoop.conf.Configuration conf) Searches the given configuration object and replaces all the configuration values for keys defined hive.conf.hidden.list by empty String
static void	stripConfigurations(org.apache.hadoop.conf.Configuration conf, Set<String> hiddenSet) Strips hidden config entries from configuration
static void	updateJobCredentialProviders(org.apache.hadoop.conf.Configuration jobConf) Updates the job configuration with the job specific credential provider information available in the HiveConf.It uses the environment variables HADOOP_CREDSTORE_PASSWORD or HIVE_JOB_CREDSTORE_PASSWORD to get the custom password for all the keystores configured in the provider path.

Methods inherited from class java.lang.Object

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

Constructor Detail

HiveConfUtil

public HiveConfUtil()

Method Detail

isEmbeddedMetaStore

public static boolean isEmbeddedMetaStore(String msUri)

Check if metastore is being used in embedded mode. This utility function exists so that the logic for determining the mode is same in HiveConf and HiveMetaStoreClient

Parameters:

msUri - - metastore server uri

Returns:

dumpConfig

public static StringBuilder dumpConfig(HiveConf conf)

Dumps all HiveConf for debugging. Convenient to dump state at process start up and log it so that in later analysis the values of all variables is known

getHiddenSet

public static Set<String> getHiddenSet(org.apache.hadoop.conf.Configuration configuration)

Getting the set of the hidden configurations

Parameters:

configuration - The original configuration

Returns:

The list of the configuration values to hide

stripConfigurations

public static void stripConfigurations(org.apache.hadoop.conf.Configuration conf,
                                       Set<String> hiddenSet)

Strips hidden config entries from configuration

Parameters:

conf - The configuration to strip from

hiddenSet - The values to strip

stripConfigurations

public static void stripConfigurations(org.apache.hadoop.conf.Configuration conf)

Searches the given configuration object and replaces all the configuration values for keys defined hive.conf.hidden.list by empty String

Parameters:

conf - - Configuration object which needs to be modified to remove sensitive keys

dumpConfig

public static void dumpConfig(org.apache.hadoop.conf.Configuration originalConf,
                              StringBuilder sb)

updateJobCredentialProviders

public static void updateJobCredentialProviders(org.apache.hadoop.conf.Configuration jobConf)

Updates the job configuration with the job specific credential provider information available in the HiveConf.It uses the environment variables HADOOP_CREDSTORE_PASSWORD or HIVE_JOB_CREDSTORE_PASSWORD to get the custom password for all the keystores configured in the provider path. This usage of environment variables is similar in lines with Hadoop credential provider mechanism for getting the keystore passwords. The other way of communicating the password is through a file which stores the password in clear-text which needs to be readable by all the consumers and therefore is not supported.

• If HIVE_SERVER2_JOB_CREDENTIAL_PROVIDER_PATH is set in the hive configuration this method overrides the MR job configuration property hadoop.security.credential.provider.path with its value. If not set then it does not change the value of hadoop.security.credential.provider.path
• In order to choose the password for the credential provider we check : (1) if job credential provider path HIVE_SERVER2_JOB_CREDENTIAL_PROVIDER_PATH is set we check if HIVE_SERVER2_JOB_CREDSTORE_PASSWORD_ENVVAR is set. If it is set we use it. (2) If password is not set using (1) above we use HADOOP_CREDSTORE_PASSWORD if it is set. (3) If none of those are set, we do not set any password in the MR task environment. In this case the hadoop credential provider should use the default password of "none" automatically

Parameters:

jobConf - - job specific configuration

getJobCredentialProviderPassword

public static String getJobCredentialProviderPassword(org.apache.hadoop.conf.Configuration conf)