com.github.robtimus.obfuscation.xml

Interface XMLObfuscator.Builder

All Known Subinterfaces:

XMLObfuscator.AttributeConfigurer, XMLObfuscator.ElementConfigurer, XMLObfuscator.LimitConfigurer

Enclosing class:

XMLObfuscator

public static interface XMLObfuscator.Builder

A builder for XMLObfuscators.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
default XMLObfuscator.Builder	allByDefault() Indicates that by default nested elements will be obfuscated (default).
XMLObfuscator	build() Creates a new XMLObfuscator with the elements and obfuscators added to this builder.
XMLObfuscator.Builder	caseInsensitiveByDefault() Sets the default case sensitivity for new elements and attributes to CaseSensitivity.CASE_INSENSITIVE.
XMLObfuscator.Builder	caseSensitiveByDefault() Sets the default case sensitivity for new elements and attributes to CaseSensitivity.CASE_SENSITIVE.
default XMLObfuscator.Builder	excludeNestedElementsByDefault() Indicates that by default nested elements will not be obfuscated.
XMLObfuscator.Builder	forNestedElementsByDefault(XMLObfuscator.ElementConfigurer.ObfuscationMode obfuscationMode) Indicates how to handle nested elements.
XMLObfuscator.Builder	generateXML() Indicates that XML obfuscators will always generate new, obfuscated documents.
default XMLObfuscator.Builder	includeNestedElementsByDefault() Indicates that by default nested elements will be obfuscated (default).
XMLObfuscator.LimitConfigurer	limitTo(long limit) Sets the limit for the obfuscated result.
default XMLObfuscator.Builder	textOnlyByDefault() Indicates that by default nested elements will not be obfuscated.
default <R> R	transform(Function<? super XMLObfuscator.Builder,? extends R> f) This method allows the application of a function to this builder.
XMLObfuscator.AttributeConfigurer	withAttribute(QName attribute, Obfuscator obfuscator) Adds an attribute to obfuscate.
XMLObfuscator.AttributeConfigurer	withAttribute(String attribute, Obfuscator obfuscator) Adds an attribute to obfuscate.
XMLObfuscator.AttributeConfigurer	withAttribute(String attribute, Obfuscator obfuscator, CaseSensitivity caseSensitivity) Adds an attribute to obfuscate.
XMLObfuscator.ElementConfigurer	withElement(QName element, Obfuscator obfuscator) Adds an element to obfuscate.
XMLObfuscator.ElementConfigurer	withElement(String element, Obfuscator obfuscator) Adds an element to obfuscate.
XMLObfuscator.ElementConfigurer	withElement(String element, Obfuscator obfuscator, CaseSensitivity caseSensitivity) Adds an element to obfuscate.
XMLObfuscator.Builder	withMalformedXMLWarning(String warning) Sets the warning to include if an XMLStreamException is thrown.

Method Detail

withElement

XMLObfuscator.ElementConfigurer withElement(String element,
                                            Obfuscator obfuscator)

Adds an element to obfuscate.

This method is an alias for withElement(String, Obfuscator, CaseSensitivity) with the last specified default case sensitivity using caseSensitiveByDefault() or caseInsensitiveByDefault(). The default is CaseSensitivity.CASE_SENSITIVE.

Parameters:

element - The local name of the element.

obfuscator - The obfuscator to use for obfuscating the element.

Returns:

An object that can be used to configure the element, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an element with the same local name and the same case sensitivity was already added.

withElement

XMLObfuscator.ElementConfigurer withElement(String element,
                                            Obfuscator obfuscator,
                                            CaseSensitivity caseSensitivity)

Adds an element to obfuscate.

Parameters:

element - The local name of the element.

obfuscator - The obfuscator to use for obfuscating the element.

caseSensitivity - The case sensitivity for the element.

Returns:

An object that can be used to configure the element, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an element with the same local name and the same case sensitivity was already added.

withElement

XMLObfuscator.ElementConfigurer withElement(QName element,
                                            Obfuscator obfuscator)

Adds an element to obfuscate. Any element added using this method will take precedence over elements added using withElement(String, Obfuscator) or withElement(String, Obfuscator, CaseSensitivity).

Parameters:

element - The qualified name of the element.

obfuscator - The obfuscator to use for obfuscating the element.

Returns:

An object that can be used to configure the element, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an element with the same qualified name was already added.

withAttribute

XMLObfuscator.AttributeConfigurer withAttribute(String attribute,
                                                Obfuscator obfuscator)

Adds an attribute to obfuscate. This will cause any occurrence of the attribute to be obfuscated, regardless of their elements. The returned object can be used to define obfuscators for occurrences of the attribute in specific elements.

This method is an alias for withAttribute(String, Obfuscator, CaseSensitivity) with the last specified default case sensitivity using caseSensitiveByDefault() or caseInsensitiveByDefault(). The default is CaseSensitivity.CASE_SENSITIVE.

Note: because locations of attributes are not easily available, XML obfuscators will generate new, obfuscated documents when attributes need to be obfuscated.

Parameters:

attribute - The local name of the attribute.

obfuscator - The obfuscator to use for obfuscating the attribute.

Returns:

An object that can be used to configure the attribute, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an attribute with the same local name and the same case sensitivity was already added.

Since:

1.2

withAttribute

XMLObfuscator.AttributeConfigurer withAttribute(String attribute,
                                                Obfuscator obfuscator,
                                                CaseSensitivity caseSensitivity)

Adds an attribute to obfuscate. This will cause any occurrence of the attribute to be obfuscated, regardless of their elements. The returned object can be used to define obfuscators for occurrences of the attribute in specific elements.

Note: because locations of attributes are not easily available, XML obfuscators will generate new, obfuscated documents when attributes need to be obfuscated.

Parameters:

attribute - The local name of the attribute.

obfuscator - The obfuscator to use for obfuscating the attribute.

caseSensitivity - The case sensitivity for the attribute.

Returns:

An object that can be used to configure the attribute, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an attribute with the same local name and the same case sensitivity was already added.

Since:

1.2

withAttribute

XMLObfuscator.AttributeConfigurer withAttribute(QName attribute,
                                                Obfuscator obfuscator)

Adds an attribute to obfuscate. This will cause any occurrence of the attribute to be obfuscated, regardless of their elements. The returned object can be used to define obfuscators for occurrences of the attribute in specific elements. Any attribute added using this method will take precedence over attributes added using withAttribute(String, Obfuscator) or withAttribute(String, Obfuscator, CaseSensitivity).

Note: because locations of attributes are not easily available, XML obfuscators will generate new, obfuscated documents when attributes need to be obfuscated.

Parameters:

attribute - The qualified name of the attribute.

obfuscator - The obfuscator to use for obfuscating the attribute.

Returns:

An object that can be used to configure the attribute, or continue building XMLObfuscators.

Throws:

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

IllegalArgumentException - If an attribute with the same qualified name was already added.

Since:

1.2

caseSensitiveByDefault

XMLObfuscator.Builder caseSensitiveByDefault()

Sets the default case sensitivity for new elements and attributes to CaseSensitivity.CASE_SENSITIVE. This is the default setting.

Note that this will not change the case sensitivity of any element or attribute that was already added.

Returns:

This object.

caseInsensitiveByDefault

XMLObfuscator.Builder caseInsensitiveByDefault()

Sets the default case sensitivity for new elements and attributes to CaseSensitivity.CASE_INSENSITIVE.

Note that this will not change the case sensitivity of any element or attribute that was already added.

Returns:

This object.

textOnlyByDefault

default XMLObfuscator.Builder textOnlyByDefault()

Indicates that by default nested elements will not be obfuscated. This method is shorthand for calling excludeNestedElementsByDefault().

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

Returns:

This object.

excludeNestedElementsByDefault

default XMLObfuscator.Builder excludeNestedElementsByDefault()

Indicates that by default nested elements will not be obfuscated. This method is an alias for #forNestedElementsByDefault(ObfuscationMode) in combination with XMLObfuscator.ElementConfigurer.ObfuscationMode.EXCLUDE.

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

Returns:

This object.

allByDefault

default XMLObfuscator.Builder allByDefault()

Indicates that by default nested elements will be obfuscated (default). This method is shorthand for calling includeNestedElementsByDefault().

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

Returns:

This object.

includeNestedElementsByDefault

default XMLObfuscator.Builder includeNestedElementsByDefault()

Indicates that by default nested elements will be obfuscated (default). This method is an alias for #forNestedElementsByDefault(ObfuscationMode) in combination with XMLObfuscator.ElementConfigurer.ObfuscationMode.INHERIT.

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

Returns:

This object.

forNestedElementsByDefault

XMLObfuscator.Builder forNestedElementsByDefault(XMLObfuscator.ElementConfigurer.ObfuscationMode obfuscationMode)

Indicates how to handle nested elements. The default is XMLObfuscator.ElementConfigurer.ObfuscationMode.INHERIT. This can be overridden per element using XMLObfuscator.ElementConfigurer.forNestedElements(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 nested elements.

Returns:

This object.

Throws:

NullPointerException - If the given obfuscation mode is null.

Since:

1.4

withMalformedXMLWarning

XMLObfuscator.Builder withMalformedXMLWarning(String warning)

Sets the warning to include if an XMLStreamException 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.

limitTo

XMLObfuscator.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 XMLObfuscators.

Throws:

IllegalArgumentException - If the given limit is negative.

Since:

1.1

generateXML

XMLObfuscator.Builder generateXML()

Indicates that XML obfuscators will always generate new, obfuscated documents. This method can be called when generating obfuscated documents is preferred, and no other method triggers the generation of obfuscated documents.

Returns:

This object.

Since:

1.3

transform

default <R> R transform(Function<? super XMLObfuscator.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

XMLObfuscator build()

Creates a new XMLObfuscator with the elements and obfuscators added to this builder.

Returns:

The created XMLObfuscator.