Package com.luciad.ogc.ows.model
Interface ILcdOWSTransport
- All Known Implementing Classes:
TLcdOWSHttpTransport
public interface ILcdOWSTransport
A transport layer to access OpenGIS Web Services.
- Since:
- 8.2
-
Method Summary
Modifier and TypeMethodDescriptiondefault boolean
canPerformRequest
(TLcdOWSOperation aOperation, ILcdOWSRequest aRequest) Fast check to see whether or not this transport is capable of performing the request.Creates an OpenGIS Web Service DCP that can be used to access the specified URI using this transport.boolean
isCompatibleURI
(URI aUri) Determines whether the specified URI is compatible with this transport.performRequest
(TLcdOWSOperation aOperation, ILcdOWSRequest aRequest) Performs the specified operation passing in the parameters defined in the request object.
-
Method Details
-
canPerformRequest
Fast check to see whether or not this transport is capable of performing the request.
When this method returns
false
,performRequest(TLcdOWSOperation, ILcdOWSRequest)
will not be capable of performing the request and throw an error. When this method returnstrue
, it is still possible that callingperformRequest(TLcdOWSOperation, ILcdOWSRequest)
throws an error (for example when the server is offline).The default implementation returns
true
.- Parameters:
aOperation
- The operationaRequest
- The request parameters- Returns:
false
when this transport cannot perform the request,true
when this transport probably can perform the request.- Since:
- 2018.0
-
performRequest
TLcdOWSInputStream performRequest(TLcdOWSOperation aOperation, ILcdOWSRequest aRequest) throws TLcdOWSTransportException Performs the specified operation passing in the parameters defined in the request object.- Parameters:
aOperation
- the operation to performaRequest
- the request parameters- Returns:
- a typed inputstream
- Throws:
TLcdOWSTransportException
- if an error occurs in the transport layer
-
isCompatibleURI
Determines whether the specified URI is compatible with this transport. When performing a request, a transport implementation should only attempt to use those access points whose URIs are compatible.- Parameters:
aUri
- the URI to test- Returns:
- true if the specified URI is compatible; false otherwise
-
createDCP
Creates an OpenGIS Web Service DCP that can be used to access the specified URI using this transport. This method can be used to create aTLcdOWSOperation
object that is needed to perform initial requests (in other words, requests that need to be performed before web service metadata has been retrieved).- Parameters:
aURI
- the URI- Returns:
- an OWS DCP object
- Throws:
NullPointerException
- if the specified URI is nullIllegalArgumentException
- if the specified URI is not compatible with this transport
-