Package dev.blaauwendraad.masker.json.config

Class JsonMaskingConfig

java.lang.Object

dev.blaauwendraad.masker.json.config.JsonMaskingConfig

public final class JsonMaskingConfig
extends Object

Contains the JSON masker configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonMaskingConfig.Builder	Builder to create JsonMaskingConfig instances using the builder pattern.
static enum	JsonMaskingConfig.TargetKeyMode	Defines how target keys should be interpreted.

Method Summary

Modifier and Type	Method	Description
static JsonMaskingConfig.Builder	builder()	Creates a new JsonMaskingConfig builder instance for JsonMaskingConfig.
boolean	caseSensitiveTargetKeys()	Tests if target keys should be considered case-sensitive.
KeyMaskingConfig	getConfig(String key)	Returns the config for the given key.
KeyMaskingConfig	getDefaultConfig()
Map<String,KeyMaskingConfig>	getKeyConfigs()	Returns a map with all masking configs per key.
Set<JsonPath>	getTargetJsonPaths()
Set<String>	getTargetKeys()
boolean	isInAllowMode()	Checks if the target key mode is set to "ALLOW".
boolean	isInMaskMode()	Checks if the target key mode is set to "MASK".
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static JsonMaskingConfig.Builder builder()

Creates a new JsonMaskingConfig builder instance for JsonMaskingConfig.

Returns:

the JsonMaskingConfig builder instance

isInAllowMode

public boolean isInAllowMode()

Checks if the target key mode is set to "ALLOW". If the mode is set to "ALLOW", it means that the target keys are interpreted as the only JSON keys for which the corresponding property is allowed (should not be masked).

Returns:

true if the target key mode is set to "ALLOW", false otherwise

isInMaskMode

public boolean isInMaskMode()

Checks if the target key mode is set to "MASK". If the mode is set to "MASK", it means that the properties corresponding to the target keys should be masked.

Returns:

true if the current target key mode is in "MASK" mode, false otherwise

getTargetKeys

public Set<String> getTargetKeys()

getTargetJsonPaths

public Set<JsonPath> getTargetJsonPaths()

caseSensitiveTargetKeys

public boolean caseSensitiveTargetKeys()

Tests if target keys should be considered case-sensitive.

Returns:

true if target keys are considered case-sensitive and false otherwise.

getConfig

public KeyMaskingConfig getConfig(String key)

Returns the config for the given key. If no specific config is available for the given key, the default config.

Parameters:

key - key to be masked

Returns:

the config for the given key

getDefaultConfig

public KeyMaskingConfig getDefaultConfig()

getKeyConfigs

public Map<String,KeyMaskingConfig> getKeyConfigs()

Returns a map with all masking configs per key.

Returns:

masking configs per key

toString

public String toString()

Overrides:

toString in class Object