Module com.github.robtimus.obfuscation.jackson.databind

Package com.github.robtimus.obfuscation.jackson.databind

Class ObfuscationModule.Builder

java.lang.Object

com.github.robtimus.obfuscation.jackson.databind.ObfuscationModule.Builder

Enclosing class:

ObfuscationModule

public static final class ObfuscationModule.Builder
extends Object

A builder for ObfuscationModules.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method	Description
ObfuscationModule	build()	Creates a new ObfuscationModule with the current settings of this builder.
ObfuscationModule.Builder	requireObfuscatorAnnotation(boolean requireObfuscatorAnnotation)	Sets whether or not to require an annotation to provide an obfuscator for List, Set, Collection and Map fields.
ObfuscationModule.Builder	withDefaultCharacterRepresentation(Class<?> type, CharacterRepresentationProvider defaultProvider)	Sets the default character representation provider to use for a specific type, in case no character representation provider could be found from annotations.
ObfuscationModule.Builder	withDefaultObfuscator(Obfuscator defaultObfuscator)	Sets the default obfuscator to use, in case no obfuscator could be found from annotations.
ObfuscationModule.Builder	withDefaultObfuscator(Class<?> type, Obfuscator defaultObfuscator)	Sets the default obfuscator to use for a specific type, in case no obfuscator could be found from annotations.
ObfuscationModule.Builder	withObjectFactory(ObjectFactory objectFactory)	Sets the object factory to use.

Methods inherited from class java.lang.Object

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

Method Details

withObjectFactory

public ObfuscationModule.Builder withObjectFactory(ObjectFactory objectFactory)

Sets the object factory to use. This method can be used to override the default object factory, for instance to use an object factory that uses a Spring bean factory or CDI lookup. The default uses ClassUtil.createInstance(Class, boolean), with MapperConfig.canOverrideAccessModifiers() providing the boolean flag.

Parameters:

objectFactory - The object factory to use, or null to use a default object factory.

Returns:

This object.

Since:

1.2

See Also:

• MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS

withDefaultObfuscator

public ObfuscationModule.Builder withDefaultObfuscator(Obfuscator defaultObfuscator)

Sets the default obfuscator to use, in case no obfuscator could be found from annotations. The default is Obfuscator.fixedLength(3).

Parameters:

defaultObfuscator - The default obfuscator to use.

Returns:

This object.

Throws:

NullPointerException - If the given obfuscator is null.

withDefaultObfuscator

public ObfuscationModule.Builder withDefaultObfuscator(Class<?> type,
 Obfuscator defaultObfuscator)

Sets the default obfuscator to use for a specific type, in case no obfuscator could be found from annotations. This type should be the generic type of any Obfuscated, List, Set, Collection or Map. It doesn't need to be the exact type; it can also be a super class or implemented interface.

Parameters:

type - The type to set the default obfuscator for.

defaultObfuscator - The default obfuscator to use.

Returns:

This object.

Throws:

NullPointerException - If the given type or obfuscator is null.

Since:

1.1

requireObfuscatorAnnotation

public ObfuscationModule.Builder requireObfuscatorAnnotation(boolean requireObfuscatorAnnotation)

Sets whether or not to require an annotation to provide an obfuscator for List, Set, Collection and Map fields. If not, then any List, Set, Collection and Map field with a generic type for which a default obfuscator was specified will be obfuscated during deserialization. The default is false.

Parameters:

requireObfuscatorAnnotation - true to require an annotation to provide an obfuscator, or false to use default obfuscators if present.

Returns:

This object.

Since:

1.1

withDefaultCharacterRepresentation

public ObfuscationModule.Builder withDefaultCharacterRepresentation(Class<?> type,
 CharacterRepresentationProvider defaultProvider)

Sets the default character representation provider to use for a specific type, in case no character representation provider could be found from annotations. This type should be the generic type of any Obfuscated, List, Set, Collection or Map. It doesn't need to be the exact type; it can also be a super class or implemented interface.

By default, the following character representation providers are already registered:

• CharacterRepresentationProvider.BooleanArrayToString for boolean[]
• CharacterRepresentationProvider.CharArrayToString for char[]
• CharacterRepresentationProvider.ByteArrayToString for byte[]
• CharacterRepresentationProvider.ShortArrayToString for short[]
• CharacterRepresentationProvider.IntArrayToString for int[]
• CharacterRepresentationProvider.LongArrayToString for long[]
• CharacterRepresentationProvider.FloatArrayToString for float[]
• CharacterRepresentationProvider.DoubleArrayToString for double[]
• CharacterRepresentationProvider.ObjectArrayToString for Object[]

Parameters:

type - The type to set the default obfuscator for.

defaultProvider - The default character representation provider to use.

Returns:

This object.

Throws:

NullPointerException - If the given type or character representation provider is null.

Since:

1.1

build

public ObfuscationModule build()

Creates a new ObfuscationModule with the current settings of this builder.

Returns:

The created ObfuscationModule.