Package dev.blaauwendraad.masker.json.config

Class JsonMaskingConfig.Builder

java.lang.Object

dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Enclosing class:

JsonMaskingConfig

public static class JsonMaskingConfig.Builder
extends Object

Builder to create JsonMaskingConfig instances using the builder pattern.

Method Summary

Modifier and Type	Method	Description
JsonMaskingConfig.Builder	allowJsonPaths(Set<String> jsonPaths)
JsonMaskingConfig.Builder	allowKeys(Set<String> keys)
JsonMaskingConfig	build()	Creates a new JsonMaskingConfig instance.
JsonMaskingConfig.Builder	caseSensitiveTargetKeys()	Configures whether the target keys are considered case-sensitive (e.g.
JsonMaskingConfig.Builder	maskBooleansWith(boolean value)	Mask all boolean values with the provided value.
JsonMaskingConfig.Builder	maskBooleansWith(ValueMasker.BooleanMasker valueMasker)	Mask all boolean values with the provided ValueMasker.
JsonMaskingConfig.Builder	maskBooleansWith(String value)	Mask all boolean values with the provided value.
JsonMaskingConfig.Builder	maskJsonPaths(Set<String> jsonPaths)
JsonMaskingConfig.Builder	maskJsonPaths(Set<String> jsonPaths, KeyMaskingConfig config)
JsonMaskingConfig.Builder	maskKeys(Set<String> keys)
JsonMaskingConfig.Builder	maskKeys(Set<String> keys, KeyMaskingConfig config)
JsonMaskingConfig.Builder	maskNumberDigitsWith(int digit)	Mask all digits of number values with the provided digit, preserving the length.
JsonMaskingConfig.Builder	maskNumbersWith(int value)	Mask all number values with the provided value.
JsonMaskingConfig.Builder	maskNumbersWith(ValueMasker.NumberMasker valueMasker)	Mask all numeric values with the provided ValueMasker.
JsonMaskingConfig.Builder	maskNumbersWith(String value)	Mask all number values with the provided value.
JsonMaskingConfig.Builder	maskStringCharactersWith(String value)	Mask all characters of string values with the provided character, preserving the length.
JsonMaskingConfig.Builder	maskStringsWith(ValueMasker.StringMasker valueMasker)	Mask all string values with the provided ValueMasker.
JsonMaskingConfig.Builder	maskStringsWith(String value)	Mask all string values with the provided value.

Methods inherited from class java.lang.Object

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

Method Details

maskKeys

public JsonMaskingConfig.Builder maskKeys(Set<String> keys)

maskKeys

public JsonMaskingConfig.Builder maskKeys(Set<String> keys,
 KeyMaskingConfig config)

maskJsonPaths

public JsonMaskingConfig.Builder maskJsonPaths(Set<String> jsonPaths)

maskJsonPaths

public JsonMaskingConfig.Builder maskJsonPaths(Set<String> jsonPaths,
 KeyMaskingConfig config)

allowKeys

public JsonMaskingConfig.Builder allowKeys(Set<String> keys)

allowJsonPaths

public JsonMaskingConfig.Builder allowJsonPaths(Set<String> jsonPaths)

caseSensitiveTargetKeys

public JsonMaskingConfig.Builder caseSensitiveTargetKeys()

Configures whether the target keys are considered case-sensitive (e.g. cvv != CVV)

Default value: false (target keys are considered case-insensitive)

Returns:

the builder instance

maskStringsWith

public JsonMaskingConfig.Builder maskStringsWith(String value)

Mask all string values with the provided value. For example, "maskMe": "secret" -> "maskMe": "***".

Masking strings with '***' is the default behaviour if no string masking option is set.

Returns:

the builder instance

See Also:

• maskStringCharactersWith(String)
• maskStringsWith(ValueMasker.StringMasker)
• KeyMaskingConfig.Builder.maskStringsWith(String)

maskStringCharactersWith

public JsonMaskingConfig.Builder maskStringCharactersWith(String value)

Mask all characters of string values with the provided character, preserving the length. For example, "maskMe": "secret" -> "maskMe": "******".

Returns:

the builder instance

See Also:

• maskStringsWith(String)
• maskStringsWith(ValueMasker.StringMasker)
• KeyMaskingConfig.Builder.maskStringCharactersWith(String)

maskStringsWith

public JsonMaskingConfig.Builder maskStringsWith(ValueMasker.StringMasker valueMasker)

Mask all string values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskStringsWith(String)
• maskStringCharactersWith(String)
• KeyMaskingConfig.Builder.maskStringsWith(ValueMasker.StringMasker)

maskNumbersWith

public JsonMaskingConfig.Builder maskNumbersWith(String value)

Mask all number values with the provided value. For example, "maskMe": 12345 -> "maskMe": "###".

Masking numbers with '###' is the default behaviour if no number masking option is set.

Returns:

the builder instance

See Also:

• maskNumbersWith(int)
• maskNumberDigitsWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)
• KeyMaskingConfig.Builder.maskNumbersWith(String)

maskNumbersWith

public JsonMaskingConfig.Builder maskNumbersWith(int value)

Mask all number values with the provided value. For example, "maskMe": 12345 -> "maskMe": 0.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumberDigitsWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)
• KeyMaskingConfig.Builder.maskNumbersWith(int)

maskNumberDigitsWith

public JsonMaskingConfig.Builder maskNumberDigitsWith(int digit)

Mask all digits of number values with the provided digit, preserving the length. For example, "maskMe": 12345 -> "maskMe": 88888.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumbersWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)
• KeyMaskingConfig.Builder.maskNumberDigitsWith(int)

maskNumbersWith

public JsonMaskingConfig.Builder maskNumbersWith(ValueMasker.NumberMasker valueMasker)

Mask all numeric values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskNumbersWith(String)
• maskNumbersWith(int)
• maskNumberDigitsWith(int)
• maskNumbersWith(ValueMasker.NumberMasker)
• KeyMaskingConfig.Builder.maskNumbersWith(ValueMasker.NumberMasker)

maskBooleansWith

public JsonMaskingConfig.Builder maskBooleansWith(String value)

Mask all boolean values with the provided value. For example, "maskMe": true -> "maskMe": "&&&".

Masking booleans with '&&&' is the default behaviour if no boolean masking option is set.

Returns:

the builder instance

See Also:

• maskBooleansWith(boolean)
• maskBooleansWith(ValueMasker.BooleanMasker)
• KeyMaskingConfig.Builder.maskBooleansWith(String)

maskBooleansWith

public JsonMaskingConfig.Builder maskBooleansWith(boolean value)

Mask all boolean values with the provided value. For example, "maskMe": true -> "maskMe": false.

Returns:

the builder instance

See Also:

• maskBooleansWith(String)
• maskBooleansWith(ValueMasker.BooleanMasker)
• KeyMaskingConfig.Builder.maskBooleansWith(boolean)

maskBooleansWith

public JsonMaskingConfig.Builder maskBooleansWith(ValueMasker.BooleanMasker valueMasker)

Mask all boolean values with the provided ValueMasker.

Returns:

the builder instance

See Also:

• maskBooleansWith(boolean)
• maskBooleansWith(String)
• KeyMaskingConfig.Builder.maskBooleansWith(ValueMasker.BooleanMasker)

build

public JsonMaskingConfig build()

Creates a new JsonMaskingConfig instance.

Returns:

the new instance