nl.b3p.viewer.config.services

Class GeoService

java.lang.Object

nl.b3p.viewer.config.services.GeoService

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArcGISService, ArcIMSService, TileService, WMSService

@Entity
public abstract class GeoService
extends Object
implements Serializable

Author:

Matthijs Laan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DETAIL_ORIGINAL_NAME
static String	DETAIL_OVERRIDDEN_URL
static String	DETAIL_USE_INTERSECT
static String	DETAIL_USE_PROXY
static String	PARAM_MUST_LOGIN
static String	PARAM_ONLINE_CHECK_ONLY
static String	PARAM_PASSWORD HTTP Basic authentication password to use with pre-emptive authentication.
static String	PARAM_USERNAME HTTP Basic authentication username to use with pre-emptive authentication.

Constructor Summary

Constructors

Constructor and Description
GeoService()

Method Summary

Modifier and Type	Method and Description
void	authorizationsModified()
void	checkOnline(javax.persistence.EntityManager em)
Date	getAuthorizationsModified()
Category	getCategory()
Map<String,ClobElement>	getDetails()
Long	getId()
Set<String>	getKeywords()
Layer	getLayer(String layerName, javax.persistence.EntityManager em) Returns the layer with the given name in this server.
List<Layer>	getLayerChildrenCache(Layer l, javax.persistence.EntityManager em)
String	getName()
String	getPassword()
String	getProtocol()
Layer	getSingleLayer(String layerName, javax.persistence.EntityManager em) Gets a single layer without loading all layers.
List<StyleLibrary>	getStyleLibraries()
Layer	getTopLayer()
String	getUrl()
String	getUsername()
void	initLayerCollectionsForUpdate()
boolean	isMonitoringEnabled()
boolean	isMonitoringStatusOK()
GeoService	loadFromUrl(String url, Map params, javax.persistence.EntityManager em)
abstract GeoService	loadFromUrl(String url, Map params, WaitPageStatus waitStatus, javax.persistence.EntityManager em)
List<Layer>	loadLayerTree(javax.persistence.EntityManager em) To prevent a lot of SQL requests walking a tree structure of entities, load all layers using an efficient query.
void	removeAllLayers()
protected static void	setAllChildrenDetail(Layer layer, javax.persistence.EntityManager em)
void	setAuthorizationsModified(Date authorizationsModified)
void	setCategory(Category category)
void	setDetails(Map<String,ClobElement> details)
void	setId(Long id)
void	setKeywords(Set<String> keywords)
void	setMonitoringEnabled(boolean monitoringEnabled)
void	setMonitoringStatusOK(boolean monitoringStatusOK)
void	setName(String name)
void	setPassword(String password)
void	setStyleLibraries(List<StyleLibrary> styleLibraries)
void	setTopLayer(Layer topLayer)
void	setUrl(String url)
void	setUsername(String username)
org.json.JSONObject	toJSONObject(boolean includeLayerTree, javax.persistence.EntityManager em)
org.json.JSONObject	toJSONObject(boolean includeLayerTree, Set<String> layersToInclude, boolean validXmlTags, boolean includeAuthorizations, javax.persistence.EntityManager em)
org.json.JSONObject	toJSONObject(boolean includeLayerTree, Set<String> layersToInclude, boolean validXmlTags, javax.persistence.EntityManager em)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ONLINE_CHECK_ONLY

public static final String PARAM_ONLINE_CHECK_ONLY

See Also:

Constant Field Values

PARAM_MUST_LOGIN

public static final String PARAM_MUST_LOGIN

See Also:

Constant Field Values

DETAIL_OVERRIDDEN_URL

public static final String DETAIL_OVERRIDDEN_URL

See Also:

Constant Field Values

DETAIL_ORIGINAL_NAME

public static final String DETAIL_ORIGINAL_NAME

See Also:

Constant Field Values

DETAIL_USE_INTERSECT

public static final String DETAIL_USE_INTERSECT

See Also:

Constant Field Values

DETAIL_USE_PROXY

public static final String DETAIL_USE_PROXY

See Also:

Constant Field Values

PARAM_USERNAME

public static final String PARAM_USERNAME

HTTP Basic authentication username to use with pre-emptive authentication.

See Also:

Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD

HTTP Basic authentication password to use with pre-emptive authentication.

See Also:

Constant Field Values

Constructor Detail

GeoService

public GeoService()

Method Detail

getId

public Long getId()

setId

public void setId(Long id)

getName

public String getName()

setName

public void setName(String name)

getCategory

public Category getCategory()

setCategory

public void setCategory(Category category)

getTopLayer

public Layer getTopLayer()

setTopLayer

public void setTopLayer(Layer topLayer)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getKeywords

public Set<String> getKeywords()

setKeywords

public void setKeywords(Set<String> keywords)

isMonitoringEnabled

public boolean isMonitoringEnabled()

setMonitoringEnabled

public void setMonitoringEnabled(boolean monitoringEnabled)

getAuthorizationsModified

public Date getAuthorizationsModified()

setAuthorizationsModified

public void setAuthorizationsModified(Date authorizationsModified)

isMonitoringStatusOK

public boolean isMonitoringStatusOK()

setMonitoringStatusOK

public void setMonitoringStatusOK(boolean monitoringStatusOK)

getDetails

public Map<String,ClobElement> getDetails()

setDetails

public void setDetails(Map<String,ClobElement> details)

getStyleLibraries

public List<StyleLibrary> getStyleLibraries()

setStyleLibraries

public void setStyleLibraries(List<StyleLibrary> styleLibraries)

removeAllLayers

public void removeAllLayers()

initLayerCollectionsForUpdate

public void initLayerCollectionsForUpdate()

loadFromUrl

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

Throws:

Exception

loadFromUrl

public abstract GeoService loadFromUrl(String url,
                                       Map params,
                                       WaitPageStatus waitStatus,
                                       javax.persistence.EntityManager em)
                                throws Exception

Throws:

Exception

setAllChildrenDetail

protected static void setAllChildrenDetail(Layer layer,
                                           javax.persistence.EntityManager em)

checkOnline

public void checkOnline(javax.persistence.EntityManager em)
                 throws Exception

Throws:

Exception

getProtocol

public String getProtocol()

authorizationsModified

public void authorizationsModified()

loadLayerTree

public List<Layer> loadLayerTree(javax.persistence.EntityManager em)

To prevent a lot of SQL requests walking a tree structure of entities, load all layers using an efficient query. The Layers.children collections are not initialized, but can be reconstructed from the list of all Layers for this service returned by the query. Call Layer.getLayerChildrenCache() to retrieve it without causing a SQL query. The cache is not updated on changes, so will only represent the database state when loadLayerTree() was last called.

Parameters:

em - the entity manager to use

Returns:

the list of layers of this service

getLayerChildrenCache

public List<Layer> getLayerChildrenCache(Layer l,
                                         javax.persistence.EntityManager em)

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeLayerTree,
                                        Set<String> layersToInclude,
                                        boolean validXmlTags,
                                        javax.persistence.EntityManager em)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeLayerTree,
                                        Set<String> layersToInclude,
                                        boolean validXmlTags,
                                        boolean includeAuthorizations,
                                        javax.persistence.EntityManager em)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

toJSONObject

public org.json.JSONObject toJSONObject(boolean includeLayerTree,
                                        javax.persistence.EntityManager em)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

getSingleLayer

public Layer getSingleLayer(String layerName,
                            javax.persistence.EntityManager em)

Gets a single layer without loading all layers. If multiple layers exist with the same name, a random non-virtual layer is returned.

Parameters:

layerName - the name of the layer to find

Returns:

the named layer

getLayer

public Layer getLayer(String layerName,
                      javax.persistence.EntityManager em)

Returns the layer with the given name in this server. The first layer in a depth-first tree traversal with the name is returned. If a child has the same name as its parent, the child is returned.

Parameters:

layerName - the layer name to search for

em - the entity manager to use

Returns:

the Layer or null if not found