com.google.gwt.dev.shell

Class BrowserWidgetHostChecker

java.lang.Object

com.google.gwt.dev.shell.BrowserWidgetHostChecker

public class BrowserWidgetHostChecker
extends Object

This class contains utility functions to do whitelist/blacklist handling.

Constructor Summary

Constructors

Constructor and Description
BrowserWidgetHostChecker()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	blacklistRegexes(String regexes) This method blacklists the supplied regexes, separated by comma or space.
static void	blacklistURL(String url) This method blacklists the supplied URL, and any that share the same host.
static String	checkHost(String hostUnderConsideration, Set<String> hosts) This method checks the host to see if it is in the supplied set of regexes.
static String	computeHostRegex(String url) This method computes the host regular expression for the given url.
static String	formatBlackList() This method formats the blacklist for display in the treeLogger.
static String	formatRules(Set<String> hosts) This method formats the list of rules for display in the treeLogger.
static String	formatWhiteList() This method formats the whitelist for display in the treeLogger.
static boolean	isAlwaysWhitelisted(String url) This method returns true if the host is always admissible, regardless of the blacklist.
static String	matchBlacklisted(String url) This method returns non-null if the host is forbidden.
static String	matchWhitelisted(String url) This method returns null if the host is admissible, provided it is not on the blacklist.
static void	notifyBlacklistedHost(String blacklistRuleFound, String url, TreeLogger header, TreeLogger.Type msgType) This method formats a message, and logs it to the treelogger, stating that the url was blocked.
static void	notifyUntrustedHost(String url, TreeLogger header, TreeLogger.Type msgType) This method formats a message, and logs it to the treelogger, stating that the url was not trusted.
static boolean	whitelistRegexes(String regexes) This method whitelists the supplied String of regexes, separated by comma or space.
static void	whitelistURL(String url) This method whitelists the supplied URL, and any that share the same host.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrowserWidgetHostChecker

public BrowserWidgetHostChecker()

Method Detail

blacklistRegexes

public static boolean blacklistRegexes(String regexes)

This method blacklists the supplied regexes, separated by comma or space.

Parameters:

regexes - the regexes to be forbidden

blacklistURL

public static void blacklistURL(String url)

This method blacklists the supplied URL, and any that share the same host.

Parameters:

url - the host to be forbidden

checkHost

public static String checkHost(String hostUnderConsideration,
               Set<String> hosts)

This method checks the host to see if it is in the supplied set of regexes.

Parameters:

hostUnderConsideration - the host to be checked

hosts - the set of regexes to be checked against

Returns:

true if the host matches

computeHostRegex

public static String computeHostRegex(String url)

This method computes the host regular expression for the given url.

Parameters:

url - the url to be allowed or disallowed

Returns:

the regex that matches the host in the url

formatBlackList

public static String formatBlackList()

This method formats the blacklist for display in the treeLogger.

Returns:

the list of regexes as a String

formatRules

public static String formatRules(Set<String> hosts)

This method formats the list of rules for display in the treeLogger.

Parameters:

hosts - the set of regexes that match hosts

Returns:

the list of regexes as a String

formatWhiteList

public static String formatWhiteList()

This method formats the whitelist for display in the treeLogger.

Returns:

the list of regexes as a String

isAlwaysWhitelisted

public static boolean isAlwaysWhitelisted(String url)

This method returns true if the host is always admissible, regardless of the blacklist.

Parameters:

url - the URL to be verified

Returns:

returns true if the host is always admissible

matchBlacklisted

public static String matchBlacklisted(String url)

This method returns non-null if the host is forbidden.

Parameters:

url - the URL to be verified

Returns:

returns the regex that specified the host matches the blacklist

matchWhitelisted

public static String matchWhitelisted(String url)

This method returns null if the host is admissible, provided it is not on the blacklist.

Parameters:

url - the URL to be verified

Returns:

returns the regex that specified the host matches the whitelist

notifyBlacklistedHost

public static void notifyBlacklistedHost(String blacklistRuleFound,
                         String url,
                         TreeLogger header,
                         TreeLogger.Type msgType)

This method formats a message, and logs it to the treelogger, stating that the url was blocked.

Parameters:

url - the URL that was disallowed

header - the treelogger under which these messages will be put

msgType - either a caution or an error

notifyUntrustedHost

public static void notifyUntrustedHost(String url,
                       TreeLogger header,
                       TreeLogger.Type msgType)

This method formats a message, and logs it to the treelogger, stating that the url was not trusted.

Parameters:

url - the URL that provoked the dialog box

header - the treelogger under which these messages will be put

msgType - either a caution or an error

whitelistRegexes

public static boolean whitelistRegexes(String regexes)

This method whitelists the supplied String of regexes, separated by comma or space.

Parameters:

regexes - the regexes to be allowed

whitelistURL

public static void whitelistURL(String url)

This method whitelists the supplied URL, and any that share the same host.

Parameters:

url - the host to be allowed