Package org.mapfish.print.processor.http.matcher

Class HostnameMatcher

java.lang.Object

org.mapfish.print.processor.http.matcher.AbstractMatcher

org.mapfish.print.processor.http.matcher.HostMatcher

org.mapfish.print.processor.http.matcher.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/.+
 

Field Summary

Fields inherited from class org.mapfish.print.processor.http.matcher.HostMatcher

pathRegex, port

Constructor Summary

Constructors

Constructor	Description
HostnameMatcher()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	hashCode()
void	setAllowSubDomains(boolean allowSubDomains)	Set if sub-domains are allowed.
void	setHost(java.lang.String host)	Set the host.
java.lang.String	toString()
protected java.util.Optional<java.lang.Boolean>	tryOverrideValidation(MatchInfo matchInfo)	If the subclass has its own checks or if it has a different validation method this method can return a valid value.
void	validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration)	validate that the configuration was correct.

Methods inherited from class org.mapfish.print.processor.http.matcher.HostMatcher

matches, setPathRegex, setPort

Methods inherited from class org.mapfish.print.processor.http.matcher.AbstractMatcher

isReject, setReject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HostnameMatcher

public HostnameMatcher()

Method Detail

validate

public void validate(java.util.List<java.lang.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 java.util.Optional<java.lang.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 java.lang.String toString()

Specified by:

toString in class HostMatcher

setHost

public void setHost(java.lang.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(java.lang.Object o)

Overrides:

equals in class HostMatcher

hashCode

public int hashCode()

Overrides:

hashCode in class HostMatcher