org.springframework.xd.dirt.rest

Class PasswordUtils

java.lang.Object

org.springframework.xd.dirt.rest.PasswordUtils

public class PasswordUtils
extends java.lang.Object

Provides common utility methods for JobDefinitions and StreamDefinitions (BaseDefinition), e.g. the masking of passwords in definition parameters.

Since:

1.0

Author:

Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MASK_CHARACTER
static java.lang.String[]	PASSWORD_PARAMETER_NAMES
static java.util.regex.Pattern	passwordParameterPattern

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	maskPasswordsInDefinition(java.lang.String definition) This method takes a definition String as input parameter.
static void	maskPropertiesIfNecessary(java.util.Properties properties) Will mask property values if they contain keys that contain the values specified in PASSWORD_PARAMETER_NAMES.
static java.lang.String	maskString(java.lang.String stringToMask) Masks provided Strings with the MASK_CHARACTER.

Methods inherited from class java.lang.Object

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

Field Detail

PASSWORD_PARAMETER_NAMES

public static final java.lang.String[] PASSWORD_PARAMETER_NAMES

MASK_CHARACTER

public static final java.lang.String MASK_CHARACTER

See Also:

Constant Field Values

passwordParameterPattern

public static java.util.regex.Pattern passwordParameterPattern

Method Detail

maskPasswordsInDefinition

public static java.lang.String maskPasswordsInDefinition(java.lang.String definition)

This method takes a definition String as input parameter. The method will filter out any parameters labeled --password and will masked them using the * character.

Parameters:

definition - Must not be empty

Returns:

The definition string with masked passwords. Should never return null.

maskString

public static java.lang.String maskString(java.lang.String stringToMask)

Masks provided Strings with the MASK_CHARACTER.

Parameters:

stringToMask - Must not be null

Returns:

The masked String

maskPropertiesIfNecessary

public static void maskPropertiesIfNecessary(java.util.Properties properties)

Will mask property values if they contain keys that contain the values specified in PASSWORD_PARAMETER_NAMES. Be aware that this is a mutable operation and the passed-in Properties will be modified.

Parameters:

properties - Must not be null.