001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/ogcwebservices/wms/operation/WMSGetCapabilities.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    package org.deegree.ogcwebservices.wms.operation;
037    
038    import java.util.Map;
039    
040    import org.deegree.framework.log.ILogger;
041    import org.deegree.framework.log.LoggerFactory;
042    import org.deegree.ogcwebservices.InconsistentRequestException;
043    import org.deegree.ogcwebservices.MissingParameterValueException;
044    import org.deegree.ogcwebservices.OGCWebServiceException;
045    import org.deegree.ogcwebservices.getcapabilities.GetCapabilities;
046    
047    /**
048     * This interface desribes the access to the parameters common to a OGC
049     * GetCapabilities request. It inherits three accessor methods from the
050     * general OGC web service request interface.
051     *
052     * <p>--------------------------------------------------------</p>
053     *
054     * @author Katharina Lupp <a href="mailto:k.lupp@web.de">Katharina Lupp</a>
055     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
056     */
057    public class WMSGetCapabilities extends GetCapabilities {
058    
059        private static final long serialVersionUID = -7885976233890866824L;
060    
061        private static final ILogger LOG = LoggerFactory.getLogger( WMSGetCapabilities.class );
062    
063        /**
064         * creates an WMS GetCapabilities Request
065         *
066         * @param paramMap
067         *            the parameters of the request
068         * @return the GetCapabilities request
069         * @throws InconsistentRequestException
070         *             if the request is inconsistent
071         * @throws MissingParameterValueException
072         */
073        public static WMSGetCapabilities create( Map<String,String> paramMap )
074                                throws InconsistentRequestException, MissingParameterValueException {
075            LOG.logDebug( "Request parameters: " + paramMap );
076            String version = getParam( "VERSION", paramMap, null );
077    
078            if ( version == null ) {
079                version = getParam( "WMTVER", paramMap, null );
080            }
081    
082            String service = getRequiredParam( "SERVICE", paramMap );
083            String updateSequence = getParam( "UPDATESEQUENCE", paramMap, null );
084    
085            if ( !service.equals( "WMS" ) ) {
086                throw new InconsistentRequestException( "Parameter 'SERVICE' must be 'WMS'." );
087            }
088    
089            return new WMSGetCapabilities( getParam( "ID", paramMap, null ), version,
090                                           updateSequence, paramMap );
091        }
092    
093        /**
094         * Creates a new WMSGetCapabilities object.
095         *
096         * @param updateSequence
097         * @param version
098         * @param id
099         * @param vendorSpecific
100         */
101        WMSGetCapabilities( String version, String id, String updateSequence,
102                            Map<String,String> vendorSpecific ) {
103            super( version, id, updateSequence, null, null, null, vendorSpecific );
104        }
105    
106        /** returns the URI of a HTTP GET request.
107         *
108         */
109        @Override
110        public String getRequestParameter()
111                                throws OGCWebServiceException {
112            if ( getVersion().equals( "1.0.0" ) ) {
113                return "service=WMS&version=" + getVersion() + "&request=capabilities";
114            }
115            return "service=WMS&version=" + getVersion() + "&request=GetCapabilities";
116        }
117    
118        /**
119         * returns 'WMS' as service name
120         */
121        public String getServiceName() {
122            return "WMS";
123        }
124    }