org.apache.ambari.server.utils

Class SecretReference

java.lang.Object

org.apache.ambari.server.utils.SecretReference

public class SecretReference
extends Object

Constructor Summary

Constructors

Constructor and Description
SecretReference(String reference, Cluster cluster)

Method Summary

Modifier and Type	Method and Description
static String	generateStub(String configType, Long configVersion, String propertyName)
String	getValue()
Long	getVersion()
static boolean	isSecret(String value)
static Map<String,String>	maskPasswordInPropertyMap(Map<String,String> propertyMap) Helper function to mask a string of properties that may contain a property with a password.
static String	maskPasswordInPropertyMap(String propertyMap) Helper function to mask a string of property bags that may contain a property with a password.
static void	replacePasswordsWithReferences(Map<PropertyInfo.PropertyType,Set<String>> propertiesTypes, Map<String,String> propertiesMap, String configType, Long configVersion) Replace real passwords with secret references
static void	replacePasswordsWithReferencesForCustomProperties(Map<String,Map<String,String>> configAttributes, Map<String,String> propertiesMap, String configType, Long configVersion) Replace real passwords with secret references
static void	replaceReferencesWithPasswords(Map<String,String> targetMap, Cluster cluster) Replace secret references with appropriate real passwords.
void	setConfigType(String configType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretReference

public SecretReference(String reference,
                       Cluster cluster)
                throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

Method Detail

setConfigType

public void setConfigType(String configType)

getVersion

public Long getVersion()

getValue

public String getValue()

isSecret

public static boolean isSecret(String value)

generateStub

public static String generateStub(String configType,
                                  Long configVersion,
                                  String propertyName)

maskPasswordInPropertyMap

public static String maskPasswordInPropertyMap(String propertyMap)

Helper function to mask a string of property bags that may contain a property with a password.

Parameters:

propertyMap - Property map to mask by replacing any passwords with the text "SECRET"

Returns:

New string with the passwords masked, or null if the property map is null.

maskPasswordInPropertyMap

public static Map<String,String> maskPasswordInPropertyMap(Map<String,String> propertyMap)

Helper function to mask a string of properties that may contain a property with a password.

Parameters:

propertyMap - Property map to mask by replacing any passwords with the text "SECRET"

Returns:

a new map with the passwords masked, or null if the propertyMap is null.

replaceReferencesWithPasswords

public static void replaceReferencesWithPasswords(Map<String,String> targetMap,
                                                  Cluster cluster)
                                           throws org.apache.ambari.server.AmbariException

Replace secret references with appropriate real passwords.

Parameters:

targetMap - map in which replacement will be performed

cluster - current cluster

Throws:

org.apache.ambari.server.AmbariException

replacePasswordsWithReferences

public static void replacePasswordsWithReferences(Map<PropertyInfo.PropertyType,Set<String>> propertiesTypes,
                                                  Map<String,String> propertiesMap,
                                                  String configType,
                                                  Long configVersion)

Replace real passwords with secret references

Parameters:

propertiesTypes - map with properties types

propertiesMap - map with properties in which replacement will be performed

configType - configuration type

configVersion - configuration version

replacePasswordsWithReferencesForCustomProperties

public static void replacePasswordsWithReferencesForCustomProperties(Map<String,Map<String,String>> configAttributes,
                                                                     Map<String,String> propertiesMap,
                                                                     String configType,
                                                                     Long configVersion)

Replace real passwords with secret references

Parameters:

configAttributes - map with config attributes containing properties types as part of their content

propertiesMap - map with properties in which replacement will be performed

configType - configuration type

configVersion - configuration version