com.luciad.ogc.ows.model

LuciadLightspeedInterface ILcdOWSRequest

All Known Implementing Classes:

TLcdCSWGetRecordByIdRequest, TLcdCSWGetRecordsRequest, TLcdWCSDescribeCoverageRequest, TLcdWCSGetCapabilitiesRequest, TLcdWCSGetCoverageRequest, TLcdWFSDescribeFeatureTypeRequest, TLcdWFSGetCapabilitiesRequest, TLcdWFSGetFeatureRequest, TLcdWFSGetFeatureWithLockRequest, TLcdWFSLockFeatureRequest, TLcdWFSTransactionRequest, TLcdWMSDescribeLayerRequest, TLcdWMSGetCapabilitiesRequest, TLcdWMSGetFeatureInfoRequest, TLcdWMSGetLegendGraphicRequest, TLcdWMSGetMapRequest

public interface ILcdOWSRequest

A request to an OpenGIS Web Service (OWS). An OWS request can be encoded either as a key-value pair (KVP) or as an XML fragment.

Since:

8.2

Method Summary

Modifier and Type	Method and Description
Map	getKVPEncoding() Returns a key-value pair (KVP) encoding of this request.
URI	getRestEncoding(URI aBaseURI) Returns a URI that can be used to perform the request.
Object	getTransportData() Returns an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request.
InputStream	getXMLEncoding() Returns the XML encoding of this request.

Method Detail

getKVPEncoding

Map getKVPEncoding()

Returns a key-value pair (KVP) encoding of this request.

If no key-value pairs are defined, an empty map should be returned. If no key-value pair encoding is supported for this request, null should be returned.

Returns:

the key-value pair (KVP) representation of this request.

Throws:

IllegalStateException - if the request is invalid

getXMLEncoding

InputStream getXMLEncoding()

Returns the XML encoding of this request.

If no XML encoding is supported for this request, nullshould be returned.

Returns:

the XML representation of this request.

Throws:

IllegalStateException - if the request is invalid

getRestEncoding

URI getRestEncoding(URI aBaseURI)

Returns a URI that can be used to perform the request.

If this request cannot be fulfilled through REST, return null.

Parameters:

aBaseURI - the base URI to be used to construct the REST encoding

Returns:

An URI that can fulfill the request, or null if REST is not supported.

Throws:

IllegalStateException - if the request is invalid

Since:

2013.0

getTransportData

Object getTransportData()

Returns an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request. The type of object and the data contained in it depends on the ILcdOWSTransport object used to perform this request.

An example in the case of a HTTP transport connection is a map of request properties (see URLConnection.getRequestProperties()) to be used for the request.

Returns:

an object representing data to be used by the transportation layer to perform this OGC Web Service request.