001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/ogcwebservices/csw/manager/Transaction.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.csw.manager;
045
046 import java.util.List;
047 import java.util.Map;
048
049 import org.deegree.framework.log.ILogger;
050 import org.deegree.framework.log.LoggerFactory;
051 import org.deegree.framework.xml.NamespaceContext;
052 import org.deegree.framework.xml.XMLException;
053 import org.deegree.framework.xml.XMLParsingException;
054 import org.deegree.framework.xml.XMLTools;
055 import org.deegree.i18n.Messages;
056 import org.deegree.ogcbase.CommonNamespaces;
057 import org.deegree.ogcbase.ExceptionCode;
058 import org.deegree.ogcwebservices.AbstractOGCWebServiceRequest;
059 import org.deegree.ogcwebservices.InvalidParameterValueException;
060 import org.deegree.ogcwebservices.OGCWebServiceException;
061 import org.deegree.ogcwebservices.csw.CSWPropertiesAccess;
062 import org.deegree.ogcwebservices.csw.discovery.GetRecordByIdDocument;
063 import org.w3c.dom.Element;
064
065 /**
066 * A Transaction defines an atomic unit of work and is a container for one or more insert, update
067 * and/or delete actions.
068 *
069 *
070 * @version $Revision: 9345 $
071 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
072 * @author last edited by: $Author: apoth $
073 *
074 * @version $Revision: 9345 $, $Date: 2007-12-27 17:22:25 +0100 (Do, 27 Dez 2007) $
075 *
076 */
077 public class Transaction extends AbstractOGCWebServiceRequest {
078
079 private static final long serialVersionUID = -4393029325052150570L;
080
081 protected static final ILogger LOG = LoggerFactory.getLogger( Transaction.class );
082
083 private static NamespaceContext nsContext = CommonNamespaces.getNamespaceContext();
084
085 private List<Operation> operations = null;
086
087 private boolean verboseResponse = false;
088
089 /**
090 * creates a Transaction object from its XML representation defined in OGC CS-W 2.0.0
091 * specification
092 * @param id uniquely identifies the given request
093 *
094 * @param root the root of the xml-encoded transaction request
095 * @return a Transaction with the values taken form the XML-Document.
096 * @throws OGCWebServiceException if the Transaction could not be created
097 */
098 public static final Transaction create( String id, Element root )
099 throws OGCWebServiceException {
100
101 String version = null;
102 try {
103 // first try to read verdsion attribute which is optional for CSW 2.0.0 and 2.0.1
104 version = XMLTools.getNodeAsString( root, "./@version", nsContext, null );
105 } catch ( XMLParsingException e ) {
106
107 }
108 if ( version == null ) {
109 // if no version attribute has been set try mapping namespace URI to a version;
110 // this is not well defined for 2.0.0 and 2.0.1 which uses the same namespace.
111 // in this case 2.0.0 will be returned!
112 version = CSWPropertiesAccess.getString( root.getNamespaceURI() );
113 }
114
115
116 // read class for version depenging parsing of Transaction request from properties
117 String className = CSWPropertiesAccess.getString( "Transaction" + version );
118 Class clzz = null;
119 try {
120 clzz = Class.forName( className );
121 } catch ( ClassNotFoundException e ) {
122 LOG.logError( e.getMessage(), e );
123 throw new InvalidParameterValueException( e.getMessage(), e );
124 }
125 TransactionDocument document = null;
126 try {
127 document = (TransactionDocument) clzz.newInstance();
128 } catch ( InstantiationException e ) {
129 LOG.logError( e.getMessage(), e );
130 throw new InvalidParameterValueException( e.getMessage(), e );
131 } catch ( IllegalAccessException e ) {
132 LOG.logError( e.getMessage(), e );
133 throw new InvalidParameterValueException( e.getMessage(), e );
134 }
135
136 document.setRootElement( root );
137
138 try {
139 return document.parse( id );
140 } catch ( XMLException e ) {
141 String msg = Messages.getMessage( "CSW_ERROR_WHILE_PARSING_TRANSACTION", e.getMessage() );
142 LOG.logError( msg, e );
143 throw new OGCWebServiceException( msg, ExceptionCode.INVALID_FORMAT );
144 } catch ( XMLParsingException e ) {
145 String msg = Messages.getMessage( "CSW_ERROR_WHILE_PARSING_TRANSACTION", e.getMessage() );
146 LOG.logError( msg, e );
147 throw new OGCWebServiceException( msg, ExceptionCode.INVALID_FORMAT );
148 }
149 }
150
151 /**
152 *
153 * @param version
154 * @param id
155 * @param vendorSpecificParameter
156 * @param operations
157 * @param verboseResponse
158 */
159 public Transaction( String version, String id, Map<String, String> vendorSpecificParameter,
160 List<Operation> operations, boolean verboseResponse ) {
161 super( version, id, vendorSpecificParameter );
162 this.operations = operations;
163 this.verboseResponse = verboseResponse;
164 }
165
166 /**
167 * @return the name of the service; always CSW
168 */
169 public String getServiceName() {
170 return "CSW";
171 }
172
173 /**
174 * The verboseResponseattribute is a boolean that may be used by a client to indicate to a
175 * server the amount of detail to generate in the rsponse. A value of FALSE means that a CSW
176 * should generate a terse or brief transaction response. A value of TRUE, or the absence of the
177 * attribute, means that the normal detailed transaction response should be generated.
178 *
179 * @return true if the response should be verbose
180 */
181 public boolean verboseResponse() {
182 return verboseResponse;
183 }
184
185 /**
186 * returns all operations being part of a transaction
187 *
188 * @return all operations being part of a transaction
189 */
190 public List<Operation> getOperations() {
191 return operations;
192 }
193 }