001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/ogcwebservices/getcapabilities/OGCWebServiceCapabilities.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.getcapabilities;
045
046 import org.deegree.framework.log.ILogger;
047 import org.deegree.framework.log.LoggerFactory;
048 import org.deegree.framework.xml.Marshallable;
049 import org.w3c.dom.Document;
050
051 /**
052 * The purpose of the GetCapabilities operation is described in the Basic CapabilitiesService
053 * Elements section, above. In the particular case of a Web Map CapabilitiesService, the response of
054 * a GetCapabilities request is general information about the service itself and specific
055 * information about the available maps.
056 *
057 * @author <a href="mailto:k.lupp@web.de">Katharina Lupp </a>
058 * @author <a href="mailto:tfr@users.sourceforge.net">Torsten Friebe </a>
059 * @version 2002-03-01, $Revision: 9345 $, $Date: 2007-12-27 17:22:25 +0100 (Do, 27 Dez 2007) $
060 * @since 1.0
061 */
062
063 public abstract class OGCWebServiceCapabilities implements Marshallable {
064
065 protected static final ILogger LOG = LoggerFactory.getLogger( OGCWebServiceCapabilities.class );
066
067 private CapabilitiesService service = null;
068
069 private String updateSequence = null;
070
071 private String version = null;
072
073 /**
074 * constructor initializing the class with the OGCWebServiceCapabilities
075 */
076 public OGCWebServiceCapabilities( String version, String updateSequence, CapabilitiesService service ) {
077 setVersion( version );
078 setUpdateSequence( updateSequence );
079 setService( service );
080 }
081
082 /**
083 * returns the version of the service
084 */
085 public String getVersion() {
086 return version;
087 }
088
089 /**
090 * sets the version of the service
091 */
092 public void setVersion( String version ) {
093 this.version = version;
094 }
095
096 /**
097 * The UPDATESEQUENCE parameter is for maintaining cache consistency. Its value can be an
098 * integer, a timestamp in [ISO 8601:1988(E)] format , or any other number or string. The server
099 * may include an UpdateSequence value in its Capabilities XML. If present, this value should be
100 * increased when changes are made to the Capabilities (e.g., when new maps are added to the
101 * service). The server is the sole judge of lexical ordering sequence. The client may include
102 * this parameter in its GetCapabilities request.
103 */
104 public String getUpdateSequence() {
105 return updateSequence;
106 }
107
108 /**
109 * sets the update sequence
110 */
111 public void setUpdateSequence( String updateSequence ) {
112 this.updateSequence = updateSequence;
113 }
114
115 /**
116 * this returns a general describtion of the service described by the Capabilities XML document.
117 */
118 public CapabilitiesService getService() {
119 return service;
120 }
121
122 /**
123 * this sets a general describtion of the service described by the Capabilities XML document.
124 */
125 public void setService( CapabilitiesService service ) {
126 this.service = service;
127 }
128
129 /**
130 * Must be overridden by subclass. Replaces abstract method exportAsXML.
131 *
132 */
133 public Document export() {
134 return null;
135 }
136 }