Global Configuration Parameters

The Map Tiling Service configuration consists of a set of global parameters that define how tiles are rendered.

The following are global configuration paramaters:

Parameter Type Required Description
RepositoryURL string yes The URL defines the location of your local repository where resource are stored that are accessed by the Map Tiling service. This URL should point to the Repository Service rmi, for example: http://<server>:<port>/RepositoryService/rmi
Note: In most instances, this URL should not be changed.
OSBM Parameters Internally, the Map Tiling service draws tiles to an offscreen bitmap (OSBM) (e.g., BufferedImage). To help speed up rendering of tiles by reducing garbage collection pauses, pools of offscreen bitmaps may be used to avoid constantly creating new ones. The OSBMPooling configuration controls how the offscreen bitmaps are created in memory. If the OSBM pooling section of the configuration is removed, then pooling will not be enabled.
MaxActive integer no Controls the maximum number of offscreen bitmaps (per tile dimension) that can be allocated by the pool (checked out to client threads, or idle in the pool) at one time. When non-positive, there is no limit to the number of objects per key. When this value is reached, the keyed pool is said to be exhausted. The default setting for this parameter is 8.
MinIdle integer no The minimum number of idle offscreen bitmaps (per tile dimension) that should always be available. If this parameter is set to a positive number and TimeBetweenEvictionRunsMills is greater than zero, each time the idle object eviction thread runs, it will try to create enough idle instances so that there will be this number of idle instances available under each key. The default setting for this parameter is 0.
MaxIdle integer no The maximum number of offscreen bitmap that can sit idle in the pool (per tile dimension) at any time. When negative, there is no limit to the number of objects that may be idle per key. The default setting for this parameter is 8.
MaxTotal integer no The global limit on the number of objects that can be in circulation (active or idle) within the combined set of pools. When non-positive, there is no limit to the total number of objects in circulation. When MaxTotal is exceeded, all keyed pools are exhausted. When MaxTotal is set to a positive value and an offscreen bitmap is requested when at the limit with no idle instances available, an attempt is made to create room by clearing the oldest fifteen percent (15%) of the elements from the keyed pools. The default setting for this parameter is -1 (no limit).
ExhaustedAction string no

The behavior when the pool of offscreen bitmaps is exhausted. The options are fail, grow, or block. Fail will throw an exception when an offscreen bitmap is requested when the pool is exhausted. Grow, the default, will create a new offscreen bitmap and return it, making MaxActive meaningless. Block will stop the process until a new or idle object is available.

Optionally, one may configure the pool to examine and possibly evict objects as they sit idle in the pool and to ensure that a minimum number of idle objects is maintained for each key. This is performed by an idle object eviction thread, which runs asynchronously. Caution should be used when configuring this optional feature.

Eviction runs require an exclusive synchronization lock on the pool. If they run too frequently or incur excessive latency when creating, destroying or validating object instances, performance issues may result. The idle object eviction thread may be configured using the MinEvictableIdleTimeMills and TimeBetweenEvictionRunsMills parameters.

MinEvictableIdleTimeMills integer no The minimum amount of time that an offscreen bitmap may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no object will be dropped from the pool due to idle time alone. This parameter has no effect unless TimeBetweenEvictionRunsMillis is greater than zero. The default setting for this parameter is 30 minutes.
TimeBetweenEvictionRunsMills integer no How long the eviction thread should sleep before examining idle offscreen bitmaps. When non-positive, no eviction thread will be launched. The default setting for this parameter is -1 (i.e., by default, idle object eviction is disabled).
Tile cache The following parameters refer to the built-in tile caching mechanism available through the Map Tiling Service.
Cache enabled boolean no Set to true to enable caching. If you are using a custom cache mechanism, set this to false.
diskPath string no The location of the cache. For example C:/Program Files/Pitney Bowes/Spectrum/server/modules/spatial/TileCache
tilePathPattern string no value="mapName/level/row"/
tileNamePattern string no value="column.mimeType"/
zeroBasedTile boolean no Set to true to start the tile level at zero.