nl.b3p.viewer.config.services

Class WMSService

java.lang.Object

nl.b3p.viewer.config.services.GeoService

nl.b3p.viewer.config.services.WMSService

All Implemented Interfaces:

Serializable, Updatable

@Entity
public class WMSService
extends GeoService
implements Updatable

Entity for saving WMS service metadata. Enables the administration module to easily work with WMS service entities and the viewer to quickly marshall the metadata without having to do a GetCapabilities request each time the viewer starts.

This requires an option to update the metadata should the service change, so this class implements Updatable.

Author:

Matthijs Laan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DETAIL_SUPPORT_SLD
static String	DETAIL_USER_STYLE
static String	PARAM_OVERRIDE_URL Parameter to specify the value for #getOverrideUrl().
static String	PROTOCOL JPA DiscriminatorValue for this class.

Fields inherited from class nl.b3p.viewer.config.services.GeoService

DETAIL_ORIGINAL_NAME, DETAIL_OVERRIDDEN_URL, DETAIL_USE_INTERSECT, DETAIL_USE_PROXY, PARAM_MUST_LOGIN, PARAM_ONLINE_CHECK_ONLY, PARAM_PASSWORD, PARAM_USERNAME

Constructor Summary

Constructors

Constructor and Description
WMSService()

Method Summary

Modifier and Type	Method and Description
WMSExceptionType	getException_type()
Boolean	getOverrideUrl() Whether to use the original URL the Capabilities was loaded with or the URL the WMS reports it is at in the Capabilities.
protected org.geotools.data.wms.WebMapServer	getWebMapServer() Construct the GeoTools WebMapServer metadata object.
protected void	load(org.geotools.data.wms.WebMapServer wms, Map params, WaitPageStatus status, javax.persistence.EntityManager em) Does the actual loading work.
WMSService	loadFromUrl(String url, Map params, WaitPageStatus status, javax.persistence.EntityManager em) Load WMS metadata from URL or only check if the service is online when PARAM_ONLINE_CHECK_ONLY is true.
void	loadLayerFeatureTypes(String wfsUrl, List<org.geotools.data.ows.LayerDescription> layerDescriptions, javax.persistence.EntityManager em) Set feature types for layers in the WMSService from the given WFS according to the DescribeLayer response.
void	setException_type(WMSExceptionType exception_type)
void	setOverrideUrl(Boolean overrideUrl)
String	toString()
UpdateResult	update(javax.persistence.EntityManager em) Reload the WMS capabilities metadata and update this entity if it is changed.

Methods inherited from class nl.b3p.viewer.config.services.GeoService

authorizationsModified, checkOnline, getAuthorizationsModified, getCategory, getDetails, getId, getKeywords, getLayer, getLayerChildrenCache, getName, getPassword, getProtocol, getReaders, getSingleLayer, getStyleLibraries, getTopLayer, getUrl, getUsername, initLayerCollectionsForUpdate, isMonitoringEnabled, isMonitoringStatusOK, loadFromUrl, loadLayerTree, removeAllLayers, setAllChildrenDetail, setAuthorizationsModified, setCategory, setDetails, setId, setKeywords, setMonitoringEnabled, setMonitoringStatusOK, setName, setPassword, setReaders, setStyleLibraries, setTopLayer, setUrl, setUsername, toJSONObject, toJSONObject, toJSONObject

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL

public static final String PROTOCOL

JPA DiscriminatorValue for this class.

See Also:

Constant Field Values

PARAM_OVERRIDE_URL

public static final String PARAM_OVERRIDE_URL

Parameter to specify the value for #getOverrideUrl().

See Also:

Constant Field Values

DETAIL_SUPPORT_SLD

public static final String DETAIL_SUPPORT_SLD

See Also:

Constant Field Values

DETAIL_USER_STYLE

public static final String DETAIL_USER_STYLE

See Also:

Constant Field Values

Constructor Detail

WMSService

public WMSService()

Method Detail

getOverrideUrl

public Boolean getOverrideUrl()

Whether to use the original URL the Capabilities was loaded with or the URL the WMS reports it is at in the Capabilities. Sometimes the URL reported by the WMS is outdated, but it can also be used to migrate the service to another URL or load Capabilities from a static XML Capabilities document on a simple HTTP server. According to the standard the URL in the Capabilities should be used, so set this to false by default except if the user requests an override.

Returns:

true when set

setOverrideUrl

public void setOverrideUrl(Boolean overrideUrl)

getException_type

public WMSExceptionType getException_type()

setException_type

public void setException_type(WMSExceptionType exception_type)

toString

public String toString()

Overrides:

toString in class Object

loadFromUrl

public WMSService loadFromUrl(String url,
                              Map params,
                              WaitPageStatus status,
                              javax.persistence.EntityManager em)
                       throws Exception

Load WMS metadata from URL or only check if the service is online when PARAM_ONLINE_CHECK_ONLY is true.

Specified by:

loadFromUrl in class GeoService

Parameters:

url - The location of the WMS.

params - Map containing parameters, keys are finals in this class.

status - For reporting progress.

em - the entity manager to use

Returns:

the service as retrieved from the url

Throws:

Exception - if any

load

protected void load(org.geotools.data.wms.WebMapServer wms,
                    Map params,
                    WaitPageStatus status,
                    javax.persistence.EntityManager em)
             throws IOException,
                    MalformedURLException,
                    org.geotools.ows.ServiceException

Does the actual loading work.

Parameters:

wms - WMS service

params - unused?

status - progress page

em - the entity manager to use

Throws:

IOException - when retrieving the capabilities

MalformedURLException - if wms capabilities has improper urls

org.geotools.ows.ServiceException - if any occurs parsng the capabilities etc.

getWebMapServer

protected org.geotools.data.wms.WebMapServer getWebMapServer()
                                                      throws IOException,
                                                             MalformedURLException,
                                                             org.geotools.ows.ServiceException

Construct the GeoTools WebMapServer metadata object.

Returns:

the webmapserver for this service

Throws:

IOException - when the http connection fails

MalformedURLException - when the url is invalid

org.geotools.ows.ServiceException - when the service is invalid

update

public UpdateResult update(javax.persistence.EntityManager em)

Reload the WMS capabilities metadata and update this entity if it is changed. If getOverrideUrl() is false, will pickup URL changes from the service.

Specified by:

update in interface Updatable

loadLayerFeatureTypes

public void loadLayerFeatureTypes(String wfsUrl,
                                  List<org.geotools.data.ows.LayerDescription> layerDescriptions,
                                  javax.persistence.EntityManager em)

Set feature types for layers in the WMSService from the given WFS according to the DescribeLayer response. When errors occur these are logged but no exception is thrown. Note: DescribeLayer may return multiple type names for a layer, this is not supported - only the first one is used.

Parameters:

wfsUrl - the WFS URL

layerDescriptions - description of which feature types of the WFS are used in layers of this service according to DescribeLayer

em - the entity manager to use