001 //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/ogcwebservices/OGCWebServiceRequest.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;
037
038 import java.util.Map;
039
040 /**
041 * This is the base interface for all request on OGC Web Services (OWS). Each class that capsulates
042 * a request against an OWS has to implements this interface.
043 *
044 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
045 * @author last edited by: $Author: apoth $
046 *
047 * @version 1.0, $Revision: 26213 $, $Date: 2010-08-27 14:01:04 +0200 (Fr, 27 Aug 2010) $
048 *
049 * @since 1.0
050 *
051 */
052 public interface OGCWebServiceRequest {
053
054 /**
055 * Finally, the requests allow for optional vendor-specific parameters (VSPs) that will enhance
056 * the results of a request. Typically, these are used for private testing of non-standard
057 * functionality prior to possible standardization. A generic client is not required or expected
058 * to make use of these VSPs.
059 *
060 * @return the vendor specific parameters
061 */
062 @SuppressWarnings("unchecked")
063 Map getVendorSpecificParameters();
064
065 /**
066 * Finally, the requests allow for optional vendor-specific parameters (VSPs) that will enhance
067 * the results of a request. Typically, these are used for private testing of non-standard
068 * functionality prior to possible standardization. A generic client is not required or expected
069 * to make use of these VSPs.
070 *
071 * @param name
072 * the "key" of a vsp
073 * @return the value requested by the key
074 */
075 String getVendorSpecificParameter( String name );
076
077 /**
078 * @return the ID of a request
079 */
080 String getId();
081
082 /**
083 * @return the requested service version
084 */
085 String getVersion();
086
087 /**
088 * @return the name of the service that is targeted by the request
089 */
090 String getServiceName();
091
092 /**
093 * @return the URI of a HTTP GET request. If the request doesn't support HTTP GET a
094 * <tt>WebServiceException</tt> will be thrown
095 * @throws OGCWebServiceException
096 * @deprecated should be replaced by a factory class TODO
097 */
098 String getRequestParameter()
099 throws OGCWebServiceException;
100 }