Module dev.blaauwendraad.masker.json

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(String... jsonPath)	Only allow the given JSONPath to be unmasked, mask JSON values corresponding to any other key.
JsonMaskingConfig.Builder	allowJsonPaths(Set<String> jsonPaths)	Only allow the given JSONPaths to be unmasked, mask JSON values corresponding to any other key.
JsonMaskingConfig.Builder	allowKeys(String... keys)	Only allow the given key to be unmasked, mask JSON values corresponding to any other key.
JsonMaskingConfig.Builder	allowKeys(Set<String> keys)	Only allow the given keys to be unmasked, mask JSON values corresponding to any other key.
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(String... jsonPaths)	Masks all JSON values corresponding to the given JSONPaths with the default masking configuration.
JsonMaskingConfig.Builder	maskJsonPaths(String jsonPath, KeyMaskingConfig config)	Masks all JSON values corresponding to the given JSONPath with the given masking configuration.
JsonMaskingConfig.Builder	maskJsonPaths(Map<String,KeyMaskingConfig> configs)	Masks all JSON values corresponding to the given JSONPaths with the given masking configuration.
JsonMaskingConfig.Builder	maskJsonPaths(Set<String> jsonPaths)	Masks all JSON values corresponding to the given JSONPaths with the default masking configuration.
JsonMaskingConfig.Builder	maskJsonPaths(Set<String> jsonPaths, KeyMaskingConfig config)	Masks all JSON values corresponding to the given JSONPaths with the given masking configuration.
JsonMaskingConfig.Builder	maskKeys(String... keys)	Masks all JSON values corresponding to the given keys with the default masking configuration.
JsonMaskingConfig.Builder	maskKeys(String key, KeyMaskingConfig config)	Masks all JSON values corresponding to the given key with the provided masking configuration.
JsonMaskingConfig.Builder	maskKeys(Map<String,KeyMaskingConfig> configs)	Masks all JSON values corresponding to the given keys with the provided masking configuration.
JsonMaskingConfig.Builder	maskKeys(Set<String> keys)	Masks all JSON values corresponding to the given keys with the default masking configuration.
JsonMaskingConfig.Builder	maskKeys(Set<String> keys, KeyMaskingConfig config)	Masks all JSON values corresponding to the given keys with the provided masking configuration.
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(String... keys)

Masks all JSON values corresponding to the given keys with the default masking configuration.

Returns:

the builder instance

maskKeys

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

Masks all JSON values corresponding to the given keys with the default masking configuration.

Returns:

the builder instance

maskKeys

public JsonMaskingConfig.Builder maskKeys(String key,
 KeyMaskingConfig config)

Masks all JSON values corresponding to the given key with the provided masking configuration.

Returns:

the builder instance

maskKeys

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

Masks all JSON values corresponding to the given keys with the provided masking configuration.

Returns:

the builder instance

maskKeys

public JsonMaskingConfig.Builder maskKeys(Map<String,KeyMaskingConfig> configs)

Masks all JSON values corresponding to the given keys with the provided masking configuration.

Returns:

the builder instance

maskJsonPaths

public JsonMaskingConfig.Builder maskJsonPaths(String... jsonPaths)

Masks all JSON values corresponding to the given JSONPaths with the default masking configuration.

Returns:

the builder instance

maskJsonPaths

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

Masks all JSON values corresponding to the given JSONPaths with the default masking configuration.

Returns:

the builder instance

maskJsonPaths

public JsonMaskingConfig.Builder maskJsonPaths(String jsonPath,
 KeyMaskingConfig config)

Masks all JSON values corresponding to the given JSONPath with the given masking configuration.

Returns:

the builder instance

maskJsonPaths

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

Masks all JSON values corresponding to the given JSONPaths with the given masking configuration.

Returns:

the builder instance

maskJsonPaths

public JsonMaskingConfig.Builder maskJsonPaths(Map<String,KeyMaskingConfig> configs)

Masks all JSON values corresponding to the given JSONPaths with the given masking configuration.

Returns:

the builder instance

allowKeys

public JsonMaskingConfig.Builder allowKeys(String... keys)

Only allow the given key to be unmasked, mask JSON values corresponding to any other key.

This method is incompatible with any mask method, except cases when a specific key(s) or JSONPath(s) needs to be masked with a specific KeyMaskingConfig masking configuration.

Returns:

the builder instance

allowKeys

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

Only allow the given keys to be unmasked, mask JSON values corresponding to any other key.

This method is incompatible with any mask method, except cases when a specific key(s) or JSONPath(s) needs to be masked with a specific KeyMaskingConfig masking configuration.

Returns:

the builder instance

allowJsonPaths

public JsonMaskingConfig.Builder allowJsonPaths(String... jsonPath)

Only allow the given JSONPath to be unmasked, mask JSON values corresponding to any other key.

This method is incompatible with any mask method, except cases when a specific key(s) or JSONPath(s) needs to be masked with a specific KeyMaskingConfig masking configuration.

Returns:

the builder instance

allowJsonPaths

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

Only allow the given JSONPaths to be unmasked, mask JSON values corresponding to any other key.

This method is incompatible with any mask method, except cases when a specific key(s) or JSONPath(s) needs to be masked with a specific KeyMaskingConfig masking configuration.

Returns:

the builder instance

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