com.stackify.api.common.mask

Class Masker

java.lang.Object

com.stackify.api.common.mask.Masker

public class Masker
extends Object

Handles masking string values based on regex matching. Class is Thread Safe.

Author:

Darin Howard

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MASK_CC_AMEX_REGEX
protected static String	MASK_CC_DINERS_REGEX
protected static String	MASK_CC_DISCOVER_REGEX
protected static String	MASK_CC_MASTERCARD_REGEX
protected static String	MASK_CC_VISA_REGEX
static String	MASK_CREDITCARD
static String	MASK_EMAIL
protected static String	MASK_EMAIL_REGEX
static String	MASK_IP
protected static String	MASK_IPV4_REGEX
static String	MASK_NUMERIC
protected static String	MASK_NUMERIC_REGEX
static String	MASK_SSN
protected static String	MASK_SSN_REGEX
static String	MASK_UUID
protected static String	MASK_UUID_REGEX
static String[]	MASKS

Constructor Summary

Constructors

Constructor and Description
Masker()

Method Summary

Modifier and Type	Method and Description
void	addMask(@NonNull String mask)
void	clearMasks()
boolean	hasMasks()
String	mask(String value) Returns string with '*' replacing any value matching a configured mask.
String	mask(String value, String replacementValue) Returns string with [replacementValue] replacing any value matching a configured mask.
void	removeMask(@NonNull String mask)

Methods inherited from class java.lang.Object

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

Field Detail

MASK_CREDITCARD

public static final String MASK_CREDITCARD

See Also:

Constant Field Values

MASK_SSN

public static final String MASK_SSN

See Also:

Constant Field Values

MASK_IP

public static final String MASK_IP

See Also:

Constant Field Values

MASK_UUID

public static final String MASK_UUID

See Also:

Constant Field Values

MASK_NUMERIC

public static final String MASK_NUMERIC

See Also:

Constant Field Values

MASK_EMAIL

public static final String MASK_EMAIL

See Also:

Constant Field Values

MASKS

public static final String[] MASKS

MASK_CC_VISA_REGEX

protected static final String MASK_CC_VISA_REGEX

See Also:

Constant Field Values

MASK_CC_DISCOVER_REGEX

protected static final String MASK_CC_DISCOVER_REGEX

See Also:

Constant Field Values

MASK_CC_MASTERCARD_REGEX

protected static final String MASK_CC_MASTERCARD_REGEX

See Also:

Constant Field Values

MASK_CC_AMEX_REGEX

protected static final String MASK_CC_AMEX_REGEX

See Also:

Constant Field Values

MASK_CC_DINERS_REGEX

protected static final String MASK_CC_DINERS_REGEX

See Also:

Constant Field Values

MASK_SSN_REGEX

protected static final String MASK_SSN_REGEX

See Also:

Constant Field Values

MASK_IPV4_REGEX

protected static final String MASK_IPV4_REGEX

See Also:

Constant Field Values

MASK_NUMERIC_REGEX

protected static final String MASK_NUMERIC_REGEX

See Also:

Constant Field Values

MASK_UUID_REGEX

protected static final String MASK_UUID_REGEX

See Also:

Constant Field Values

MASK_EMAIL_REGEX

protected static final String MASK_EMAIL_REGEX

See Also:

Constant Field Values

Constructor Detail

Masker

public Masker()

Method Detail

clearMasks

public void clearMasks()

removeMask

public void removeMask(@NonNull
                       @NonNull String mask)

addMask

public void addMask(@NonNull
                    @NonNull String mask)

mask

public String mask(String value)

Returns string with '*' replacing any value matching a configured mask.

Parameters:

value - Value to mask.

mask

public String mask(String value,
                   String replacementValue)

Returns string with [replacementValue] replacing any value matching a configured mask.

Parameters:

value - Value to mask.

replacementValue - Value to use when replacing original content. If a single character string is supplied, it will be repeated to keep original value's length.

hasMasks

public boolean hasMasks()