io.shick.jsoup

Interface WhitelistConfiguration

All Known Subinterfaces:

MutableWhitelistConfiguration

All Known Implementing Classes:

BasicWhitelistConfiguration

public interface WhitelistConfiguration

WhitelistConfiguration interface.

Author:

Trever Shick - trever@shick.io

Method Summary

Modifier and Type	Method and Description
void	allowedAttributes(BiConsumer<String,List<String>> fn) fn will be called once for each allowed tag with the allowed attributes as the second argument, for example accept('a',['href','rel'])
void	allowedProtocols(BiConsumer<String,Map<String,List<String>>> fn) fn will be called once for each allowed tag with the allowed protocols as the second argument, for example accept('a',{ 'href':['http','https'] })
void	allowedTags(Consumer<String> fn) fn will be called once for each allowed tag.
boolean	allowsAttribute(String tagName, String attrName)
boolean	allowsProtocol(String tagName, String attrName, String protocol) allowsProtocol.
boolean	allowsTag(String tagName)
org.jsoup.safety.Whitelist	apply(org.jsoup.safety.Whitelist whitelist) Applies all the configured rules to the supplied Whitelist instance.
String	base()
void	enforcedAttributes(BiConsumer<String,Map<String,String>> fn) fn will be called once for each allowed tag with the enforced attributes map as the second argument, for example accept('a',{ 'rel':'nofollow' })
boolean	enforcesAttribute(String tagName, String attrName)
boolean	enforcesAttribute(String tagName, String attrName, String enforcedValue)
boolean	hasAllowedAttributes(String tagName)
boolean	hasAllowedProtocols(String tagName)
boolean	hasAllowedProtocols(String tagName, String attrName)
boolean	hasEnforcedAttributes(String tagName)
org.jsoup.safety.Whitelist	whitelist() Constructs an empty Whitelist and applies the configured rules to it.

Method Detail

base

String base()

Returns:

the name of the 'base' whitelist used when whitelist() is called.

allowedTags

void allowedTags(Consumer<String> fn)

fn will be called once for each allowed tag.

Parameters:

fn - (non null) a Consumer object.

allowedAttributes

void allowedAttributes(BiConsumer<String,List<String>> fn)

fn will be called once for each allowed tag with the allowed attributes as the second argument, for example accept('a',['href','rel'])

Parameters:

fn - a BiConsumer object.

enforcedAttributes

void enforcedAttributes(BiConsumer<String,Map<String,String>> fn)

fn will be called once for each allowed tag with the enforced attributes map as the second argument, for example accept('a',{ 'rel':'nofollow' })

Parameters:

fn - a BiConsumer object.

allowedProtocols

void allowedProtocols(BiConsumer<String,Map<String,List<String>>> fn)

fn will be called once for each allowed tag with the allowed protocols as the second argument, for example accept('a',{ 'href':['http','https'] })

Parameters:

fn - a BiConsumer object.

allowsTag

boolean allowsTag(String tagName)

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName is allowed

hasAllowedAttributes

boolean hasAllowedAttributes(String tagName)

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has allowed attributes.

allowsAttribute

boolean allowsAttribute(String tagName,
                        String attrName)

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

Returns:

true if tagName allows attrName

hasEnforcedAttributes

boolean hasEnforcedAttributes(String tagName)

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has any enforced attributes.

enforcesAttribute

boolean enforcesAttribute(String tagName,
                          String attrName)

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

Returns:

true if tagName enforces a value for attrName

enforcesAttribute

boolean enforcesAttribute(String tagName,
                          String attrName,
                          String enforcedValue)

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

enforcedValue - a String object.

Returns:

true if tagName enforces the value enforcedValue for attrName

hasAllowedProtocols

boolean hasAllowedProtocols(String tagName)

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has any configured allowed protocols

hasAllowedProtocols

boolean hasAllowedProtocols(String tagName,
                            String attrName)

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

Returns:

true if tagName's attrName attribute has allowed protocols.

allowsProtocol

boolean allowsProtocol(String tagName,
                       String attrName,
                       String protocol)

allowsProtocol.

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

protocol - (non null) a protocol like 'https' or 'http'

Returns:

true if tagName's attrName attribute allows protocol

apply

org.jsoup.safety.Whitelist apply(org.jsoup.safety.Whitelist whitelist)

Applies all the configured rules to the supplied Whitelist instance.

Parameters:

whitelist - a Whitelist object.

Returns:

a configured Whitelist instance.

whitelist

org.jsoup.safety.Whitelist whitelist()

Constructs an empty Whitelist and applies the configured rules to it.

Returns:

a configured Whitelist object.