Class HtmlSanitizerConfigurationProperties

java.lang.Object

io.micronaut.security.html.HtmlSanitizerConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, HtmlSanitizerConfiguration

@ConfigurationProperties("micronaut.security.html-sanitizer")
public class HtmlSanitizerConfigurationProperties
extends Object
implements HtmlSanitizerConfiguration

HtmlSanitizerConfiguration implementation.

Since:

5.1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enabled value.
static final String	PREFIX	The configuration prefix.

Constructor Summary

Constructors

Constructor	Description
HtmlSanitizerConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
List<HtmlSanitizerPolicy>	getPolicies()	The configured OWASP sanitizer policies.
boolean	isEnabled()
void	setEnabled(boolean enabled)	Sets whether the OWASP-backed HTML sanitizer is enabled.
void	setPolicies(List<HtmlSanitizerPolicy> policies)	Sets the OWASP sanitizer policies to combine.

Methods inherited from class Object

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

Field Details

PREFIX

public static final String PREFIX

The configuration prefix.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enabled value.

See Also:

• Constant Field Values

Constructor Details

HtmlSanitizerConfigurationProperties

public HtmlSanitizerConfigurationProperties()

Method Details

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Sets whether the OWASP-backed HTML sanitizer is enabled.

Parameters:

enabled - True if the sanitizer is enabled

getPolicies

public List<HtmlSanitizerPolicy> getPolicies()

Description copied from interface: HtmlSanitizerConfiguration

The configured OWASP sanitizer policies.

Specified by:

getPolicies in interface HtmlSanitizerConfiguration

Returns:

The configured OWASP sanitizer policies.

setPolicies

public void setPolicies(List<HtmlSanitizerPolicy> policies)

Sets the OWASP sanitizer policies to combine. By default BLOCKS, FORMATTING and LINKS.

Parameters:

policies - The sanitizer policies