Module com.github.robtimus.obfuscation.jackson

Package com.github.robtimus.obfuscation.jackson

Interface JSONObfuscator.Builder

All Known Subinterfaces:

JSONObfuscator.LimitConfigurer, JSONObfuscator.PropertyConfigurer

Enclosing class:

JSONObfuscator

public static interface JSONObfuscator.Builder

A builder for JSONObfuscators.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method	Description
default JSONObfuscator.Builder	allByDefault()	Indicates that by default properties will be obfuscated if they are JSON objects or arrays (default).
JSONObfuscator	build()	Creates a new JSONObfuscator with the properties and obfuscators added to this builder.
JSONObfuscator.Builder	caseInsensitiveByDefault()	Sets the default case sensitivity for new properties to CaseSensitivity.CASE_INSENSITIVE.
JSONObfuscator.Builder	caseSensitiveByDefault()	Sets the default case sensitivity for new properties to CaseSensitivity.CASE_SENSITIVE.
default JSONObfuscator.Builder	excludeArraysByDefault()	Indicates that by default properties will not be obfuscated if they are JSON arrays.
default JSONObfuscator.Builder	excludeObjectsByDefault()	Indicates that by default properties will not be obfuscated if they are JSON objects.
JSONObfuscator.Builder	forArraysByDefault(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)	Indicates how to handle properties if they are JSON arrays.
JSONObfuscator.Builder	forObjectsByDefault(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)	Indicates how to handle properties if they are JSON objects.
default JSONObfuscator.Builder	includeArraysByDefault()	Indicates that by default properties will be obfuscated if they are JSON arrays (default).
default JSONObfuscator.Builder	includeObjectsByDefault()	Indicates that by default properties will be obfuscated if they are JSON objects (default).
JSONObfuscator.LimitConfigurer	limitTo(long limit)	Sets the limit for the obfuscated result.
default JSONObfuscator.Builder	scalarsOnlyByDefault()	Indicates that by default properties will not be obfuscated if they are JSON objects or arrays.
default <R> R	transform(Function<? super JSONObfuscator.Builder,? extends R> f)	This method allows the application of a function to this builder.
JSONObfuscator.Builder	withJacksonVersion(JacksonVersion jacksonVersion)	Sets the Jackson version to use.
JSONObfuscator.Builder	withMalformedJSONWarning(String warning)	Sets the warning to include if a StreamReadException is thrown.
JSONObfuscator.PropertyConfigurer	withProperty(String property, Obfuscator obfuscator)	Adds a property to obfuscate.
JSONObfuscator.PropertyConfigurer	withProperty(String property, Obfuscator obfuscator, CaseSensitivity caseSensitivity)	Adds a property to obfuscate.

Method Details

withProperty

JSONObfuscator.PropertyConfigurer withProperty(String property,
 Obfuscator obfuscator)

Adds a property to obfuscate. This method is an alias for withProperty(String, Obfuscator, CaseSensitivity) with the last specified default case sensitivity using caseSensitiveByDefault() or caseInsensitiveByDefault(). The default is CaseSensitivity.CASE_SENSITIVE.

Parameters:

property - The name of the property.

obfuscator - The obfuscator to use for obfuscating the property.

Returns:

An object that can be used to configure the property, or continue building JSONObfuscators.

Throws:

NullPointerException - If the given property name or obfuscator is null.

IllegalArgumentException - If a property with the same name and the same case sensitivity was already added.

withProperty

JSONObfuscator.PropertyConfigurer withProperty(String property,
 Obfuscator obfuscator,
 CaseSensitivity caseSensitivity)

Adds a property to obfuscate.

Parameters:

property - The name of the property.

obfuscator - The obfuscator to use for obfuscating the property.

caseSensitivity - The case sensitivity for the property.

Returns:

An object that can be used to configure the property, or continue building JSONObfuscators.

Throws:

NullPointerException - If the given property name, obfuscator or case sensitivity is null.

IllegalArgumentException - If a property with the same name and the same case sensitivity was already added.

caseSensitiveByDefault

JSONObfuscator.Builder caseSensitiveByDefault()

Sets the default case sensitivity for new properties to CaseSensitivity.CASE_SENSITIVE. This is the default setting.

Note that this will not change the case sensitivity of any property that was already added.

Returns:

This object.

caseInsensitiveByDefault

JSONObfuscator.Builder caseInsensitiveByDefault()

Sets the default case sensitivity for new properties to CaseSensitivity.CASE_INSENSITIVE.

Note that this will not change the case sensitivity of any property that was already added.

Returns:

This object.

scalarsOnlyByDefault

default JSONObfuscator.Builder scalarsOnlyByDefault()

Indicates that by default properties will not be obfuscated if they are JSON objects or arrays. This method is shorthand for calling both excludeObjectsByDefault() and excludeArraysByDefault().

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

excludeObjectsByDefault

default JSONObfuscator.Builder excludeObjectsByDefault()

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

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

excludeArraysByDefault

default JSONObfuscator.Builder excludeArraysByDefault()

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

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

allByDefault

default JSONObfuscator.Builder allByDefault()

Indicates that by default properties will be obfuscated if they are JSON objects or arrays (default). This method is shorthand for calling both includeObjectsByDefault() and includeArraysByDefault().

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

includeObjectsByDefault

default JSONObfuscator.Builder includeObjectsByDefault()

Indicates that by default properties will be obfuscated if they are JSON objects (default). This method is an alias for forObjectsByDefault(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

includeArraysByDefault

default JSONObfuscator.Builder includeArraysByDefault()

Indicates that by default properties will be obfuscated if they are JSON arrays (default). This method is an alias for forArraysByDefault(ObfuscationMode) in combination with JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE.

Note that this will not change what will be obfuscated for any property that was already added.

Returns:

This object.

forObjectsByDefault

JSONObfuscator.Builder forObjectsByDefault(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle properties if they are JSON objects. The default is JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE. This can be overridden per property using JSONObfuscator.PropertyConfigurer.forObjects(ObfuscationMode)

Note that this will not change what will be obfuscated for any property that was already added.

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

forArraysByDefault

JSONObfuscator.Builder forArraysByDefault(JSONObfuscator.PropertyConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle properties if they are JSON arrays. The default is JSONObfuscator.PropertyConfigurer.ObfuscationMode.OBFUSCATE. This can be overridden per property using JSONObfuscator.PropertyConfigurer.forArrays(ObfuscationMode)

Note that this will not change what will be obfuscated for any property that was already added.

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

withMalformedJSONWarning

JSONObfuscator.Builder withMalformedJSONWarning(String warning)

Sets the warning to include if a StreamReadException is thrown. This can be used to override the default message. Use null to omit the warning.

Parameters:

warning - The warning to include.

Returns:

This object.

withJacksonVersion

JSONObfuscator.Builder withJacksonVersion(JacksonVersion jacksonVersion)

Sets the Jackson version to use. This method should only be called if more than one Jackson version is available.

If a version is set that is not available, calling build() will fail.

Parameters:

jacksonVersion - The Jackson version to use.

Returns:

This object.

Throws:

NullPointerException - If the given Jackson version is null.

Since:

2.0

limitTo

JSONObfuscator.LimitConfigurer limitTo(long limit)

Sets the limit for the obfuscated result.

Parameters:

limit - The limit to use.

Returns:

An object that can be used to configure the handling when the obfuscated result exceeds a pre-defined limit, or continue building JSONObfuscators.

Throws:

IllegalArgumentException - If the given limit is negative.

Since:

1.1

transform

default <R> R transform(Function<? super JSONObfuscator.Builder,? extends R> f)

This method allows the application of a function to this builder.

Any exception thrown by the function will be propagated to the caller.

Type Parameters:

R - The type of the result of the function.

Parameters:

f - The function to apply.

Returns:

The result of applying the function to this builder.

build

JSONObfuscator build()

Creates a new JSONObfuscator with the properties and obfuscators added to this builder.

Returns:

The created JSONObfuscator.