org.apache.hc.client5.http.psl

## Class PublicSuffixMatcher

- java.lang.Object
- - org.apache.hc.client5.http.psl.PublicSuffixMatcher

-     @Contract(threading=SAFE)
      public final class PublicSuffixMatcher
      extends Object

  Utility class that can test if DNS names match the content of the Public Suffix List.

  An up-to-date list of suffixes can be obtained from publicsuffix.org

  Since:
    4.4
  See Also:
    `PublicSuffixList`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `PublicSuffixMatcher(Collection<PublicSuffixList> lists)`
    `PublicSuffixMatcher(Collection<String> rules, Collection<String> exceptions)`
    `PublicSuffixMatcher(DomainType domainType, Collection<String> rules, Collection<String> exceptions)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getDomainRoot(String domain)` Returns registrable part of the domain for the given domain name or `null` if given domain represents a public suffix.
    `String` | `getDomainRoot(String domain, DomainType expectedType)` Returns registrable part of the domain for the given domain name or `null` if given domain represents a public suffix.
    `boolean` | `matches(String domain)` Tests whether the given domain matches any of the entries from the public suffix list.
    `boolean` | `matches(String domain, DomainType expectedType)` Tests whether the given domain matches any of entry from the public suffix list.
    `boolean` | `verify(String domain)` Verifies if the given domain does not represent a public domain root and is allowed to set cookies, have an identity represented by a certificate, etc.
    `boolean` | `verifyInternal(String domain)`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### PublicSuffixMatcher

          public PublicSuffixMatcher(Collection<String> rules,
                                     Collection<String> exceptions)

    - #### PublicSuffixMatcher

          public PublicSuffixMatcher(DomainType domainType,
                                     Collection<String> rules,
                                     Collection<String> exceptions)

      Since:
        4.5

    - #### PublicSuffixMatcher

          public PublicSuffixMatcher(Collection<PublicSuffixList> lists)

      Since:
        4.5

  - ### Method Detail

    - #### getDomainRoot

          public String getDomainRoot(String domain)

      Returns registrable part of the domain for the given domain name or `null` if given domain represents a public suffix.
      Parameters:
        `domain` -
      Returns:
        domain root

    - #### getDomainRoot

          public String getDomainRoot(String domain,
                                      DomainType expectedType)

      Returns registrable part of the domain for the given domain name or `null` if given domain represents a public suffix.
      Parameters:
        `domain` -
        `expectedType` - expected domain type or `null` if any.
      Returns:
        domain root
      Since:
        4.5

    - #### matches

          public boolean matches(String domain)

      Tests whether the given domain matches any of the entries from the public suffix list.

    - #### matches

          public boolean matches(String domain,
                                 DomainType expectedType)

      Tests whether the given domain matches any of entry from the public suffix list.
      Parameters:
        `domain` -
        `expectedType` - expected domain type or `null` if any.
      Returns:
        `true` if the given domain matches any of the public suffixes.
      Since:
        4.5

    - #### verify

          @Internal
          public boolean verify(String domain)

      Verifies if the given domain does not represent a public domain root and is allowed to set cookies, have an identity represented by a certificate, etc.

      This method tolerates a leading dot in the domain name, for example '.example.com' which will be automatically stripped.

    - #### verifyInternal

          @Internal
          public boolean verifyInternal(String domain)

Copyright © 1999–2021 The Apache Software Foundation. All rights reserved.