io.shick.jsoup

Class BasicWhitelistConfiguration

java.lang.Object

io.shick.jsoup.BasicWhitelistConfiguration

All Implemented Interfaces:

MutableWhitelistConfiguration, WhitelistConfiguration

public class BasicWhitelistConfiguration
extends Object
implements MutableWhitelistConfiguration

BasicWhitelistConfiguration class.

Author:

Trever Shick - trever@shick.io

Constructor Summary

Constructors

Constructor and Description
BasicWhitelistConfiguration()

Method Summary

Modifier and Type	Method and Description
MutableWhitelistConfiguration	allowAttribute(String tagName, String attrName) Add an allowed attribute to the configuration
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.
MutableWhitelistConfiguration	allowProtocol(String tagName, String attrName, String protocol) Add an allowed protocol to the configuration
boolean	allowsAttribute(String tagName, String attrName)
boolean	allowsProtocol(String tagName, String attrName, String protocol) allowsProtocol.
boolean	allowsTag(String tagName)
MutableWhitelistConfiguration	allowTag(String tagName) Add an allowed tag to the configuration
org.jsoup.safety.Whitelist	apply(org.jsoup.safety.Whitelist whitelist) Applies all the configured rules to the supplied Whitelist instance.
String	base()
MutableWhitelistConfiguration	base(String base) Sets the base whitelist to use when configuring a Whitelist, 'none' is the default value.
MutableWhitelistConfiguration	enforceAttribute(String tagName, String attrName, String enforcedValue) Add an enforced attribute value to the configuration
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	equals(Object o)
boolean	hasAllowedAttributes(String tagName)
boolean	hasAllowedProtocols(String tagName)
boolean	hasAllowedProtocols(String tagName, String attrName)
boolean	hasEnforcedAttributes(String tagName)
int	hashCode()
String	toString()
org.jsoup.safety.Whitelist	whitelist() Constructs an empty Whitelist and applies the configured rules to it.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicWhitelistConfiguration

public BasicWhitelistConfiguration()

Method Detail

base

public String base()

Specified by:

base in interface WhitelistConfiguration

Returns:

allowTag

public MutableWhitelistConfiguration allowTag(String tagName)

Add an allowed tag to the configuration

Specified by:

allowTag in interface MutableWhitelistConfiguration

Parameters:

tagName - (non null) an HTML tag name

Returns:

a MutableWhitelistConfiguration object.

allowedTags

public void allowedTags(Consumer<String> fn)

fn will be called once for each allowed tag.

Specified by:

allowedTags in interface WhitelistConfiguration

Parameters:

fn - (non null) a Consumer object.

allowedAttributes

public 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'])

Specified by:

allowedAttributes in interface WhitelistConfiguration

Parameters:

fn - a BiConsumer object.

enforcedAttributes

public 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' })

Specified by:

enforcedAttributes in interface WhitelistConfiguration

Parameters:

fn - a BiConsumer object.

allowedProtocols

public 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'] })

Specified by:

allowedProtocols in interface WhitelistConfiguration

Parameters:

fn - a BiConsumer object.

allowsTag

public boolean allowsTag(String tagName)

Specified by:

allowsTag in interface WhitelistConfiguration

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName is allowed

hasAllowedAttributes

public boolean hasAllowedAttributes(String tagName)

Specified by:

hasAllowedAttributes in interface WhitelistConfiguration

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has allowed attributes.

allowAttribute

public MutableWhitelistConfiguration allowAttribute(String tagName,
                                                    String attrName)

Add an allowed attribute to the configuration

Specified by:

allowAttribute in interface MutableWhitelistConfiguration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

Returns:

a MutableWhitelistConfiguration object.

allowsAttribute

public boolean allowsAttribute(String tagName,
                               String attrName)

Specified by:

allowsAttribute in interface WhitelistConfiguration

Parameters:

tagName - (non null) a valid HTML tag name

attrName - (non null) a valid HTML attribute name

Returns:

true if tagName allows attrName

hasEnforcedAttributes

public boolean hasEnforcedAttributes(String tagName)

Specified by:

hasEnforcedAttributes in interface WhitelistConfiguration

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has any enforced attributes.

enforcesAttribute

public boolean enforcesAttribute(String tagName,
                                 String attrName)

Specified by:

enforcesAttribute in interface WhitelistConfiguration

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

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

Specified by:

enforcesAttribute in interface WhitelistConfiguration

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

enforceAttribute

public MutableWhitelistConfiguration enforceAttribute(String tagName,
                                                      String attrName,
                                                      String enforcedValue)

Add an enforced attribute value to the configuration

Specified by:

enforceAttribute in interface MutableWhitelistConfiguration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

enforcedValue - (non null) the string value for the specified attribute.

Returns:

a MutableWhitelistConfiguration object.

hasAllowedProtocols

public boolean hasAllowedProtocols(String tagName)

Specified by:

hasAllowedProtocols in interface WhitelistConfiguration

Parameters:

tagName - (non null) a valid HTML tag name

Returns:

true if tagName has any configured allowed protocols

hasAllowedProtocols

public boolean hasAllowedProtocols(String tagName,
                                   String attrName)

Specified by:

hasAllowedProtocols in interface WhitelistConfiguration

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.

allowProtocol

public MutableWhitelistConfiguration allowProtocol(String tagName,
                                                   String attrName,
                                                   String protocol)

Add an allowed protocol to the configuration

Specified by:

allowProtocol in interface MutableWhitelistConfiguration

Parameters:

tagName - (non null) an HTML tag name

attrName - (non null) an HTML attribute name

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

Returns:

a MutableWhitelistConfiguration object.

allowsProtocol

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

allowsProtocol.

Specified by:

allowsProtocol in interface WhitelistConfiguration

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

base

public MutableWhitelistConfiguration base(String base)

Sets the base whitelist to use when configuring a Whitelist, 'none' is the default value.

Specified by:

base in interface MutableWhitelistConfiguration

Parameters:

base - an instance of whitelist to use as the base whitelist

Returns:

a MutableWhitelistConfiguration object.

apply

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

Applies all the configured rules to the supplied Whitelist instance.

Specified by:

apply in interface WhitelistConfiguration

Parameters:

whitelist - a Whitelist object.

Returns:

a configured Whitelist instance.

whitelist

public org.jsoup.safety.Whitelist whitelist()

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

Specified by:

whitelist in interface WhitelistConfiguration

Returns:

a configured Whitelist object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object