org.gvsig.raster.wmts.ogc.impl.base

Class WMTSProtocolHandler

java.lang.Object

org.gvsig.raster.wmts.ogc.impl.base.WMTSProtocolHandler

Direct Known Subclasses:

WMTSProtocolHandler1_0_0

public abstract class WMTSProtocolHandler
extends java.lang.Object

Abstract class that represents handlers to comunicate via WMS protocol.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	encoding Encoding used to parse different xml documents.
protected boolean	forceChangeAxisOrder
protected java.lang.String	host
protected java.lang.String	name
protected java.lang.String	port
protected java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
WMTSProtocolHandler()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildCapabilitiesSuitableVersionRequest(java.lang.String _host, java.lang.String _version) Builds the GetCapabilitiesRequest according to the OGC WMS Specifications without a VERSION, to get the highest version than a WMS supports.
protected abstract WMTSGetCapabilitiesRequest	createGetCapabilitiesRequest()
protected abstract WMTSGetFeatureInfoRequest	createGetFeatureInfoRequest(WMTSStatusImpl status, int x, int y)
protected abstract WMTSGetTileRequest	createGetTileRequest(WMTSStatusImpl status)
java.io.File	downloadFile(java.net.URL url, ICancellable cancel, java.io.File forceFile)
protected byte[]	fileToBytes(java.io.File file) Copy the file in a byte array
java.lang.String	getBaseURL(java.lang.String operation) Gets the URL base for a operation (GetCapabilities, GetTile, ...)
java.lang.String	getBaseURL(java.lang.String operation, int protocol) Gets the URL base for a operation (GetCapabilities, GetTile, ...) and a protocol GET or POST
void	getCapabilities(WMTSServerDescription status, boolean override, ICancellable cancel) Builds a GetCapabilities request that is sent to the WMS the response will be parse to extract the data needed by the WMS client
java.lang.String	getFeatureInfo(WMTSStatusImpl status, int x, int y, ICancellable cancel) It will send a GetFeatureInfo request to the WMTS Parsing the response and redirecting the info to the WMTS client TODO: return a stored file instead a String.
java.lang.String	getHost()
java.io.File	getLegendGraphic(WMTSLayer layer, WMTSStyle style, ICancellable cancel)
java.lang.String	getName()
java.lang.String	getPort()
WMTSServerDescription	getServerDescription()
java.lang.String	getSymbol(java.lang.String h) Just for not repeat code.
java.io.File	getTile(java.lang.String url, ICancellable cancel, java.io.File file)
java.io.File	getTile(WMTSStatus status, ICancellable cancel)
java.io.File	getTile(WMTSStatusImpl status, ICancellable cancel, java.io.File file)
java.net.URL	getTileURL(WMTSStatusImpl status)
java.lang.String	getVersion()
abstract boolean	parseCapabilities(java.io.File f) parses the data retrieved by the Capabilities XML document
protected java.lang.String	parseException(byte[] data)
void	setForceChangeAxisOrder(boolean force) Sets longitude first in the axis order read from the capabilities file
void	setHost(java.lang.String host)
void	setName(java.lang.String name)
void	setPort(java.lang.String port)
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Field Detail

encoding

protected java.lang.String encoding

Encoding used to parse different xml documents.

forceChangeAxisOrder

protected boolean forceChangeAxisOrder

name

protected java.lang.String name

version

protected java.lang.String version

host

protected java.lang.String host

port

protected java.lang.String port

Constructor Detail

WMTSProtocolHandler

public WMTSProtocolHandler()

Method Detail

createGetFeatureInfoRequest

protected abstract WMTSGetFeatureInfoRequest createGetFeatureInfoRequest(WMTSStatusImpl status,
                                                                         int x,
                                                                         int y)

createGetTileRequest

protected abstract WMTSGetTileRequest createGetTileRequest(WMTSStatusImpl status)

createGetCapabilitiesRequest

protected abstract WMTSGetCapabilitiesRequest createGetCapabilitiesRequest()

parseCapabilities

public abstract boolean parseCapabilities(java.io.File f)

parses the data retrieved by the Capabilities XML document

getServerDescription

public WMTSServerDescription getServerDescription()

getHost

public java.lang.String getHost()

Returns:

Returns the host.

setHost

public void setHost(java.lang.String host)

Parameters:

host - The host to set.

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

getPort

public java.lang.String getPort()

Returns:

Returns the port.

setPort

public void setPort(java.lang.String port)

Parameters:

port - The port to set.

getVersion

public java.lang.String getVersion()

Returns:

Returns the version.

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - The version to set.

getSymbol

public java.lang.String getSymbol(java.lang.String h)

Just for not repeat code. Gets the correct separator according to the server URL

Parameters:

h -

Returns:

fileToBytes

protected byte[] fileToBytes(java.io.File file)
                      throws java.io.IOException

Copy the file in a byte array

Parameters:

file - The file to copy

Returns:

An array of bytes

Throws:

java.io.IOException

setForceChangeAxisOrder

public void setForceChangeAxisOrder(boolean force)

Sets longitude first in the axis order read from the capabilities file

Parameters:

force -

getTile

public java.io.File getTile(WMTSStatusImpl status,
                            ICancellable cancel,
                            java.io.File file)
                     throws ServerErrorException,
                            WMTSException

Throws:

ServerErrorException

WMTSException

getTile

public java.io.File getTile(WMTSStatus status,
                            ICancellable cancel)
                     throws ServerErrorException,
                            WMTSException

Throws:

ServerErrorException

WMTSException

getTile

public java.io.File getTile(java.lang.String url,
                            ICancellable cancel,
                            java.io.File file)
                     throws ServerErrorException,
                            WMTSException

Throws:

ServerErrorException

WMTSException

getTileURL

public java.net.URL getTileURL(WMTSStatusImpl status)
                        throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getBaseURL

public java.lang.String getBaseURL(java.lang.String operation)

Gets the URL base for a operation (GetCapabilities, GetTile, ...)

Parameters:

operation -

Returns:

the base URL for the GET protocol or the host passed by the user if it does not exists.

getBaseURL

public java.lang.String getBaseURL(java.lang.String operation,
                                   int protocol)

Gets the URL base for a operation (GetCapabilities, GetTile, ...) and a protocol GET or POST

Parameters:

operation -

Returns:

the base URL for this protocol or null if it does not exists.

downloadFile

public java.io.File downloadFile(java.net.URL url,
                                 ICancellable cancel,
                                 java.io.File forceFile)
                          throws DownloadException

Throws:

DownloadException

getLegendGraphic

public java.io.File getLegendGraphic(WMTSLayer layer,
                                     WMTSStyle style,
                                     ICancellable cancel)
                              throws ServerErrorException,
                                     WMTSException,
                                     DownloadException

Returns:

string that represents the url for getting the wms legend If the layer has the object layer-->style-->legendurl that url will be returned otherwise builds the getLegendGraphic according to the OGC WMS Specifications

Throws:

ServerErrorException

WMTSException

DownloadException

getFeatureInfo

public java.lang.String getFeatureInfo(WMTSStatusImpl status,
                                       int x,
                                       int y,
                                       ICancellable cancel)

It will send a GetFeatureInfo request to the WMTS Parsing the response and redirecting the info to the WMTS client

TODO: return a stored file instead a String.

getCapabilities

public void getCapabilities(WMTSServerDescription status,
                            boolean override,
                            ICancellable cancel)

Builds a GetCapabilities request that is sent to the WMS the response will be parse to extract the data needed by the WMS client

Parameters:

override, - if true the previous downloaded data will be overridden

buildCapabilitiesSuitableVersionRequest

public static java.lang.String buildCapabilitiesSuitableVersionRequest(java.lang.String _host,
                                                                       java.lang.String _version)

Builds the GetCapabilitiesRequest according to the OGC WMS Specifications without a VERSION, to get the highest version than a WMS supports.

parseException

protected java.lang.String parseException(byte[] data)
                                   throws java.io.IOException

Throws:

java.io.IOException