Class DefaultMaskingFormatter

java.lang.Object

org.apache.camel.support.processor.DefaultMaskingFormatter

All Implemented Interfaces:

org.apache.camel.spi.MaskingFormatter

public class DefaultMaskingFormatter
extends Object
implements org.apache.camel.spi.MaskingFormatter

The MaskingFormatter that searches the specified keywords in the source and replace its value with mask string.

By default all the known secret keys from SensitiveUtils.getSensitiveKeys() are used. Custom keywords can be added with the addKeyword(String) method.

In addition to name-based masking, this formatter also masks URI userinfo passwords (scheme://user:password@host) and PEM private-key blocks via SensitiveUtils.maskSensitiveValueShapes(String, String). Value-shape masking runs even when the keyword set is empty (for example a custom formatter constructed with no sensitive key names), so embedded credentials in connection strings are still redacted.

Field Summary

Fields inherited from interface org.apache.camel.spi.MaskingFormatter

CUSTOM_LOG_MASK_REF

Constructor Summary

Constructors

Constructor	Description
DefaultMaskingFormatter()
DefaultMaskingFormatter(boolean maskKeyValue, boolean maskXml, boolean maskJson)
DefaultMaskingFormatter(Set<String> keywords, boolean maskKeyValue, boolean maskXmlElement, boolean maskJson)
DefaultMaskingFormatter(org.apache.camel.CamelContext camelContext)

Method Summary

Modifier and Type	Method	Description
void	addKeyword(String keyword)	Adds a custom keyword for masking.
protected Pattern	createJsonMaskPattern(Set<String> keywords)
protected Pattern	createKeyValueMaskPattern(Set<String> keywords)
protected StringBuilder	createOneOfThemRegex(Set<String> keywords)
protected Pattern	createXmlElementMaskPattern(Set<String> keywords)
String	format(String source)
String	getMaskString()	The string to use for replacement such as xxxxx
protected void	initPatterns()
boolean	isMaskJson()
boolean	isMaskKeyValue()
boolean	isMaskXmlElement()
void	setCustomKeywords(Set<String> keywords)	Adds custom keywords for masking.
void	setMaskJson(boolean maskJson)
void	setMaskKeyValue(boolean maskKeyValue)
void	setMaskString(String maskString)	The string to use for replacement such as xxxxx
void	setMaskXmlElement(boolean maskXml)

Methods inherited from class Object

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

Constructor Details

DefaultMaskingFormatter

public DefaultMaskingFormatter()

DefaultMaskingFormatter

public DefaultMaskingFormatter(org.apache.camel.CamelContext camelContext)

DefaultMaskingFormatter

public DefaultMaskingFormatter(boolean maskKeyValue,
 boolean maskXml,
 boolean maskJson)

DefaultMaskingFormatter

public DefaultMaskingFormatter(Set<String> keywords,
 boolean maskKeyValue,
 boolean maskXmlElement,
 boolean maskJson)

Method Details

addKeyword

public void addKeyword(String keyword)

Adds a custom keyword for masking.

setCustomKeywords

public void setCustomKeywords(Set<String> keywords)

Adds custom keywords for masking.

getMaskString

public String getMaskString()

The string to use for replacement such as xxxxx

setMaskString

public void setMaskString(String maskString)

The string to use for replacement such as xxxxx

format

public String format(String source)

Specified by:

format in interface org.apache.camel.spi.MaskingFormatter

isMaskKeyValue

public boolean isMaskKeyValue()

setMaskKeyValue

public void setMaskKeyValue(boolean maskKeyValue)

isMaskXmlElement

public boolean isMaskXmlElement()

setMaskXmlElement

public void setMaskXmlElement(boolean maskXml)

isMaskJson

public boolean isMaskJson()

setMaskJson

public void setMaskJson(boolean maskJson)

initPatterns

protected void initPatterns()

createKeyValueMaskPattern

protected Pattern createKeyValueMaskPattern(Set<String> keywords)

createXmlElementMaskPattern

protected Pattern createXmlElementMaskPattern(Set<String> keywords)

createJsonMaskPattern

protected Pattern createJsonMaskPattern(Set<String> keywords)

createOneOfThemRegex

protected StringBuilder createOneOfThemRegex(Set<String> keywords)