Module com.github.robtimus.obfuscation.jackson

Package com.github.robtimus.obfuscation.jackson

Interface JSONObfuscator.PropertyConfigurer

All Superinterfaces:

JSONObfuscator.Builder

Enclosing class:

JSONObfuscator

public static interface JSONObfuscator.PropertyConfigurer
extends JSONObfuscator.Builder

An object that can be used to configure a property that should be obfuscated.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	JSONObfuscator.PropertyConfigurer.ObfuscationMode	The possible ways to deal with nested objects and arrays.

Method Summary

Modifier and Type	Method	Description
default JSONObfuscator.PropertyConfigurer	all()	Indicates that properties with the current name will be obfuscated if they are JSON objects or arrays.
default JSONObfuscator.PropertyConfigurer	excludeArrays()	Indicates that properties with the current name will not be obfuscated if they are JSON arrays.
default JSONObfuscator.PropertyConfigurer	excludeObjects()	Indicates that properties with the current name will not be obfuscated if they are JSON objects.
JSONObfuscator.PropertyConfigurer	forArrays(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)	Indicates how to handle properties if they are JSON arrays.
JSONObfuscator.PropertyConfigurer	forObjects(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)	Indicates how to handle properties if they are JSON objects.
default JSONObfuscator.PropertyConfigurer	includeArrays()	Indicates that properties with the current name will be obfuscated if they are JSON arrays.
default JSONObfuscator.PropertyConfigurer	includeObjects()	Indicates that properties with the current name will be obfuscated if they are JSON objects.
default JSONObfuscator.PropertyConfigurer	scalarsOnly()	Indicates that properties with the current name will not be obfuscated if they are JSON objects or arrays.

Methods inherited from interface com.github.robtimus.obfuscation.jackson.JSONObfuscator.Builder

allByDefault, build, caseInsensitiveByDefault, caseSensitiveByDefault, excludeArraysByDefault, excludeObjectsByDefault, forArraysByDefault, forObjectsByDefault, includeArraysByDefault, includeObjectsByDefault, limitTo, scalarsOnlyByDefault, transform, withJacksonVersion, withMalformedJSONWarning, withProperty, withProperty

Method Details

scalarsOnly

default JSONObfuscator.PropertyConfigurer scalarsOnly()

Indicates that properties with the current name will not be obfuscated if they are JSON objects or arrays. This method is shorthand for calling both excludeObjects() and excludeArrays().

Returns:

This object.

excludeObjects

default JSONObfuscator.PropertyConfigurer excludeObjects()

Indicates that properties with the current name will not be obfuscated if they are JSON objects. This method is an alias for forObjects(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.EXCLUDE.

Returns:

This object.

excludeArrays

default JSONObfuscator.PropertyConfigurer excludeArrays()

Indicates that properties with the current name will not be obfuscated if they are JSON arrays. This method is an alias for forArrays(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.EXCLUDE.

Returns:

This object.

all

default JSONObfuscator.PropertyConfigurer all()

Indicates that properties with the current name will be obfuscated if they are JSON objects or arrays. This method is shorthand for calling both includeObjects() and includeArrays().

Returns:

This object.

includeObjects

default JSONObfuscator.PropertyConfigurer includeObjects()

Indicates that properties with the current name will be obfuscated if they are JSON objects. This method is an alias for forObjects(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Returns:

This object.

includeArrays

default JSONObfuscator.PropertyConfigurer includeArrays()

Indicates that properties with the current name will be obfuscated if they are JSON arrays. This method is an alias for forArrays(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Returns:

This object.

forObjects

JSONObfuscator.PropertyConfigurer forObjects(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle properties if they are JSON objects. The default is JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Parameters:

obfuscationMode - The obfuscation mode that determines how to handle properties.

Returns:

This object.

Throws:

NullPointerException - If the given obfuscation mode is null.

Since:

1.3

forArrays

JSONObfuscator.PropertyConfigurer forArrays(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle properties if they are JSON arrays. The default is JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Parameters:

obfuscationMode - The obfuscation mode that determines how to handle properties.

Returns:

This object.

Throws:

NullPointerException - If the given obfuscation mode is null.

Since:

1.3