org.mapfish.print.processor.http.matcher

Class LocalHostMatcher

java.lang.Object

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

org.mapfish.print.processor.http.matcher.InetHostMatcher

org.mapfish.print.processor.http.matcher.LocalHostMatcher

All Implemented Interfaces:

ConfigurationObject, URIMatcher

public class LocalHostMatcher
extends InetHostMatcher

Allows to check that a given URL is served by one of the local network interface or one of its aliases.

Example 1: Accept any localhost url

     - localMatch {}
 

Example 2: Accept any localhost url (port == -1 accepts any port)

     - localMatch
       port : -1
 

Example 3: Accept any localhost url on port 80 only

     - localMatch
       port : 80
 

Example 4: Accept localhost 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 /

     - localMatch
       pathRegex : /print/.+
 

Field Summary

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

authorizedIPs

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

pathRegex, port

Constructor Summary

Constructors

Constructor and Description
LocalHostMatcher()

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[][]	getAuthorizedIPs(java.net.InetAddress mask) Get the full list of authorized IP addresses for the provided mask.
protected java.net.InetAddress	getMaskAddress() Get the mask IP address.
java.lang.String	toString()
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.InetHostMatcher

buildMaskedAuthorizedIPs, equals, hashCode, tryOverrideValidation

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

accepts, setPathRegex, setPort

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalHostMatcher

public LocalHostMatcher()

Method Detail

getAuthorizedIPs

protected final byte[][] getAuthorizedIPs(java.net.InetAddress mask)
                                   throws java.net.UnknownHostException,
                                          java.net.SocketException

Description copied from class: InetHostMatcher

Get the full list of authorized IP addresses for the provided mask.

Specified by:

getAuthorizedIPs in class InetHostMatcher

Parameters:

mask - the mask address

Throws:

java.net.UnknownHostException

java.net.SocketException

validate

public final 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

toString

public final java.lang.String toString()

Specified by:

toString in class HostMatcher

getMaskAddress

protected final java.net.InetAddress getMaskAddress()
                                             throws java.net.UnknownHostException

Description copied from class: InetHostMatcher

Get the mask IP address.

Specified by:

getMaskAddress in class InetHostMatcher

Returns:

the ask addresses.

Throws:

java.net.UnknownHostException