001    // $HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/ogcwebservices/OGCWebServiceException.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 org.deegree.framework.xml.XMLTools;
039    import org.deegree.ogcbase.ExceptionCode;
040    import org.deegree.ogcbase.OGCException;
041    import org.w3c.dom.Document;
042    import org.w3c.dom.Element;
043    
044    /**
045     *
046     *
047     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
048     * @author last edited by: $Author: mschneider $
049     *
050     * @version 1.0. $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
051     *
052     * @since 2.0
053     */
054    public class OGCWebServiceException extends OGCException {
055    
056        /**
057         *
058         */
059        private static final long serialVersionUID = -2081577799241168634L;
060    
061        private String locator = "unknown";
062    
063        /**
064         * creates an OGCWebServiceException from a DOM object as defined in the OGC common
065         * implementation specification
066         *
067         * @param doc
068         * @return an {@link OGCWebServiceException} with the message, code and locator set to the xml
069         *         inside the document.
070         */
071        public static OGCWebServiceException create( Document doc ) {
072            Element root = doc.getDocumentElement();
073            return create( root );
074        }
075    
076        /**
077         * creates an OGCWebServiceException from a DOM Element object as defined in the OGC common
078         * implementation specification
079         *
080         * @param root
081         * @return an {@link OGCWebServiceException} with the message, code and locator set to the xml
082         *         inside the document.
083         *
084         */
085        public static OGCWebServiceException create( Element root ) {
086    
087            String code = XMLTools.getAttrValue( root, null, "code", null );
088            String lo = XMLTools.getAttrValue( root, null, "locator", null );
089    
090            String me = XMLTools.getStringValue( root );
091    
092            ExceptionCode ec = new ExceptionCode( code );
093            return new OGCWebServiceException( me, lo, ec );
094        }
095    
096        /**
097         * @param message
098         */
099        public OGCWebServiceException( String message ) {
100            super( message );
101        }
102    
103        /**
104         * @param message
105         * @param code
106         *            of the exception, often defined in the web service spec.
107         */
108        public OGCWebServiceException( String message, ExceptionCode code ) {
109            super( message, code );
110        }
111    
112        /**
113         * @param locator
114         * @param message
115         */
116        public OGCWebServiceException( String locator, String message ) {
117            super( message );
118            this.locator = locator;
119        }
120    
121        /**
122         * @param locator
123         * @param message
124         * @param code
125         */
126        public OGCWebServiceException( String locator, String message, ExceptionCode code ) {
127            super( message, code );
128            this.locator = locator;
129        }
130    
131        /**
132         * @return the class/service that has caused the exception
133         *
134         */
135        public String getLocator() {
136            return locator;
137        }
138    
139        /**
140         * @param locator
141         *            sets the class/service that has caused the exception
142         *
143         */
144        public void setLocator( String locator ) {
145            this.locator = locator;
146        }
147    }