001: //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/trunk/src/org/deegree/ogcwebservices/OGCWebServiceRequest.java $
002: /*---------------- FILE HEADER ------------------------------------------
003:
004: This file is part of deegree.
005: Copyright (C) 2001-2008 by:
006: EXSE, Department of Geography, University of Bonn
007: http://www.giub.uni-bonn.de/deegree/
008: lat/lon GmbH
009: http://www.lat-lon.de
010:
011: This library is free software; you can redistribute it and/or
012: modify it under the terms of the GNU Lesser General Public
013: License as published by the Free Software Foundation; either
014: version 2.1 of the License, or (at your option) any later version.
015:
016: This library is distributed in the hope that it will be useful,
017: but WITHOUT ANY WARRANTY; without even the implied warranty of
018: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: Lesser General Public License for more details.
020:
021: You should have received a copy of the GNU Lesser General Public
022: License along with this library; if not, write to the Free Software
023: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024:
025: Contact:
026:
027: Andreas Poth
028: lat/lon GmbH
029: Aennchenstr. 19
030: 53115 Bonn
031: Germany
032: E-Mail: poth@lat-lon.de
033:
034: Prof. Dr. Klaus Greve
035: Department of Geography
036: University of Bonn
037: Meckenheimer Allee 166
038: 53115 Bonn
039: Germany
040: E-Mail: greve@giub.uni-bonn.de
041:
042:
043: ---------------------------------------------------------------------------*/
044: package org.deegree.ogcwebservices;
045:
046: import java.util.Map;
047:
048: /**
049: * This is the base interface for all request on OGC Web Services (OWS). Each class that capsulates
050: * a request against an OWS has to implements this interface.
051: *
052: * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
053: * @author last edited by: $Author: apoth $
054: *
055: * @version 1.0, $Revision: 9345 $, $Date: 2007-12-27 08:22:25 -0800 (Thu, 27 Dec 2007) $
056: *
057: * @since 1.0
058: *
059: */
060: public interface OGCWebServiceRequest {
061:
062: /**
063: * Finally, the requests allow for optional vendor-specific parameters (VSPs) that will enhance
064: * the results of a request. Typically, these are used for private testing of non-standard
065: * functionality prior to possible standardization. A generic client is not required or expected
066: * to make use of these VSPs.
067: *
068: * @return the vendor specificparameters
069: */
070: Map getVendorSpecificParameters();
071:
072: /**
073: * Finally, the requests allow for optional vendor-specific parameters (VSPs) that will enhance
074: * the results of a request. Typically, these are used for private testing of non-standard
075: * functionality prior to possible standardization. A generic client is not required or expected
076: * to make use of these VSPs.
077: *
078: * @param name
079: * the "key" of a vsp
080: * @return the value requested by the key
081: */
082: String getVendorSpecificParameter(String name);
083:
084: /**
085: * @return the ID of a request
086: */
087: String getId();
088:
089: /**
090: * @return the requested service version
091: */
092: String getVersion();
093:
094: /**
095: * @return the name of the service that is targeted by the request
096: */
097: String getServiceName();
098:
099: /**
100: * @return the URI of a HTTP GET request. If the request doesn't support HTTP GET a
101: * <tt>WebServiceException</tt> will be thrown
102: * @throws OGCWebServiceException
103: * @deprecated should be replaced by a factory class TODO
104: */
105: String getRequestParameter() throws OGCWebServiceException;
106: }
|