org.xwiki.xml.html
Interface HTMLCleanerConfiguration

public interface HTMLCleanerConfiguration

Represents a configuration for the HTMLCleaner and allows to configure the cleaning parameters and cleaning filters to apply.

Since:

1.8.1

Version:

$Id: b4e5e282daa5930bdd1139375115eb71c2d9e748 $

Field Summary

static String	NAMESPACES_AWARE Cleaning property identifier which decides if parsing should omit/keep namespace information.
static String	RESTRICTED Cleaning in restricted mode (<script> and <style> should not be allowed for example).

Method Summary

List<HTMLFilter>	getFilters()
Map<String,String>	getParameters()
void	setFilters(List<HTMLFilter> filters)
void	setParameters(Map<String,String> cleaningParameters)

Field Detail

NAMESPACES_AWARE

static final String NAMESPACES_AWARE

Cleaning property identifier which decides if parsing should omit/keep namespace information.

See Also:

Constant Field Values

RESTRICTED

static final String RESTRICTED

Cleaning in restricted mode (<script> and <style> should not be allowed for example).

See Also:

Constant Field Values

Method Detail

getFilters

List<HTMLFilter> getFilters()

Returns:

the ordered list of filters to use for cleaning the HTML content

setFilters

void setFilters(List<HTMLFilter> filters)

Parameters:

filters - the ordered list of filters to use for cleaning the HTML content

getParameters

Map<String,String> getParameters()

Returns:

the list of cleaning parameters that will be used to clean the HTML content. Note that these parameters are implementation dependent and thus depend on the HTML cleaner implementation used.

setParameters

void setParameters(Map<String,String> cleaningParameters)

Parameters:

cleaningParameters - the list of cleaning parameters that will be used to clean the HTML content