Index

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Serialized Form

A

ALLOW - Enum constant in enum class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.TargetKeyMode

In this mode, target keys are interpreted as the only JSON keys for which the corresponding property is allowed (should not be masked).

allowJsonPaths(Set<String>) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

allowKeys(Set<String>) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

AsciiCharacter - Enum Class in dev.blaauwendraad.masker.json.util

ASCII encoding characters and utility methods.

AsciiJsonUtil - Class in dev.blaauwendraad.masker.json.util

asString(int, int) - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Returns a string representation of the original JSON value.

ASTERISK - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

B

BACK_SLASH - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

build() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Creates a new JsonMaskingConfig instance.

build() - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Builds the KeyMaskingConfig instance.

builder() - Static method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Creates a new JsonMaskingConfig builder instance for JsonMaskingConfig.

builder() - Static method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig

Creates a new KeyMaskingConfig.Builder instance for KeyMaskingConfig.

byteLength() - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Returns the length of the original value that is being masked in bytes.

C

CARRIAGE_RETURN - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

caseSensitiveTargetKeys() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Configures whether the target keys are considered case-sensitive (e.g.

caseSensitiveTargetKeys() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Tests if target keys should be considered case-sensitive.

checkAmbiguity(Set<JsonPath>) - Method in class dev.blaauwendraad.masker.json.path.JsonPathParser

Validates if the input set of JSONPath queries is ambiguous.

COLON - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

COMMA - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

countNonVisibleCharacters(byte[], int, int) - Static method in class dev.blaauwendraad.masker.json.util.Utf8Util

Counts the number of non-visible characters inside the string.

countNonVisibleCharacters(int, int) - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Returns the number of non-visible, human-readable characters in the original value.

CURLY_BRACKET_CLOSE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

CURLY_BRACKET_OPEN - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

D

describe(String, T) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Provides information about the ValueMasker implementation.

dev.blaauwendraad.masker.json - package dev.blaauwendraad.masker.json

dev.blaauwendraad.masker.json.config - package dev.blaauwendraad.masker.json.config

dev.blaauwendraad.masker.json.path - package dev.blaauwendraad.masker.json.path

dev.blaauwendraad.masker.json.util - package dev.blaauwendraad.masker.json.util

DOUBLE_QUOTE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

E

eachCharacterWith(String) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks all characters of a target string value with a static string value.

eachDigitWith(int) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks all digits of a target numeric value with a static digit.

eachDigitWith(String) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks all digits of a target numeric value with a static String (which can also be a single character).

EIGHT - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

email(int, int, boolean, String) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target string value (containing an email) while keeping some number of the prefix or suffix characters and the ability to keep the domain unmasked.

equals(Object) - Method in record class dev.blaauwendraad.masker.json.path.JsonPath

Indicates whether some other object is "equal to" this one.

F

FIVE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

FOUR - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

G

getAsciiByteValue() - Method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Get the corresponding ASCII encoding byte value.

getBooleanValueMasker() - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig

Returns a ValueMasker to mask a number value.

getByte(int) - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Retrieve the byte at the given index in the original value that is being masked.

getCodePointByteLength(byte) - Static method in class dev.blaauwendraad.masker.json.util.Utf8Util

UTF-8: variable width 1-4 byte code points: 1 byte: 0xxxxxxx 2 bytes: 110xxxxx 10xxxxxx 3 bytes: 1110xxxx 10xxxxxx 10xxxxxx 4 bytes: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

getConfig(String) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Returns the config for the given key.

getDefaultConfig() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

getKeyConfigs() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Returns a map with all masking configs per key.

getMasker(JsonMaskingConfig) - Static method in interface dev.blaauwendraad.masker.json.JsonMasker

Creates a JsonMasker with the provided JsonMaskingConfig.

getMasker(Set<String>) - Static method in interface dev.blaauwendraad.masker.json.JsonMasker

Creates a default JsonMasker with the provided target key(s).

getNumberValueMasker() - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig

Returns a ValueMasker to mask a number value.

getQueryArgument() - Method in record class dev.blaauwendraad.masker.json.path.JsonPath

The last segment of the jsonpath key is an actual target key.

getStringValueMasker() - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig

Returns a ValueMasker to mask a string value.

getTargetJsonPaths() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

getTargetKeys() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

H

hashCode() - Method in record class dev.blaauwendraad.masker.json.path.JsonPath

Returns a hash code value for this object.

HORIZONTAL_TAB - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

I

invalidJson(String, int) - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Create an InvalidJsonException with the given message and index relative to the value (i.e.

InvalidJsonException - Exception in dev.blaauwendraad.masker.json

Calling any of the mask methods of the JsonMasker can result in two cases: In case valid JSON was provided, valid JSON is returned according to the provided masking configurations In case invalid JSON was provided, the exception defined in this class is thrown

InvalidJsonException(String) - Constructor for exception dev.blaauwendraad.masker.json.InvalidJsonException

InvalidJsonException(String, Throwable) - Constructor for exception dev.blaauwendraad.masker.json.InvalidJsonException

isCurlyBracketClose(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to a closing curly bracket '}' in ASCII encoding.

isCurlyBracketOpen(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to an opening curly bracket '{}' in ASCII encoding.

isDoubleQuote(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to a double quote '"' in ASCII encoding.

isEscapeCharacter(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to an escape character (backslash) '\' in ASCII encoding.

isInAllowMode() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Checks if the target key mode is set to "ALLOW".

isInMaskMode() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

Checks if the target key mode is set to "MASK".

isLowercaseT(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to a lower case t 't' in ASCII encoding.

isLowercaseU(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to a lowercase 'u' in ASCII encoding.

isNumericCharacter(byte) - Static method in class dev.blaauwendraad.masker.json.util.AsciiJsonUtil

isSquareBracketClose(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to a closing square bracket ']' in ASCII encoding.

isSquareBracketOpen(byte) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Tests if the given byte corresponds to an opening square bracket '[' in ASCII encoding.

isWhiteSpace(byte) - Static method in class dev.blaauwendraad.masker.json.util.AsciiJsonUtil

J

JsonMasker - Interface in dev.blaauwendraad.masker.json

Masker that can be used to mask JSON objects and arrays.

JsonMaskingConfig - Class in dev.blaauwendraad.masker.json.config

Contains the JSON masker configurations.

JsonMaskingConfig.Builder - Class in dev.blaauwendraad.masker.json.config

Builder to create JsonMaskingConfig instances using the builder pattern.

JsonMaskingConfig.TargetKeyMode - Enum Class in dev.blaauwendraad.masker.json.config

Defines how target keys should be interpreted.

JsonPath - Record Class in dev.blaauwendraad.masker.json.path

The library represents a jsonpath as an array of segments.

JsonPath(String[]) - Constructor for record class dev.blaauwendraad.masker.json.path.JsonPath

Creates an instance of a JsonPath record class.

JsonPathParser - Class in dev.blaauwendraad.masker.json.path

Parses a jsonpath literal into a JsonPath object.

JsonPathParser() - Constructor for class dev.blaauwendraad.masker.json.path.JsonPathParser

K

KeyMaskingConfig - Class in dev.blaauwendraad.masker.json.config

KeyMaskingConfig.Builder - Class in dev.blaauwendraad.masker.json.config

L

LINE_FEED - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_A - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_E - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_F - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_L - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_N - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_R - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_S - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_T - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

LOWERCASE_U - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

M

mask(byte[]) - Method in interface dev.blaauwendraad.masker.json.JsonMasker

Masks the given JSON input and returns the masked output.

mask(String) - Method in interface dev.blaauwendraad.masker.json.JsonMasker

Masks the given JSON input and returns the masked output.

MASK - Enum constant in enum class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.TargetKeyMode

In the mode, target keys are interpreted as the only JSON keys for which the corresponding property should be masked.

maskBooleansWith(boolean) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all boolean values with the provided value.

maskBooleansWith(boolean) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all boolean values with the provided value.

maskBooleansWith(ValueMasker.BooleanMasker) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all boolean values with the provided ValueMasker.

maskBooleansWith(ValueMasker.BooleanMasker) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all boolean values with the provided ValueMasker.

maskBooleansWith(String) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all boolean values with the provided value.

maskBooleansWith(String) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all boolean values with the provided value.

maskJsonPaths(Set<String>) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

maskJsonPaths(Set<String>, KeyMaskingConfig) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

maskKeys(Set<String>) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

maskKeys(Set<String>, KeyMaskingConfig) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

maskNumberDigitsWith(int) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all digits of number values with the provided digit, preserving the length.

maskNumberDigitsWith(int) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all digits of numeric values with the provided digit, preserving the length.

maskNumbersWith(int) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all number values with the provided value.

maskNumbersWith(int) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all numeric values with the provided value.

maskNumbersWith(ValueMasker.NumberMasker) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all numeric values with the provided ValueMasker.

maskNumbersWith(ValueMasker.NumberMasker) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all numeric values with the provided ValueMasker.

maskNumbersWith(String) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all number values with the provided value.

maskNumbersWith(String) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all numeric values with the provided value.

maskStringCharactersWith(String) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all characters of string values with the provided character, preserving the length.

maskStringCharactersWith(String) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all characters of string values with the provided character, preserving the length.

maskStringsWith(ValueMasker.StringMasker) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all string values with the provided ValueMasker.

maskStringsWith(ValueMasker.StringMasker) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all string values with the provided ValueMasker.

maskStringsWith(String) - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.Builder

Mask all string values with the provided value.

maskStringsWith(String) - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig.Builder

Mask all string values with the provided value.

maskValue(ValueMaskerContext) - Method in interface dev.blaauwendraad.masker.json.ValueMasker

Used for masking JSON values.

MINUS - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

N

NINE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

noop() - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Does not mask a target value (no-operation).

O

ONE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

P

parse(String) - Method in class dev.blaauwendraad.masker.json.path.JsonPathParser

Parses an input literal into a JsonPath object.

PERIOD - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

PLUS - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

R

replaceBytes(int, int, byte[], int) - Method in interface dev.blaauwendraad.masker.json.ValueMaskerContext

Indicates that the bytes of the original value (or part of the value) needs to be replaced with a mask.

S

segments() - Method in record class dev.blaauwendraad.masker.json.path.JsonPath

Returns the value of the segments record component.

SEVEN - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

SIX - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

SPACE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

SQUARE_BRACKET_CLOSE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

SQUARE_BRACKET_OPEN - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

T

THREE - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

toString() - Method in class dev.blaauwendraad.masker.json.config.JsonMaskingConfig

toString() - Method in class dev.blaauwendraad.masker.json.config.KeyMaskingConfig

toString() - Method in record class dev.blaauwendraad.masker.json.path.JsonPath

Returns a string representation of this record class.

tryParse(String) - Method in class dev.blaauwendraad.masker.json.path.JsonPathParser

Parses an input literal into a JsonPath object.

TWO - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

U

unicodeHexToChar(byte, byte, byte, byte) - Static method in class dev.blaauwendraad.masker.json.util.Utf8Util

Converts a 4-byte UTF-8 encoded character ('') into a char.

UPPERCASE_E - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Utf8Util - Class in dev.blaauwendraad.masker.json.util

UTF-8 encoding utilities class

V

ValueMasker - Interface in dev.blaauwendraad.masker.json

A functional interface which enables masking JSON values (boolean, numbers, and strings) in almost every imaginable way.

ValueMasker.AnyValueMasker - Interface in dev.blaauwendraad.masker.json

ValueMasker that can mask any JSON value (string, number or a boolean).

ValueMasker.BooleanMasker - Interface in dev.blaauwendraad.masker.json

ValueMasker that can mask JSON boolean values.

ValueMasker.NumberMasker - Interface in dev.blaauwendraad.masker.json

ValueMasker that can mask JSON number values.

ValueMasker.StringMasker - Interface in dev.blaauwendraad.masker.json

ValueMasker that can mask JSON string values.

ValueMaskerContext - Interface in dev.blaauwendraad.masker.json

Represents the original value that is currently being masked.

ValueMaskers - Class in dev.blaauwendraad.masker.json

Provides out-of-the-box implementations of ValueMasker.

valueOf(String) - Static method in enum class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.TargetKeyMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Returns the enum constant of this class with the specified name.

values() - Static method in enum class dev.blaauwendraad.masker.json.config.JsonMaskingConfig.TargetKeyMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

Returns an array containing the constants of this enum class, in the order they are declared.

W

with(boolean) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value with a static boolean value.

with(int) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value with a static integer value.

with(String) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value with a static string value.

withNull() - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value with null.

withRawValueFunction(Function<String, String>) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value with the provided Function.

withTextFunction(Function<String, String>) - Static method in class dev.blaauwendraad.masker.json.ValueMaskers

Masks a target value by applying the provided Function on the textual representation of the original value.

Z

ZERO - Enum constant in enum class dev.blaauwendraad.masker.json.util.AsciiCharacter

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Serialized Form