org.hibernate.validator.constraints

Annotation Type SafeHtml

@Documented
 @Constraint(validatedBy={})
 @Target(value={METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
 @Retention(value=RUNTIME)
 @Repeatable(value=SafeHtml.List.class)
public @interface SafeHtml

Validate a rich text value provided by the user to ensure that it contains no malicious code, such as embedded <script> elements.

Note that this constraint assumes you want to validate input which represents a body fragment of an HTML document. If you instead want to validate input which represents a complete HTML document, add the html, head and body tags to the used whitelist as required.

Author:

George Gastaldi

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	additionalTags
SafeHtml.Tag[]	additionalTagsWithAttributes
String	baseURI
Class<?>[]	groups
String	message
Class<? extends Payload>[]	payload
SafeHtml.WhiteListType	whitelistType

Element Detail

message

public abstract String message

Default:

"{org.hibernate.validator.constraints.SafeHtml.message}"

groups

public abstract Class<?>[] groups

Default:

{}

payload

public abstract Class<? extends Payload>[] payload

Default:

{}

whitelistType

public abstract SafeHtml.WhiteListType whitelistType

Returns:

The built-in whitelist type which will be applied to the rich text value

Default:

org.hibernate.validator.constraints.SafeHtml.WhiteListType.RELAXED

additionalTags

public abstract String[] additionalTags

Returns:

Additional whitelist tags which are allowed on top of the tags specified by the whitelistType().

Default:

{}

additionalTagsWithAttributes

public abstract SafeHtml.Tag[] additionalTagsWithAttributes

Returns:

Allows to specify additional whitelist tags with optional attributes and protocols.

Default:

{}

baseURI

public abstract String baseURI

Returns:

Base URI used to resolve relative URIs to absolute ones. If not set, validation of HTML containing relative URIs will fail.

Since:

6.0

Default:

""