org.mapfish.print.config

Class Config

java.lang.Object

org.mapfish.print.config.Config

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Config
extends java.lang.Object
implements java.io.Closeable

Bean mapping the root of the configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Stop all the threads and stuff used for this config.
double	getBestScale(double target)
java.lang.String	getBrokenUrlPlaceholder()
java.util.TreeSet<java.lang.Integer>	getDpis()
java.util.TreeSet<java.lang.String>	getFonts()
java.util.TreeSet<java.lang.String>	getFormats()
java.util.TreeSet<java.lang.String>	getHeaders()
org.apache.commons.httpclient.HttpClient	getHttpClient(java.net.URI uri) Get or create the http client to be used to fetch all the map data.
boolean	getIntegerSvg()
java.util.TreeSet<Key>	getKeys()
Layout	getLayout(java.lang.String name)
MapReaderFactoryFinder	getMapReaderFactoryFinder()
OrderedResultsExecutor<MapTileTask>	getMapRenderingExecutor()
int	getMaxPrintTimeBeforeWarningInSeconds()
double	getMaxSvgH()
java.lang.String	getMaxSvgHeight()
double	getMaxSvgW()
java.lang.String	getMaxSvgWidth()
com.codahale.metrics.MetricRegistry	getMetricRegistry()
java.lang.String	getOutputFilename()
java.lang.String	getOutputFilename(java.lang.String layoutName)
java.util.List<java.lang.String>	getOverlayLayers()
int	getPrintTimeoutMinutes()
java.lang.String	getProxyBaseUrl() Get the url of the proxy that resides between the servlet and the internet.
boolean	getReloadConfig()
java.lang.Float	getTmsDefaultOriginX() Specify the default x - origin used by TMS map reader.
java.lang.Float	getTmsDefaultOriginY() Specify the default y - origin used by TMS map reader.
boolean	isDisableScaleLocking()
boolean	isIgnoreCapabilities()
boolean	isScalePresent(double targetScale)
boolean	isTilecacheMerging()
boolean	localHostForwardIsFrom(java.lang.String host)
boolean	localHostForwardIsHttps2http()
void	printClientConfig(org.json.JSONWriter json)
void	setBrokenUrlPlaceholder(java.lang.String brokenUrlPlaceholder)
void	setConnectionTimeout(int connectionTimeout)
void	setDisableScaleLocking(boolean disableScaleLocking)
void	setDpis(java.util.TreeSet<java.lang.Integer> dpis)
void	setFonts(java.util.TreeSet<java.lang.String> fonts)
void	setFormats(java.util.TreeSet<java.lang.String> formats)
void	setGlobalParallelFetches(int globalParallelFetches)
void	setHeaders(java.util.TreeSet<java.lang.String> headers)
void	setHosts(java.util.List<HostMatcher> hosts)
void	setIgnoreCapabilities(boolean ignoreCapabilities)
void	setIntegerSvg(boolean integerSvg)
void	setKeys(java.util.TreeSet<Key> keys)
void	setLayouts(Layouts layouts)
void	setLocalHostForward(java.util.HashMap localHostForward)
void	setMapReaderFactoryFinder(MapReaderFactoryFinder mapReaderFactoryFinder)
void	setMaxPrintTimeBeforeWarningInSeconds(int maxPrintTimeBeforeWarningInSeconds)
void	setMaxSvgHeight(java.lang.String maxSvgHeight)
void	setMaxSvgWidth(java.lang.String maxSvgWidth)
void	setMetricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)
void	setOutputFactory(OutputFactory outputFactory)
void	setOutputFilename(java.lang.String outputFilename)
void	setOverlayLayers(java.util.List<java.lang.String> overlayLayers)
void	setPerHostParallelFetches(int perHostParallelFetches)
void	setPrintTimeoutMinutes(int printTimeoutMinutes)
void	setProxyBaseUrl(java.lang.String proxyBaseUrl) Set the url of the proxy that resides between the servlet and the internet.
void	setReloadConfig(boolean reloadConfig)
void	setScales(java.util.TreeSet<java.lang.Number> scales)
void	setSecurity(java.util.List<SecurityStrategy> security)
void	setSocketTimeout(int socketTimeout)
void	setThreadResources(ThreadResources threadResources)
void	setTilecacheMerging(boolean tilecacheMerging)
void	setTmsDefaultOriginX(java.lang.Float tmsDefaultOriginX) Specify the default x - origin used by TMS map reader.
void	setTmsDefaultOriginY(java.lang.Float tmsDefaultOriginY) Specify the default y - origin used by TMS map reader.
void	validate() Called just after the config has been loaded to check it is valid.
boolean	validateUri(java.net.URI uri) Make sure an URI is authorized

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

Constructor Detail

Config

public Config()

Method Detail

setOutputFactory

public void setOutputFactory(OutputFactory outputFactory)

getLayout

public Layout getLayout(java.lang.String name)

setLayouts

public void setLayouts(Layouts layouts)

setDpis

public void setDpis(java.util.TreeSet<java.lang.Integer> dpis)

setMaxSvgWidth

public void setMaxSvgWidth(java.lang.String maxSvgWidth)

getMaxSvgWidth

public java.lang.String getMaxSvgWidth()

setMaxSvgHeight

public void setMaxSvgHeight(java.lang.String maxSvgHeight)

getMaxSvgHeight

public java.lang.String getMaxSvgHeight()

getMaxSvgW

public double getMaxSvgW()

getMaxSvgH

public double getMaxSvgH()

getDpis

public java.util.TreeSet<java.lang.Integer> getDpis()

printClientConfig

public void printClientConfig(org.json.JSONWriter json)
                       throws org.json.JSONException

Throws:

org.json.JSONException

setScales

public void setScales(java.util.TreeSet<java.lang.Number> scales)

isScalePresent

public boolean isScalePresent(double targetScale)

setHosts

public void setHosts(java.util.List<HostMatcher> hosts)

setFonts

public void setFonts(java.util.TreeSet<java.lang.String> fonts)

getFonts

public java.util.TreeSet<java.lang.String> getFonts()

setKeys

public void setKeys(java.util.TreeSet<Key> keys)

getKeys

public java.util.TreeSet<Key> getKeys()

validateUri

public boolean validateUri(java.net.URI uri)
                    throws java.net.UnknownHostException,
                           java.net.SocketException,
                           java.net.MalformedURLException

Make sure an URI is authorized

Throws:

java.net.UnknownHostException

java.net.SocketException

java.net.MalformedURLException

validate

public void validate()

Called just after the config has been loaded to check it is valid.

Throws:

InvalidValueException - When there is a problem

getBestScale

public double getBestScale(double target)

Returns:

The first scale that is bigger or equal than the target.

getMapRenderingExecutor

public OrderedResultsExecutor<MapTileTask> getMapRenderingExecutor()

close

public void close()

Stop all the threads and stuff used for this config.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

setGlobalParallelFetches

public void setGlobalParallelFetches(int globalParallelFetches)

setPerHostParallelFetches

public void setPerHostParallelFetches(int perHostParallelFetches)

getHttpClient

public org.apache.commons.httpclient.HttpClient getHttpClient(java.net.URI uri)

Get or create the http client to be used to fetch all the map data.

setTilecacheMerging

public void setTilecacheMerging(boolean tilecacheMerging)

isTilecacheMerging

public boolean isTilecacheMerging()

setDisableScaleLocking

public void setDisableScaleLocking(boolean disableScaleLocking)

isDisableScaleLocking

public boolean isDisableScaleLocking()

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getOutputFilename

public java.lang.String getOutputFilename(java.lang.String layoutName)

getOutputFilename

public java.lang.String getOutputFilename()

setOutputFilename

public void setOutputFilename(java.lang.String outputFilename)

getFormats

public java.util.TreeSet<java.lang.String> getFormats()

setFormats

public void setFormats(java.util.TreeSet<java.lang.String> formats)

setOverlayLayers

public void setOverlayLayers(java.util.List<java.lang.String> overlayLayers)

getOverlayLayers

public java.util.List<java.lang.String> getOverlayLayers()

getIntegerSvg

public boolean getIntegerSvg()

Returns:

the integerSvg true if for example MapServer 5.6 or earlier is used where integers are put into the SVG

setIntegerSvg

public void setIntegerSvg(boolean integerSvg)

Parameters:

integerSvg - the integerSvg to set

getReloadConfig

public boolean getReloadConfig()

Returns:

the reloadConfig

setReloadConfig

public void setReloadConfig(boolean reloadConfig)

Parameters:

reloadConfig - the reloadConfig to set

setSecurity

public void setSecurity(java.util.List<SecurityStrategy> security)

setMapReaderFactoryFinder

public void setMapReaderFactoryFinder(MapReaderFactoryFinder mapReaderFactoryFinder)

getMapReaderFactoryFinder

public MapReaderFactoryFinder getMapReaderFactoryFinder()

setLocalHostForward

public void setLocalHostForward(java.util.HashMap localHostForward)

localHostForwardIsHttps2http

public boolean localHostForwardIsHttps2http()

localHostForwardIsFrom

public boolean localHostForwardIsFrom(java.lang.String host)

setHeaders

public void setHeaders(java.util.TreeSet<java.lang.String> headers)

getHeaders

public java.util.TreeSet<java.lang.String> getHeaders()

setBrokenUrlPlaceholder

public void setBrokenUrlPlaceholder(java.lang.String brokenUrlPlaceholder)

getBrokenUrlPlaceholder

public java.lang.String getBrokenUrlPlaceholder()

getProxyBaseUrl

public java.lang.String getProxyBaseUrl()

Get the url of the proxy that resides between the servlet and the internet.

This method may return null if there is no proxy between the servlet and the internet.

Returns:

the url of the proxy that resides between the servlet and the internet.

setProxyBaseUrl

public void setProxyBaseUrl(java.lang.String proxyBaseUrl)

Set the url of the proxy that resides between the servlet and the internet.

This is an optional parameter as there may not be a proxy.

Parameters:

proxyBaseUrl - the url of the proxy as seen from the internet.

getTmsDefaultOriginX

public java.lang.Float getTmsDefaultOriginX()

Specify the default x - origin used by TMS map reader. If null then the value will be derived from maxExtent.

setTmsDefaultOriginX

public void setTmsDefaultOriginX(java.lang.Float tmsDefaultOriginX)

Specify the default x - origin used by TMS map reader. If null then the value will be derived from maxExtent.

getTmsDefaultOriginY

public java.lang.Float getTmsDefaultOriginY()

Specify the default y - origin used by TMS map reader. If null then the value will be derived from maxExtent.

setTmsDefaultOriginY

public void setTmsDefaultOriginY(java.lang.Float tmsDefaultOriginY)

Specify the default y - origin used by TMS map reader. If null then the value will be derived from maxExtent.

setThreadResources

public void setThreadResources(ThreadResources threadResources)

isIgnoreCapabilities

public boolean isIgnoreCapabilities()

setIgnoreCapabilities

public void setIgnoreCapabilities(boolean ignoreCapabilities)

getMaxPrintTimeBeforeWarningInSeconds

public int getMaxPrintTimeBeforeWarningInSeconds()

getPrintTimeoutMinutes

public int getPrintTimeoutMinutes()

setPrintTimeoutMinutes

public void setPrintTimeoutMinutes(int printTimeoutMinutes)

setMaxPrintTimeBeforeWarningInSeconds

public void setMaxPrintTimeBeforeWarningInSeconds(int maxPrintTimeBeforeWarningInSeconds)

setMetricRegistry

public void setMetricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()