org.mapfish.print.processor.http

Class RestrictUrisProcessor

java.lang.Object

org.mapfish.print.processor.AbstractProcessor<ClientHttpFactoryProcessorParam,ClientHttpFactoryProcessorParam>

org.mapfish.print.processor.http.AbstractClientHttpRequestFactoryProcessor

org.mapfish.print.processor.http.RestrictUrisProcessor

All Implemented Interfaces:

ConfigurationObject, HttpProcessor<ClientHttpFactoryProcessorParam>, Processor<ClientHttpFactoryProcessorParam,ClientHttpFactoryProcessorParam>

public final class RestrictUrisProcessor
extends AbstractClientHttpRequestFactoryProcessor

This processor check urls against a set of url matchers to see if the request should be allowed or rejected.

Usage of processor is as follows:

 - !restrictUris
   matchers:
     - !localMatch {}
     - !ipMatch
       ip: www.camptocamp.org
     - !dnsMatch
       host: mapfish-geoportal.demo-camptocamp.com
       port: 80
     - !dnsMatch
       host: labs.metacarta.com
       port: 80
     - !dnsMatch
       host: terraservice.net
       port: 80
     - !dnsMatch
       host: tile.openstreetmap.org
       port: 80
     - !dnsMatch
       host: www.geocat.ch
       port: 80
 

Note: if this class is part of a CompositeClientHttpRequestFactoryProcessor (!configureHttpRequests) then it should be the last one so that the checks are done after all changes to the URIs

See Also:

AcceptAllMatcher, AddressHostMatcher, DnsHostMatcher, LocalHostMatcher

Nested Class Summary

Nested classes/interfaces inherited from class org.mapfish.print.processor.AbstractProcessor

AbstractProcessor.Context

Nested classes/interfaces inherited from interface org.mapfish.print.processor.Processor

Processor.ExecutionContext

Constructor Summary

Constructors

Constructor and Description
RestrictUrisProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
MfClientHttpRequestFactory	createFactoryWrapper(ClientHttpFactoryProcessorParam clientHttpFactoryProcessorParam, MfClientHttpRequestFactory requestFactory) Create the MfClientHttpRequestFactory to use.
protected void	extraValidation(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration) Perform any extra validation a subclass may need to perform.
void	setMatchers(java.util.List<? extends HostMatcher> matchers) The matchers used to select the legal urls.

Methods inherited from class org.mapfish.print.processor.http.AbstractClientHttpRequestFactoryProcessor

createInputParameter, execute

Methods inherited from class org.mapfish.print.processor.AbstractProcessor

checkCancelState, getInputMapperBiMap, getInputPrefix, getOutputMapperBiMap, getOutputPrefix, getOutputType, setInputMapper, setInputPrefix, setOutputMapper, setOutputPrefix, setPrefix, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mapfish.print.processor.Processor

getInputMapperBiMap, getInputPrefix, getOutputMapperBiMap, getOutputPrefix, getOutputType

Methods inherited from interface org.mapfish.print.config.ConfigurationObject

validate

Constructor Detail

RestrictUrisProcessor

public RestrictUrisProcessor()

Method Detail

setMatchers

public void setMatchers(java.util.List<? extends HostMatcher> matchers)

The matchers used to select the legal urls. For example:

 - !restrictUris
   matchers:
     - !localMatch
       dummy: true
     - !ipMatch
     ip: www.camptocamp.org
     - !dnsMatch
       host: mapfish-geoportal.demo-camptocamp.com
       port: 80
     - !dnsMatch
       host: labs.metacarta.com
       port: 80
     - !dnsMatch
       host: terraservice.net
       port: 80
     - !dnsMatch
       host: tile.openstreetmap.org
       port: 80
     - !dnsMatch
       host: www.geocat.ch
       port: 80
 

Parameters:

matchers - the list of matcher to use to check if a url is permitted

extraValidation

protected void extraValidation(java.util.List<java.lang.Throwable> validationErrors,
                   Configuration configuration)

Description copied from class: AbstractProcessor

Perform any extra validation a subclass may need to perform.

Specified by:

extraValidation in class AbstractProcessor<ClientHttpFactoryProcessorParam,ClientHttpFactoryProcessorParam>

Parameters:

validationErrors - a list to add errors to so that all validation errors are reported as one.

configuration - the containing configuration

createFactoryWrapper

public MfClientHttpRequestFactory createFactoryWrapper(ClientHttpFactoryProcessorParam clientHttpFactoryProcessorParam,
                                              MfClientHttpRequestFactory requestFactory)

Description copied from interface: HttpProcessor

Create the MfClientHttpRequestFactory to use.

Parameters:

clientHttpFactoryProcessorParam - extra parameters required to create the updated request factory

requestFactory - the basic request factory. It should be unmodified and just wrapped with a proxy class.