Class HostnameMatcher

All Implemented Interfaces:
ConfigurationObject, URIMatcher

public final class HostnameMatcher extends HostMatcher
Allows to check that a given URL matches a hostname literally (textual match).

Example 1: Accept any www.camptocamp.com url


     - !hostnameMatch
       host: www.camptocamp.com
 

Example 2: Accept any www.camptocamp.com url (port == -1 accepts any port)


     - !hostnameMatch
       host: www.camptocamp.com
       port: -1
 

Example 3: Accept any www.camptocamp.com url on port 80 only


     - !hostnameMatch
       host: www.camptocamp.com
       port: 80
 
Example 4: Accept www.camptocamp.com urls with paths that start with /print/.

If the regular expression give does not start with / then it will be added because all paths start with /


     - !hostnameMatch
       host: www.camptocamp.com
       pathRegex: /print/.+
 
  • Constructor Details

    • HostnameMatcher

      public HostnameMatcher()
  • Method Details

    • validate

      public void validate(List<Throwable> validationErrors, Configuration configuration)
      Description copied from interface: ConfigurationObject
      validate that the configuration was correct.
      Parameters:
      validationErrors - a list to add any detected errors to.
      configuration - the containing configuration
    • tryOverrideValidation

      protected Optional<Boolean> tryOverrideValidation(MatchInfo matchInfo)
      Description copied from class: HostMatcher
      If the subclass has its own checks or if it has a different validation method this method can return a valid value.
      Specified by:
      tryOverrideValidation in class HostMatcher
      Parameters:
      matchInfo - the match information to validate.
    • toString

      public String toString()
      Specified by:
      toString in class HostMatcher
    • setHost

      public void setHost(String host)
      Set the host.
      Parameters:
      host - the host
    • setAllowSubDomains

      public void setAllowSubDomains(boolean allowSubDomains)
      Set if sub-domains are allowed.
      Parameters:
      allowSubDomains - true if allowed
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class HostMatcher
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class HostMatcher