001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/enterprise/AbstractOGCServlet.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.enterprise;
037    
038    import java.io.PrintWriter;
039    
040    import javax.servlet.ServletConfig;
041    import javax.servlet.ServletException;
042    import javax.servlet.http.HttpServlet;
043    import javax.servlet.http.HttpServletResponse;
044    
045    import org.deegree.framework.util.StringTools;
046    import org.deegree.framework.xml.Marshallable;
047    import org.deegree.ogcwebservices.OGCWebServiceException;
048    
049    /**
050     * Abstract servlet that serves as an OCC-compliant HTTP-frontend to any OGC-WebService (WFS, WMS,
051     * ...).
052     *
053     * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
054     * @author last edited by: $Author: mschneider $
055     *
056     * @version $Revision: 18195 $ $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
057     *
058     * @todo refactoring required, move to package servlet
059     */
060    public abstract class AbstractOGCServlet extends HttpServlet {
061    
062        /**
063         * Called by the servlet container to indicate that the servlet is being placed into service.
064         * Sets the debug level according to the debug parameter defined in the ServletEngine's
065         * environment.
066         * <p>
067         * <p>
068         *
069         * @param servletConfig
070         *            servlet configuration
071         * @throws ServletException
072         *             exception if something occurred that interferes with the servlet's normal
073         *             operation
074         */
075        @Override
076        public void init( ServletConfig servletConfig )
077                                throws ServletException {
078            super.init( servletConfig );
079        }
080    
081        /**
082         * handles fatal errors by creating a OGC exception XML and sending it back to the client
083         *
084         * @param msg
085         * @param ex
086         * @param response
087         *
088         * @deprecated
089         */
090        @Deprecated
091        protected void handleException( String msg, Exception ex, HttpServletResponse response ) {
092            String tmp = StringTools.stackTraceToString( ex );
093            getServletContext().log( msg + tmp );
094            OGCWebServiceException wex = new OGCWebServiceException( this.getClass().getName(), tmp );
095            try {
096                PrintWriter pw = response.getWriter();
097                pw.write( ( (Marshallable) wex ).exportAsXML() );
098                pw.close();
099            } catch ( Exception e ) {
100                getServletContext().log( e.toString() );
101            }
102        }
103    }