nl.b3p.ogc.utils

Class OGCRequest

java.lang.Object

nl.b3p.ogc.utils.OGCCommunication

nl.b3p.ogc.utils.OGCRequest

All Implemented Interfaces:

OGCConstants

Direct Known Subclasses:

OGCScriptingRequest

public class OGCRequest
extends OGCCommunication
implements OGCConstants

Author:

Roy Braam

Field Summary

Fields

Modifier and Type	Field and Description
protected String	abbr
protected WFS_Capabilities	capabilities
protected String	finalVersion
protected HashMap	getFeatureFilterMap
protected HashMap	getFeaturePropertyNameListMap
protected String	httpHost
protected String	httpMethod
protected ArrayList	layers
protected static org.apache.commons.logging.Log	log
static List	NAMESPACES_NOT_IN_URL
protected HashMap	parameters
protected String	password
static HashMap	scaleCalibrations
protected String	serviceProviderName
protected HashMap	transactionList
protected String	username

Fields inherited from class nl.b3p.ogc.utils.OGCCommunication

nameSpaces, schemaLocations

Fields inherited from interface nl.b3p.ogc.utils.OGCConstants

FEATURE_INFO_FORMAT, FORMAT_GIF, FORMAT_INIMAGE, FORMAT_JPEG, FORMAT_PNG, FORMAT_TIFF, METADATA_LAYER, METADATA_XML, NON_REQUIRED_PARAMS_GetCapabilities, NON_REQUIRED_PARAMS_GetFeatureInfo, NON_REQUIRED_PARAMS_GetLegendGraphic, NON_REQUIRED_PARAMS_GetMap, NONOGC_SERVICE_METADATA, NONOGC_SERVICE_PROXY, PARAMS_DescribeLayer, PARAMS_GetFeatureInfo, PARAMS_GetLegendGraphic, PARAMS_GetMap, PROXY_URL, REQUEST, REQUIRED_PARAMS_GetCapabilities, REQUIRED_PARAMS_METADATA, REQUIRED_PARAMS_PROXY, SERVICE, SUPPORTED_EXCEPTIONS, SUPPORTED_REQUESTS, SUPPORTED_VERSIONS, SUPPORTED_WFS_REQUESTS, SUPPORTED_WFS_VERSIONS, UPDATESEQUENCE, VERSION, WFS_CAPABILITIES, WFS_DESCRIBEFEATURETYPE, WFS_FEATURECOLLECTION, WFS_GETCAPABILITIES, WFS_GETFEATURE, WFS_GETFEATUREWITHLOCK, WFS_LOCKFEATURE, WFS_OBJECT_CAPABILITIES, WFS_OBJECT_GEOMETRYTYPE, WFS_OBJECT_SERVICEEXCEPTIONREPORT, WFS_OWS_EXCEPTION, WFS_PARAM_BBOX, WFS_PARAM_EXPIRY, WFS_PARAM_FEATUREID, WFS_PARAM_FEATUREVERSION, WFS_PARAM_FILTER, WFS_PARAM_GMLOBJECTID, WFS_PARAM_HANDLE, WFS_PARAM_INPUTFORMAT, WFS_PARAM_LOCKID, WFS_PARAM_MAXFEATURES, WFS_PARAM_OPERATION, WFS_PARAM_OUTPUTFORMAT, WFS_PARAM_PROPERTYNAME, WFS_PARAM_PROPTRAVXLINKDEPTH, WFS_PARAM_PROPTRAVXLINKEXPIRY, WFS_PARAM_RELEASEACTION, WFS_PARAM_RESULTTYPE, WFS_PARAM_SORTBY, WFS_PARAM_SRSNAME, WFS_PARAM_TRAVERSEXLINKDEPTH, WFS_PARAM_TRAVERSEXLINKEXPIRY, WFS_PARAM_TYPENAME, WFS_REQUEST_DescribeFeatureType, WFS_REQUEST_GetCapabilities, WFS_REQUEST_GetFeature, WFS_REQUEST_GetFeatureWithLock, WFS_REQUEST_LockFeature, WFS_REQUEST_Transaction, WFS_REQUIRED_PARAMS_DescribeFeatureType, WFS_REQUIRED_PARAMS_GetCapabilities, WFS_REQUIRED_PARAMS_GetFeature, WFS_REQUIRED_PARAMS_Transaction, WFS_SERVER_EXCEPTION, WFS_SERVICE_WFS, WFS_TRANSACTION, WFS_TRANSACTION_DELETE, WFS_TRANSACTION_INSERT, WFS_TRANSACTION_NATIVE, WFS_TRANSACTION_UPDATE, WFS_TRANSACTIONRESPONSE, WFS_VERSION_100, WFS_VERSION_110, WFS_VERSION_UNSPECIFIED, WMS_PARAM_BBOX, WMS_PARAM_BGCOLOR, WMS_PARAM_ELEVATION, WMS_PARAM_EXCEPTION_BLANK, WMS_PARAM_EXCEPTION_FORMAT, WMS_PARAM_EXCEPTION_INIMAGE, WMS_PARAM_EXCEPTION_XML, WMS_PARAM_EXCEPTIONS, WMS_PARAM_FEATURECOUNT, WMS_PARAM_FEATURETYPE, WMS_PARAM_FORMAT, WMS_PARAM_GML, WMS_PARAM_HEIGHT, WMS_PARAM_INFO_FORMAT, WMS_PARAM_LAYER, WMS_PARAM_LAYERS, WMS_PARAM_QUERY_LAYERS, WMS_PARAM_RULE, WMS_PARAM_SCALE, WMS_PARAM_SHORT_EXCEPTION_INIMAGE, WMS_PARAM_SLD, WMS_PARAM_SLD_BODY, WMS_PARAM_SRS, WMS_PARAM_STYLE, WMS_PARAM_STYLES, WMS_PARAM_TIME, WMS_PARAM_TRANSPARENT, WMS_PARAM_TRANSPARENT_TRUE, WMS_PARAM_WFS, WMS_PARAM_WIDTH, WMS_PARAM_WMS_GML, WMS_PARAM_WMS_HTML, WMS_PARAM_WMS_XML, WMS_PARAM_X, WMS_PARAM_XML, WMS_PARAM_Y, WMS_REQUEST, WMS_REQUEST_DescribeLayer, WMS_REQUEST_GetCapabilities, WMS_REQUEST_GetFeatureInfo, WMS_REQUEST_GetLegendGraphic, WMS_REQUEST_GetMap, WMS_REQUEST_GetStyles, WMS_REQUEST_PutStyles, WMS_SERVICE, WMS_SERVICE_WMS, WMS_VERSION, WMS_VERSION_110, WMS_VERSION_111

Constructor Summary

Constructors

Constructor and Description
OGCRequest()
OGCRequest(Element rootElement, String url) Constructor For HTTP POST
OGCRequest(String url) Main constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addElementToTransactionList(Object element, String spAbbr)
void	addGetFeatureFilterMap(String key, Object value)
void	addGetFeaturePropertyNameListMap(String key, Object value)
String	addOrReplaceParameter(String param, String v) Adds or replaces a param with a value
int	addOrReplaceParameters(String params) Adds or replaces a string with params
double	calcScale()
double	calcScale(double scaleCalibration) Deze methode berekent de schaal waarbij de diagonaal van de viewport in pixels wordt omgerekend naar kaarteenheden.
void	checkRequestURL()
protected void	checkRequestURL(List requiredParams, String request)
Object	clone()
boolean	containsParameter(String param)
static String	findPersonalCode(String httpHost)
static String	findServiceProviderName(String httpHost)
static String[]	findServiceProviderNameAndPersonalCode(String httpHost) uitzoeken of de serviceprovider in de url zit, geldige patronen zijn: http://server/services/sp/pcode http://server/services/sp/pcode/ http://server/services/pcode http://server/services/pcode/ ongeldig zijn: http://server/services/sp/ http://server/services/sp sp wordt als code geinterpreteerd.
String	fixHttpHost(String httpHost)
String	getAbbr()
WFS_Capabilities	getCapabilities()
String	getFinalVersion()
String	getGetFeatureFilter(String key)
HashMap	getGetFeatureFilterMap()
String	getGetFeaturePropertyNameList(String key)
HashMap	getGetFeaturePropertyNameListMap()
String	getHttpHost()
String	getHttpMethod()
ArrayList	getLayers()
HashMap	getNonOGCParameters()
String	getParameter(String param) Return the value of the given param
protected HashMap	getParameters()
String[]	getParametersArray()
String	getPassword()
String	getPersonalCode()
String	getServiceProviderName()
List	getTransactionElementList(String spAbbr)
HashMap	getTransactionMap()
String[]	getTransactionSpList()
String	getUrl() Gets the full url with the params
String	getUrl(String host)
String	getUrlWithNonOGCparams()
String	getUsername()
String	getXMLBody()
void	removeAllWFSParameters() Removes all WFS parameters (version 1.0.0???)
void	removeAllWMSParameters() Removes all WMS parameters (version 1.1.1)
static String	removeNamespace(String tagName)
String	removeParameter(String param) Removes a parameter
void	setAbbr(String abbr)
void	setCapabilities(WFS_Capabilities capabilities)
void	setDescribeFeatureTypeV100(DescribeFeatureType describeFeatureType)
void	setDescribeFeatureTypeV110(DescribeFeatureType describeFeatureType)
void	setFinalVersion(String clientVersion)
void	setGetCapabilitiesV100(GetCapabilities getCapabilities) Serie of methods to fill the HashMap parameters
void	setGetCapabilitiesV110(GetCapabilities getCapabilities)
void	setGetFeatureFilterMap(HashMap getFeatureFilterMap)
void	setGetFeaturePropertyNameListMap(HashMap getFeaturePropertyNameListMap)
void	setGetFeatureV100(GetFeature getFeature)
void	setGetFeatureV110(GetFeature getFeature)
void	setHttpHost(String host)
void	setHttpMethod(String method)
void	setLayers(ArrayList layers)
protected void	setParameters(HashMap parameters)
void	setPassword(String password)
void	setPersonalCode(String personalCode)
void	setServiceProviderName(String sp)
void	setTransactionElementList(List elements, String spAbbr)
void	setTransactionMap(HashMap transactionList)
void	setTransactionV100(Transaction transaction)
void	setTransactionV110(Transaction transaction)
void	setUrl(String url) Main methode to fill the OGUrl object
void	setUsername(String username)
String	toString()

Methods inherited from class nl.b3p.ogc.utils.OGCCommunication

addOpengisNamespaces, addOpengisSchemaLocations, addOrReplaceNameSpace, addOrReplaceSchemaLocation, attachSp, attachSpNs, buildFullLayerName, buildLayerNameWithoutNs, buildLayerNameWithoutSp, cleanPrefixInBody, determineFeatureTypeName, findNameSpace, fixNsPrefix, getLayerName, getNameSpace, getNamespaceContext, getNameSpacePrefix, getNameSpacePrefix, getNameSpaces, getNameSpacesArray, getSchemaLocations, getSchemaLocationsArray, replaceIds, setNameSpaces, setSchemaLocations, splitLayerInParts, splitLayerInParts, splitLayerWithoutNsFix, splitLayerWithoutNsFix, splitLayerWithoutNsFix, stripNs, toCodeAndName

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

httpMethod

protected String httpMethod

httpHost

protected String httpHost

capabilities

protected WFS_Capabilities capabilities

parameters

protected HashMap parameters

transactionList

protected HashMap transactionList

getFeatureFilterMap

protected HashMap getFeatureFilterMap

getFeaturePropertyNameListMap

protected HashMap getFeaturePropertyNameListMap

abbr

protected String abbr

layers

protected ArrayList layers

username

protected String username

password

protected String password

finalVersion

protected String finalVersion

serviceProviderName

protected String serviceProviderName

NAMESPACES_NOT_IN_URL

public static final List NAMESPACES_NOT_IN_URL

scaleCalibrations

public static final HashMap scaleCalibrations

Constructor Detail

OGCRequest

public OGCRequest()

OGCRequest

public OGCRequest(String url)

Main constructor

Parameters:

url - The url that fills the OGCUrl object For HTTP GET

OGCRequest

public OGCRequest(Element rootElement,
          String url)
           throws org.exolab.castor.xml.ValidationException,
                  Exception

Constructor For HTTP POST

Throws:

org.exolab.castor.xml.ValidationException

Exception

Method Detail

removeNamespace

public static String removeNamespace(String tagName)

setGetCapabilitiesV100

public final void setGetCapabilitiesV100(GetCapabilities getCapabilities)

Serie of methods to fill the HashMap parameters

setGetCapabilitiesV110

public final void setGetCapabilitiesV110(GetCapabilities getCapabilities)

setDescribeFeatureTypeV100

public final void setDescribeFeatureTypeV100(DescribeFeatureType describeFeatureType)

setDescribeFeatureTypeV110

public final void setDescribeFeatureTypeV110(DescribeFeatureType describeFeatureType)

setGetFeatureV100

public final void setGetFeatureV100(GetFeature getFeature)
                             throws Exception

Throws:

Exception

setGetFeatureV110

public final void setGetFeatureV110(GetFeature getFeature)
                             throws Exception

Throws:

Exception

setTransactionV100

public final void setTransactionV100(Transaction transaction)
                              throws Exception

Throws:

Exception

setTransactionV110

public final void setTransactionV110(Transaction transaction)
                              throws Exception

Throws:

Exception

addElementToTransactionList

public void addElementToTransactionList(Object element,
                               String spAbbr)

getTransactionMap

public HashMap getTransactionMap()

setTransactionMap

public void setTransactionMap(HashMap transactionList)

getTransactionElementList

public List getTransactionElementList(String spAbbr)

setTransactionElementList

public void setTransactionElementList(List elements,
                             String spAbbr)

getTransactionSpList

public String[] getTransactionSpList()

setAbbr

public void setAbbr(String abbr)

getAbbr

public String getAbbr()

getLayers

public ArrayList getLayers()

getGetFeatureFilterMap

public HashMap getGetFeatureFilterMap()

setGetFeatureFilterMap

public void setGetFeatureFilterMap(HashMap getFeatureFilterMap)

addGetFeatureFilterMap

public void addGetFeatureFilterMap(String key,
                          Object value)

getGetFeatureFilter

public String getGetFeatureFilter(String key)

getGetFeaturePropertyNameListMap

public HashMap getGetFeaturePropertyNameListMap()

setGetFeaturePropertyNameListMap

public void setGetFeaturePropertyNameListMap(HashMap getFeaturePropertyNameListMap)

addGetFeaturePropertyNameListMap

public void addGetFeaturePropertyNameListMap(String key,
                                    Object value)

getGetFeaturePropertyNameList

public String getGetFeaturePropertyNameList(String key)

setUrl

public final void setUrl(String url)

Main methode to fill the OGUrl object

Parameters:

url - The url that fills the OGCUrl object

getUrl

public String getUrl()

Gets the full url with the params

Returns:

the full url.

getUrl

public String getUrl(String host)

getXMLBody

public String getXMLBody()
                  throws Exception

Throws:

Exception

getUrlWithNonOGCparams

public String getUrlWithNonOGCparams()

removeParameter

public String removeParameter(String param)

Removes a parameter

Parameters:

param - The definition of the param that needs to be removed.

Returns:

the param value that is removed or null if the parameter key not is found

getParameter

public final String getParameter(String param)

Return the value of the given param

Parameters:

param - the param definition

Returns:

the value of the given param or null if the param isn't found.

containsParameter

public final boolean containsParameter(String param)

getNonOGCParameters

public HashMap getNonOGCParameters()

addOrReplaceParameter

public String addOrReplaceParameter(String param,
                           String v)

Adds or replaces a param with a value

Parameters:

param - The definition of the param that needs to be added or replaced.

value - The value that needs to be added

Returns:

previous value associated with specified param, or null if there was no mapping for param

addOrReplaceParameters

public int addOrReplaceParameters(String params)

Adds or replaces a string with params

Parameters:

params - A String with parameters seperated by a '&'

Returns:

the number of added params

removeAllWMSParameters

public void removeAllWMSParameters()

Removes all WMS parameters (version 1.1.1)

removeAllWFSParameters

public void removeAllWFSParameters()

Removes all WFS parameters (version 1.0.0???)

toString

public String toString()

Overrides:

toString in class Object

getParametersArray

public String[] getParametersArray()

clone

public Object clone()

Overrides:

clone in class Object

getHttpHost

public String getHttpHost()

setHttpHost

public void setHttpHost(String host)

fixHttpHost

public String fixHttpHost(String httpHost)

findServiceProviderNameAndPersonalCode

public static String[] findServiceProviderNameAndPersonalCode(String httpHost)

uitzoeken of de serviceprovider in de url zit, geldige patronen zijn:

http://server/services/sp/pcode http://server/services/sp/pcode/ http://server/services/pcode http://server/services/pcode/ ongeldig zijn: http://server/services/sp/ http://server/services/sp sp wordt als code geinterpreteerd.

findServiceProviderName

public static String findServiceProviderName(String httpHost)

findPersonalCode

public static String findPersonalCode(String httpHost)

setServiceProviderName

public void setServiceProviderName(String sp)

getServiceProviderName

public String getServiceProviderName()

getPersonalCode

public String getPersonalCode()

Returns:

the personalCode

setPersonalCode

public void setPersonalCode(String personalCode)

Parameters:

personalCode - the personalCode to set

setHttpMethod

public void setHttpMethod(String method)

Parameters:

method - - the HTTP method of the request (GET/POST/etc)

getHttpMethod

public String getHttpMethod()

Returns:

http method (GET/POST/etc)

getParameters

protected HashMap getParameters()

setParameters

protected void setParameters(HashMap parameters)

checkRequestURL

public void checkRequestURL()
                     throws Exception

Throws:

Exception

checkRequestURL

protected void checkRequestURL(List requiredParams,
                   String request)
                        throws Exception

Throws:

Exception

getCapabilities

public WFS_Capabilities getCapabilities()

setCapabilities

public void setCapabilities(WFS_Capabilities capabilities)

setFinalVersion

public final void setFinalVersion(String clientVersion)

calcScale

public double calcScale()

calcScale

public double calcScale(double scaleCalibration)

Deze methode berekent de schaal waarbij de diagonaal van de viewport in pixels wordt omgerekend naar kaarteenheden.

Parameters:

scaleCalibration - omrekenfactor van pixels naar kaarteenheden.

Returns:

schaal van de kaart

getFinalVersion

public String getFinalVersion()

getUsername

public String getUsername()

Returns:

the username

setUsername

public void setUsername(String username)

Parameters:

username - the username to set

getPassword

public String getPassword()

Returns:

the password

setPassword

public void setPassword(String password)

Parameters:

password - the password to set

setLayers

public void setLayers(ArrayList layers)

Parameters:

layers - the layers to set