org.apache.ambari.server.utils

Class PasswordUtils

java.lang.Object

org.apache.ambari.server.utils.PasswordUtils

public class PasswordUtils
extends Object

Utility class to read passwords from files or the Credential Store

Method Summary

Modifier and Type	Method and Description
static PasswordUtils	getInstance()
String	readPassword(String passwordProperty, String defaultPassword) Reading the password belong to the given password property
String	readPasswordFromFile(String filePath, String defaultPassword) Reading password from the given password file
String	readPasswordFromStore(String aliasStr, Configuration configuration) Reading the password from Credential Store for the given alias

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PasswordUtils getInstance()

readPassword

public String readPassword(String passwordProperty,
                           String defaultPassword)

Reading the password belong to the given password property

Parameters:

passwordProperty - this is either the Credential Store alias or the password file name you want to read the password for/from

defaultPassword - the default password this function returns in case the given passwordProperty is or the password file cannot be read for any reason

Returns:

in case passwordProperty belongs to a Credential Store alias this function returns the password of the given Credential Store alias or null (if the given alias is blank or there is no password found in CS); otherwise either the password found in the given password file is returned or defaultPassword if the given path is blank or cannot be read for any reason

Throws:

RuntimeException - if any error occurred while reading the password file

readPasswordFromFile

public String readPasswordFromFile(String filePath,
                                   String defaultPassword)

Reading password from the given password file

Parameters:

filePath - the path of the file to read the password from

defaultPassword - the default password this function returns in case the given filePath is blank or the password file cannot be read for any reason

Returns:

the password found in the given password file or defaultPassword if the given path is blank or cannot be read for any reason

Throws:

RuntimeException - when any error occurred while reading the password file

readPasswordFromStore

public String readPasswordFromStore(String aliasStr,
                                    Configuration configuration)

Reading the password from Credential Store for the given alias

Parameters:

aliasStr - the Credential Store alias you want to read the password for

configuration - with configured master key: masterKeyLocation the master key location file isMasterKeyPersisted a flag indicating whether the master key is persisted masterKeyStoreLocation the master key-store location file

Returns:

the password of the given alias if it is not blank and there is password stored for this alias in Credential Store; null otherwise