Allows public suffixes and registered domains to be determined from a string that represents a target domain name. A database of known registered suffixes is used to perform the determination. A public suffix is defined as the rightmost part of a domain name that is not owned by an individual registrant. Examples of public suffixes are: com edu co.uk k12.ak.us com.tw 網路.tw Public suffixes effectively denote registration authorities. A registered domain is a public suffix preceded by one domain label and a ".". Examples are: oracle.com mit.edu The internal database is derived from the information maintained at http://publicsuffix.org. The information is fixed for a particular JDK installation, but may be updated in future releases or updates. Because of the large number of top-level domains (TLDs) and public suffix rules, we only load the rules on demand -- from a Zip file containing an entry for each TLD. As each entry is loaded, its data is stored permanently in a cache. The containment hierarchy for the data is shown below: Rules --> contains all the rules for a particular TLD RuleSet --> contains all the rules that match 1 label RuleSet --> contains all the rules that match 2 labels RuleSet --> contains all the rules that match 3 labels : RuleSet --> contains all the rules that match N labels HashSet of rules, where each rule is an exception rule, a "normal" rule, a wildcard rule (rules that contain a wildcard prefix only), or a LinkedList of "other" rules The general matching algorithm tries to find the longest match. So, the search begins at the RuleSet with the most labels, and works backwards. Exceptions take priority over all other rules, and if a Rule contains any exceptions, then even if we find a "normal" match, we search all other RuleSets for exceptions. It is assumed that all other rules don't intersect/overlap. If this happens, a match will be returned, but not necessarily the expected one. For a further explanation of the rules, see http://publicsuffix.org/list/. The "other" rules are for the (possible future) case where wildcards are located in a rule any place other than the beginning.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DomainName.CommonMatch Represents a match against a standard rule in the public suffix list.
private static interface	DomainName.Match Represents a string's match with a rule in the public suffix list.
private static class	DomainName.OtherMatch Represents a non-match with `NO_MATCH` or a match against a non-standard rule in the public suffix list.
private static class	DomainName.OtherRule
private static class	DomainName.RegisteredDomainImpl
private static class	DomainName.Rule
private static class	DomainName.Rules A Rules object contains a list of rules for a particular TLD.

Field Summary

Modifier and Type	Field and Description
private static final Map<String, DomainName.Rules>	cache For efficiency, the set of rules for each TLD is kept in text files and only loaded if needed.

Constructor Summary

Access	Constructor and Description
private	DomainName()

Method Summary

Modifier and Type	Method and Description
private static DomainName.Match	getMatch(String domain)
public static RegisteredDomain	Returns: the registered domain, or null if not known or not registerable registeredDomain(String the domain name domain) Returns the registered domain of the specified domain.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private static final Map<String, DomainName.Rules> cache For efficiency, the set of rules for each TLD is kept in text files and only loaded if needed.

Constructor Detail

DomainName	back to summary
private DomainName()

Method Detail

getMatch	back to summary
private static DomainName.Match getMatch(String domain)

registeredDomain	back to summary
public static RegisteredDomain registeredDomain(String domain) Returns the registered domain of the specified domain. Parameters domain:String the domain name Returns:RegisteredDomain the registered domain, or null if not known or not registerable Exceptions NullPointerException: if domain is null

registeredDomain

back to summary

public static RegisteredDomain registeredDomain(String domain)

Returns the registered domain of the specified domain.

Parameters

domain:String: the domain name

Returns:RegisteredDomain

the registered domain, or null if not known or not registerable

Exceptions

NullPointerException:: if domain is null

sun.security.util back to summary

private Class DomainName.CommonMatch

Class Inheritance

extends Object
implements Match

java.lang.Object
sun.security.util.DomainName.CommonMatch

All Implemented Interfaces

sun.security.util.DomainName.Match

Represents a match against a standard rule in the public suffix list. A standard rule is an explicit name, a wildcard rule with a wildcard only in the leading label, or an exception rule.

Field Summary

Modifier and Type	Field and Description
private final String	domain
private final int	publicSuffix
private int	registeredDomain
private final DomainName.Rule	rule

Constructor Summary

Access	Constructor and Description
pack-priv	CommonMatch(String domain, DomainName.Rule rule, int publicSuffix)

Method Summary

Modifier and Type	Method and Description
public RegisteredDomain	registeredDomain() Implements sun.security.util.DomainName.Match.registeredDomain.
public DomainName.Rule.Type	type() Implements sun.security.util.DomainName.Match.type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

domain	back to summary
private final String domain

publicSuffix	back to summary
private final int publicSuffix

registeredDomain	back to summary
private int registeredDomain

rule	back to summary
private final DomainName.Rule rule

Constructor Detail

CommonMatch	back to summary
pack-priv CommonMatch(String domain, DomainName.Rule rule, int publicSuffix)

Method Detail

registeredDomain	back to summary
public RegisteredDomain registeredDomain() Implements sun.security.util.DomainName.Match.registeredDomain. Annotations @Override

registeredDomain

back to summary

public RegisteredDomain registeredDomain()

Implements sun.security.util.DomainName.Match.registeredDomain.

Annotations

@Override

type	back to summary
public DomainName.Rule.Type type() Implements sun.security.util.DomainName.Match.type. Annotations @Override

type

back to summary

public DomainName.Rule.Type type()

Implements sun.security.util.DomainName.Match.type.

Annotations

@Override

sun.security.util back to summary

private Interface DomainName.Match

Known Direct Implementers: sun.security.util.DomainName.CommonMatch, sun.security.util.DomainName.OtherMatch

Represents a string's match with a rule in the public suffix list.

Method Summary

Modifier and Type	Method and Description
public RegisteredDomain	registeredDomain()
public DomainName.Rule.Type	type()

Method Detail

registeredDomain	back to summary
public RegisteredDomain registeredDomain()

type	back to summary
public DomainName.Rule.Type type()

sun.security.util back to summary

private Class DomainName.OtherMatch

Class Inheritance

extends Object
implements Match

java.lang.Object
sun.security.util.DomainName.OtherMatch

All Implemented Interfaces

sun.security.util.DomainName.Match

Represents a non-match with NO_MATCH or a match against a non-standard rule in the public suffix list. A non-standard rule is a wildcard rule that includes wildcards in a label other than the leading label. The public suffix list doesn't currently have such rules.

Field Summary

Modifier and Type	Field and Description
private final int	numLabels
private final DomainName.Rule	rule
private final LinkedList<String>	target

Constructor Summary

Access	Constructor and Description
pack-priv	OtherMatch(DomainName.Rule rule, int numLabels, LinkedList<String> target)

Method Summary

Modifier and Type	Method and Description
private String	getSuffixes(int n)
public RegisteredDomain	registeredDomain() Implements sun.security.util.DomainName.Match.registeredDomain.
public DomainName.Rule.Type	type() Implements sun.security.util.DomainName.Match.type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

numLabels	back to summary
private final int numLabels

rule	back to summary
private final DomainName.Rule rule

target	back to summary
private final LinkedList<String> target

Constructor Detail

OtherMatch	back to summary
pack-priv OtherMatch(DomainName.Rule rule, int numLabels, LinkedList<String> target)

Method Detail

getSuffixes	back to summary
private String getSuffixes(int n)

registeredDomain	back to summary
public RegisteredDomain registeredDomain() Implements sun.security.util.DomainName.Match.registeredDomain. Annotations @Override

registeredDomain

back to summary

public RegisteredDomain registeredDomain()

Implements sun.security.util.DomainName.Match.registeredDomain.

Annotations

@Override

type	back to summary
public DomainName.Rule.Type type() Implements sun.security.util.DomainName.Match.type. Annotations @Override

type

back to summary

public DomainName.Rule.Type type()

Implements sun.security.util.DomainName.Match.type.

Annotations

@Override

sun.security.util back to summary

private Class DomainName.OtherRule

Class Inheritance

extends Rule

java.lang.Object
sun.security.util.DomainName.Rule
sun.security.util.DomainName.OtherRule

Field Summary

Modifier and Type	Field and Description
pack-priv List<String>	labels

Inherited from sun.security.util.DomainName.Rule:: auth domain type

Constructor Summary

Access	Constructor and Description
pack-priv	OtherRule(String domain, RegisteredDomain.Type auth, List<String> labels)

Field Detail

labels	back to summary
pack-priv List<String> labels

Constructor Detail

OtherRule	back to summary
pack-priv OtherRule(String domain, RegisteredDomain.Type auth, List<String> labels)

sun.security.util back to summary

private Class DomainName.RegisteredDomainImpl

Class Inheritance

extends Object
implements RegisteredDomain

java.lang.Object
sun.security.util.DomainName.RegisteredDomainImpl

All Implemented Interfaces

sun.security.util.RegisteredDomain

Field Summary

Modifier and Type	Field and Description
private final String	name
private final String	publicSuffix
private final RegisteredDomain.Type	type

Constructor Summary

Access	Constructor and Description
pack-priv	RegisteredDomainImpl(String name, RegisteredDomain.Type type, String publicSuffix)

Method Summary

Modifier and Type	Method and Description
public String	name() Implements sun.security.util.RegisteredDomain.name. Returns the name of the registered domain.
public String	publicSuffix() Implements sun.security.util.RegisteredDomain.publicSuffix. Returns the public suffix of the registered domain.
public RegisteredDomain.Type	type() Implements sun.security.util.RegisteredDomain.type. Returns the type of the registered domain.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

name	back to summary
private final String name

publicSuffix	back to summary
private final String publicSuffix

type	back to summary
private final RegisteredDomain.Type type

Constructor Detail

RegisteredDomainImpl	back to summary
pack-priv RegisteredDomainImpl(String name, RegisteredDomain.Type type, String publicSuffix)

Method Detail

name	back to summary
public String name() Implements sun.security.util.RegisteredDomain.name. Doc from sun.security.util.RegisteredDomain.name. Returns the name of the registered domain. Annotations @Override

name

back to summary

public String name()

Implements sun.security.util.RegisteredDomain.name.

Doc from sun.security.util.RegisteredDomain.name.

Returns the name of the registered domain.

Annotations

@Override

publicSuffix	back to summary
public String publicSuffix() Implements sun.security.util.RegisteredDomain.publicSuffix. Doc from sun.security.util.RegisteredDomain.publicSuffix. Returns the public suffix of the registered domain. Annotations @Override

publicSuffix

back to summary

public String publicSuffix()

Implements sun.security.util.RegisteredDomain.publicSuffix.

Doc from sun.security.util.RegisteredDomain.publicSuffix.

Returns the public suffix of the registered domain.

Annotations

@Override

type	back to summary
public RegisteredDomain.Type type() Implements sun.security.util.RegisteredDomain.type. Doc from sun.security.util.RegisteredDomain.type. Returns the type of the registered domain. Annotations @Override

type

back to summary

public RegisteredDomain.Type type()

Implements sun.security.util.RegisteredDomain.type.

Doc from sun.security.util.RegisteredDomain.type.

Returns the type of the registered domain.

Annotations

@Override

sun.security.util back to summary

private Class DomainName.Rule

Class Inheritance

extends Object

java.lang.Object
sun.security.util.DomainName.Rule

Known Direct Subclasses

sun.security.util.DomainName.OtherRule

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static enum	DomainName.Rule.Type

Field Summary

Modifier and Type	Field and Description
pack-priv RegisteredDomain.Type	auth
pack-priv String	domain
pack-priv DomainName.Rule.Type	type

Constructor Summary

Access	Constructor and Description
pack-priv	Rule(String domain, DomainName.Rule.Type type, RegisteredDomain.Type auth)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

auth	back to summary
pack-priv RegisteredDomain.Type auth

domain	back to summary
pack-priv String domain

type	back to summary
pack-priv DomainName.Rule.Type type

Constructor Detail

Rule	back to summary
pack-priv Rule(String domain, DomainName.Rule.Type type, RegisteredDomain.Type auth)

sun.security.util back to summary

pack-priv final Enum DomainName.Rule.Type

Class Inheritance

extends Enum<DomainName.Rule.Type>

java.lang.Object
java.lang.Enum
sun.security.util.DomainName.Rule.Type

Field Summary

Modifier and Type	Field and Description
public static final DomainName.Rule.Type	EXCEPTION
public static final DomainName.Rule.Type	NORMAL
public static final DomainName.Rule.Type	OTHER
public static final DomainName.Rule.Type	WILDCARD

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static DomainName.Rule.Type	valueOf(String name)
public static DomainName.Rule.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXCEPTION	back to summary
public static final DomainName.Rule.Type EXCEPTION

NORMAL	back to summary
public static final DomainName.Rule.Type NORMAL

OTHER	back to summary
public static final DomainName.Rule.Type OTHER

WILDCARD	back to summary
public static final DomainName.Rule.Type WILDCARD

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static DomainName.Rule.Type valueOf(String name)

values	back to summary
public static DomainName.Rule.Type[] values()

sun.security.util back to summary

private Class DomainName.Rules

Class Inheritance

extends Object

java.lang.Object
sun.security.util.DomainName.Rules

A Rules object contains a list of rules for a particular TLD. Rules are stored in a linked list of RuleSet objects. The list is indexed according to the number of labels in the name (minus one) such that all rules with the same number of labels are stored in the same RuleSet. Doing this means we can find the longest match first, and also we can stop comparing as soon as we find a match.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DomainName.Rules.RuleSet Represents a set of rules with the same number of labels and for a particular TLD.

Field Summary

Modifier and Type	Field and Description
private final boolean	hasExceptions
private final LinkedList<DomainName.Rules.RuleSet>	ruleSets

Constructor Summary

Access	Constructor and Description
private	Rules(InputStream is)

Method Summary

Modifier and Type	Method and Description
private static DomainName.Rules	createRules(String tld)
private static InputStream	getPubSuffixStream()
pack-priv static DomainName.Rules	getRules(String domain)
private static DomainName.Rules	getRules(String tld, ZipInputStream zis)
private DomainName.Rules.RuleSet	getRuleSet(int index) Return the requested RuleSet.
private static String	getTopLevelDomain(String domain)
pack-priv DomainName.Match	match(String domain) Find a match for the target string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hasExceptions	back to summary
private final boolean hasExceptions

ruleSets	back to summary
private final LinkedList<DomainName.Rules.RuleSet> ruleSets

Constructor Detail

Rules	back to summary
private Rules(InputStream is) throws IOException

Method Detail

createRules	back to summary
private static DomainName.Rules createRules(String tld)

getPubSuffixStream	back to summary
private static InputStream getPubSuffixStream()

getRules	back to summary
pack-priv static DomainName.Rules getRules(String domain)

getRules	back to summary
private static DomainName.Rules getRules(String tld, ZipInputStream zis) throws IOException

getRuleSet	back to summary
private DomainName.Rules.RuleSet getRuleSet(int index) Return the requested RuleSet. If it hasn't been created yet, create it and any RuleSets leading up to it.

getTopLevelDomain	back to summary
private static String getTopLevelDomain(String domain)

match	back to summary
pack-priv DomainName.Match match(String domain) Find a match for the target string.

sun.security.util back to summary

private Class DomainName.Rules.RuleSet

Class Inheritance

extends Object

java.lang.Object
sun.security.util.DomainName.Rules.RuleSet

Represents a set of rules with the same number of labels and for a particular TLD. Examples: numLabels = 2 names: co.uk, ac.uk wildcards *.de (only "de" stored in HashSet) exceptions: !foo.de (stored as "foo.de")

Field Summary

Modifier and Type	Field and Description
private static final RegisteredDomain.Type[]	AUTHS
pack-priv boolean	hasExceptions
private final int	numLabels
private final Set<DomainName.Rule>	rules

Constructor Summary

Access	Constructor and Description
pack-priv	RuleSet(int n)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addRule(int auth, String rule)
private static int	labels(String s, int n) Returns a substring (index) with the n right-most labels from s.
pack-priv DomainName.Match	match(String domain)
private DomainName.Match	matchException(String domain, DomainName.Rule rule) Check for a match with an exception rule.
private DomainName.Match	matchNormal(String domain, DomainName.Rule rule) Check for a match with an explicit name rule or a wildcard rule (i.e., a non-exception rule).
private DomainName.Match	matchOther(String domain, DomainName.Rule rule) A left-to-right comparison of labels.
private DomainName.Match	matchWildcard(String domain, DomainName.Rule rule)
private static int	numLabels(String rule)
private static LinkedList<String>	split(String rule)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

AUTHS	back to summary
private static final RegisteredDomain.Type[] AUTHS

hasExceptions	back to summary
pack-priv boolean hasExceptions

numLabels	back to summary
private final int numLabels

rules	back to summary
private final Set<DomainName.Rule> rules

Constructor Detail

RuleSet	back to summary
pack-priv RuleSet(int n)

Method Detail

addRule	back to summary
pack-priv void addRule(int auth, String rule)

labels	back to summary
private static int labels(String s, int n) Returns a substring (index) with the n right-most labels from s. Returns -1 if s does not have at least n labels, 0, if the substring is s.

match	back to summary
pack-priv DomainName.Match match(String domain)

matchException	back to summary
private DomainName.Match matchException(String domain, DomainName.Rule rule) Check for a match with an exception rule.

matchNormal	back to summary
private DomainName.Match matchNormal(String domain, DomainName.Rule rule) Check for a match with an explicit name rule or a wildcard rule (i.e., a non-exception rule).

matchOther

back to summary

private DomainName.Match matchOther(String domain, DomainName.Rule rule)

A left-to-right comparison of labels. The simplest approach to doing match() would be to use a descending iterator giving a right-to-left comparison. But, it's more efficient to do left-to-right compares because the left most labels are the ones most likely to be different. We just have to figure out which label to start at.

matchWildcard	back to summary
private DomainName.Match matchWildcard(String domain, DomainName.Rule rule)

numLabels	back to summary
private static int numLabels(String rule)

split	back to summary
private static LinkedList<String> split(String rule)

pack-priv Class DomainName

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DomainName.CommonMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface DomainName.Match

Method Summary

Method Detail

private Class DomainName.OtherMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DomainName.OtherRule

Field Summary

Constructor Summary

Field Detail

Constructor Detail

private Class DomainName.RegisteredDomainImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DomainName.Rule

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv final Enum DomainName.Rule.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DomainName.Rules

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DomainName.Rules.RuleSet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail