Enum Class HtmlSanitizerPolicy

java.lang.Object

java.lang.Enum<HtmlSanitizerPolicy>

io.micronaut.security.html.HtmlSanitizerPolicy

All Implemented Interfaces:

Serializable, Comparable<HtmlSanitizerPolicy>, Constable

public enum HtmlSanitizerPolicy
extends Enum<HtmlSanitizerPolicy>

Supported OWASP HTML sanitizer policies.

Since:

5.1.0

Author:

Sergio del Amo

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKS	Common block elements.
FORMATTING	Common formatting elements.
IMAGES	Image elements and attributes.
LINKS	Safe link elements and attributes.
STYLES	Inline style attributes.
TABLES	Table elements.

Method Summary

Modifier and Type	Method	Description
org.owasp.html.PolicyFactory	policyFactory()	The OWASP policy factory for this policy.
static HtmlSanitizerPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HtmlSanitizerPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLOCKS

public static final HtmlSanitizerPolicy BLOCKS

Common block elements.

FORMATTING

public static final HtmlSanitizerPolicy FORMATTING

Common formatting elements.

LINKS

public static final HtmlSanitizerPolicy LINKS

Safe link elements and attributes.

TABLES

public static final HtmlSanitizerPolicy TABLES

Table elements.

IMAGES

public static final HtmlSanitizerPolicy IMAGES

Image elements and attributes.

STYLES

public static final HtmlSanitizerPolicy STYLES

Inline style attributes.

Method Details

values

public static HtmlSanitizerPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HtmlSanitizerPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

policyFactory

public org.owasp.html.PolicyFactory policyFactory()

The OWASP policy factory for this policy.

Returns:

The OWASP policy factory for this policy.