com.github.robtimus.obfuscation.json

Class JSONObfuscator.Builder

java.lang.Object

com.github.robtimus.obfuscation.json.JSONObfuscator.Builder

Direct Known Subclasses:

JSONObfuscator.PropertyConfigurer

Enclosing class:

JSONObfuscator

public abstract static class JSONObfuscator.Builder
extends Object

A builder for JSONObfuscators.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
JSONObfuscator.Builder	allByDefault() Indicates that by default properties will be obfuscated if they are JSON objects or arrays (default).
abstract JSONObfuscator	build() Creates a new JSONObfuscator with the properties and obfuscators added to this builder.
abstract JSONObfuscator.Builder	caseInsensitiveByDefault() Sets the default case sensitivity for new properties to CaseSensitivity.CASE_INSENSITIVE.
abstract JSONObfuscator.Builder	caseSensitiveByDefault() Sets the default case sensitivity for new properties to CaseSensitivity.CASE_SENSITIVE.
abstract JSONObfuscator.Builder	excludeArraysByDefault() Indicates that by default properties will not be obfuscated if they are JSON arrays.
abstract JSONObfuscator.Builder	excludeObjectsByDefault() Indicates that by default properties will not be obfuscated if they are JSON objects.
abstract JSONObfuscator.Builder	includeArraysByDefault() Indicates that by default properties will be obfuscated if they are JSON arrays (default).
abstract JSONObfuscator.Builder	includeObjectsByDefault() Indicates that by default properties will be obfuscated if they are JSON objects (default).
abstract JSONObfuscator.Builder	produceValidJSON() If called, obfuscation produces valid JSON, provided the input is valid JSON.
JSONObfuscator.Builder	scalarsOnlyByDefault() Indicates that by default properties will not be obfuscated if they are JSON objects or arrays.
<R> R	transform(Function<? super JSONObfuscator.Builder,? extends R> f) This method allows the application of a function to this builder.
abstract JSONObfuscator.Builder	withMalformedJSONWarning(String warning) Sets the warning to include if a JsonParsingException is thrown.
abstract JSONObfuscator.Builder	withPrettyPrinting(boolean prettyPrint) Sets whether or not to pretty-print obfuscated JSON.
abstract JSONObfuscator.PropertyConfigurer	withProperty(String property, Obfuscator obfuscator) Adds a property to obfuscate.
abstract JSONObfuscator.PropertyConfigurer	withProperty(String property, Obfuscator obfuscator, CaseSensitivity caseSensitivity) Adds a property to obfuscate.

Methods inherited from class java.lang.Object

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

Method Detail

withProperty

public abstract 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

public abstract 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

public abstract 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

public abstract 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

public 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

public abstract JSONObfuscator.Builder excludeObjectsByDefault()

Indicates that by default properties will not be obfuscated if they are JSON objects. This can be overridden per property using JSONObfuscator.PropertyConfigurer.includeObjects()

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

Returns:

This object.

excludeArraysByDefault

public abstract JSONObfuscator.Builder excludeArraysByDefault()

Indicates that by default properties will not be obfuscated if they are JSON arrays. This can be overridden per property using JSONObfuscator.PropertyConfigurer.includeArrays()

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

Returns:

This object.

allByDefault

public 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

public abstract JSONObfuscator.Builder includeObjectsByDefault()

Indicates that by default properties will be obfuscated if they are JSON objects (default). This can be overridden per property using JSONObfuscator.PropertyConfigurer.excludeObjects()

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

Returns:

This object.

includeArraysByDefault

public abstract JSONObfuscator.Builder includeArraysByDefault()

Indicates that by default properties will be obfuscated if they are JSON arrays (default). This can be overridden per property using JSONObfuscator.PropertyConfigurer.excludeArrays()

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

Returns:

This object.

withPrettyPrinting

public abstract JSONObfuscator.Builder withPrettyPrinting(boolean prettyPrint)

Sets whether or not to pretty-print obfuscated JSON. The default is true.

Parameters:

prettyPrint - true to pretty-print obfuscated JSON, or false otherwise.

Returns:

This object.

produceValidJSON

public abstract JSONObfuscator.Builder produceValidJSON()

If called, obfuscation produces valid JSON, provided the input is valid JSON. This is done by converting obfuscated values to strings. For values that were already strings this changes nothing.

An exception is made for Obfuscator.none(). This still allows skipping obfuscating values inside certain properties.

Note that if obfuscated objects or arrays are converted to strings, any line breaks that remain after obfuscation will be escaped.

Returns:

This object.

withMalformedJSONWarning

public abstract JSONObfuscator.Builder withMalformedJSONWarning(String warning)

Sets the warning to include if a JsonParsingException 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.

transform

public <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

public abstract JSONObfuscator build()

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

Returns:

The created JSONObfuscator.