public abstract class ALcdWMSCapabilitiesProvider extends Object implements ILcdWMSCapabilitiesProvider
Constructor and Description |
---|
ALcdWMSCapabilitiesProvider() |
Modifier and Type | Method and Description |
---|---|
List<ALcdWMSLayer> |
getLayers(List<String> aLayerNames,
ILcdRequest aRequest)
Returns the corresponding WMS layers for the requested layer names.
|
ALcdWMSServiceMetaData |
getServiceMetaData(ILcdRequest aRequest)
Returns the WMS service metadata part of the WMS capabilities.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCapabilities
public List<ALcdWMSLayer> getLayers(List<String> aLayerNames, ILcdRequest aRequest) throws TLcdWMSServiceException
ILcdWMSCapabilitiesProvider
ALcdWMSLayer.getParentWMSLayer()
returns a valid result (may always be NULL
.
The parent layer may be needed to validate whether named styles are applicable for a layer.
They may have been inherited from the parent.
If there is no corresponding WMS layer the method should throw a TLcdWMSServiceException
with the exception code LAYER_NOT_DEFINED
.
Include the undefined layer name as the
This method allows to differentiate access to layers based on the user's authorization information.
The user's authorization information can be extracted from the request using the
getUserPrincipal
method.
Use the following exception codes for handling access control.
LAYER_NOT_AUTHORIZED
:
to indicate the user has requested a layer he does not have access to. AUTHENTICATION_REQUIRED
:
to indicate the user has request a layer for which authentication is required
but no authentication has been provided yet.getLayers
in interface ILcdWMSCapabilitiesProvider
aLayerNames
- the names of the layers.aRequest
- the request.TLcdWMSServiceException
- if there is an exception in retrieving the layers or if incorrect layers are requested.TLcdWMSServiceException.LAYER_NOT_DEFINED
,
TLcdWMSServiceException.LAYER_NOT_AUTHORIZED
,
TLcdWMSServiceException.AUTHENTICATION_REQUIRED
public ALcdWMSServiceMetaData getServiceMetaData(ILcdRequest aRequest) throws TLcdWMSServiceException
ILcdWMSCapabilitiesProvider
getServiceMetaData
in interface ILcdWMSCapabilitiesProvider
aRequest
- the request being handled.TLcdWMSServiceException
- if there is an issue to create the WMS service meta data.