java.lang.Object | |
↳ | org.jsoup.safety.Cleaner |
The whitelist based HTML cleaner. Use to ensure that end-user provided HTML contains only the elements and attributes that you are expecting; no junk, and no cross-site scripting attacks!
The HTML cleaner parses the input as HTML and then runs it through a white-list, so the output HTML can only contain HTML that is allowed by the whitelist. It is assumed that the input HTML is a body fragment; the clean methods only pull from the source's body, and the canned white-lists only allow body contained tags. Rather than interacting directly with a Cleaner object, generally see theclean
methods in Jsoup
.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a new cleaner, that sanitizes documents using the supplied whitelist.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new, clean document, from the original dirty document, containing only elements allowed by the whitelist.
| |||||||||||
Dertmines if the input document is valid, against the whitelist.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Create a new cleaner, that sanitizes documents using the supplied whitelist.
whitelist | white-list to clean with |
---|
Creates a new, clean document, from the original dirty document, containing only elements allowed by the whitelist.
The original document is not modified. Only elements from the dirt document's body
are used.
dirtyDocument | Untrusted base document to clean. |
---|
Dertmines if the input document is valid, against the whitelist. It is considered valid if all the tags and attributes in the input HTML are allowed by the whitelist.
This method can be used as a validator for user input forms. An invalid document will still be cleaned successfully using theclean(Document)
document. If using as a validator, it is recommended to still clean the document
to ensure enforced attributes are set correctly, and that the output is tidied.dirtyDocument | document to test |
---|